Gesprächsdetails abrufen

Rufen Sie alle Nachrichten innerhalb eines Gesprächs mit dem Parameter conversation_id ab. Die Antwort enthält message_id, Benutzeranfragen, Nachrichtentypen, Nachrichteninhalte, Zeitstempel und weitere Details.

Anfragemethode

GET

Endpoint

https://api-${endpoint}.gptbots.ai/v2/messages

Authentifizierung

Siehe API-Übersicht für Authentifizierungsanweisungen.

Anfrage

Beispielanfrage

curl -X GET 'https://api-${endpoint}.gptbots.ai/v2/messages?conversation_id=xxxxxx&page=1&page_size=100' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v2/messages?conversation_id=xxxxxx&page=1&page_size=100' \
-H 'Authorization: Bearer ${API Key}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${API Key}	Verwenden Sie `Authorization: Bearer ${API Key}` zur Authentifizierung. Den API-Key erhalten Sie auf der API-Key-Seite.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
conversation_id	string	Ja	Gesprächskennung.
page	int	Ja	Seitenzahl der Abfrage.
page_size	int	Ja	Anzahl der Einträge pro Seite, maximal 100.

Antwort

Beispielantwort

{ "total": 2, "conversation_content": [ { "message_id": "645dd86906931c4a9e0ffb1f", "parent_message_id": "545dd86906931c4a9e0ffb1f", "create_time": 1683871849906, "feedback": "POSITIVE", "source_page": "https://your-site.com/pricing", "sentiment_label": "neutral", "role": "user", "content": [ { "branch_content": [ { "type": "text", "text": "Ich habe 2 Bilddateien hochgeladen, bitte OCR durchführen und 2 JSON-Datensätze zurückgeben." }, { "type": "image", "image": [ { "url": "https://gptbots.ai/example.png", "format": "jpeg", "name": "TAXI1", "size": 1024 }, { "url": "https://gptbots.ai/example.png", "format": "png", "name": "TAXI2", "size": 1024 } ] }, { "type": "audio", "audio": [ { "url": "https://gptbots.ai/example.mp3", "format": "mp3", "name": "example1 audio", "size": 1024 } ] }, { "type": "document", "document": [ { "url": "https://gptbots.ai/example.pdf", "format": "pdf", "name": "example pdf", "size": 1024 } ] } ] } ] }, { "message_id": "745dd86906931c4a9e0ffb1f", "parent_message_id": "645dd86906931c4a9e0ffb1f", "create_time": 1683871849906, "feedback": "POSITIVE", "source_page": "https://your-site.com/pricing", "sentiment_label": "positive", "role": "assistant", "content": [ { "from_component_branch": "1", "branch_content": [ { "type": "text", "text": "Hallo, kann ich Ihnen irgendwie weiterhelfen?" }, { "type": "audio", "audio": [ { "url": "http://gptbots.ai/example.mp3", "transcript": "Transkribierter Inhalt der Audiodatei" } ] } ] }, { "from_component_branch": "2", "branch_content": [ { "type": "document", "document": [ { "url": "https://gptbots.ai/example.pdf", "format": "pdf", "name": "example pdf" } ] }, { "type": "image", "image": [ { "url": "https://gptbots.ai/example.png", "format": "png", "name": "TAXI2" } ] } ] } ] } ], "audio_record_url": "https://gptbots.ai/record/full-call.mp3", "user_sender": { "channel_type": "Channel::Whatsapp", "user_id": "+66812345678", "profile": { "name": "John Doe" }, "additional_attributes": {}, "provider": "whatsapp_cloud", "phone_number": "+66900000000" } }

                      
                      {
  "total": 2,
  "conversation_content": [
    {
      "message_id": "645dd86906931c4a9e0ffb1f",
      "parent_message_id": "545dd86906931c4a9e0ffb1f",
      "create_time": 1683871849906,
      "feedback": "POSITIVE",
      "source_page": "https://your-site.com/pricing",
      "sentiment_label": "neutral",
      "role": "user",
      "content": [
        {
          "branch_content": [
            {
              "type": "text",
              "text": "Ich habe 2 Bilddateien hochgeladen, bitte OCR durchführen und 2 JSON-Datensätze zurückgeben."
            },
            {
              "type": "image",
              "image": [
                {
                  "url": "https://gptbots.ai/example.png",
                  "format": "jpeg",
                  "name": "TAXI1",
                  "size": 1024
                },
                {
                  "url": "https://gptbots.ai/example.png",
                  "format": "png",
                  "name": "TAXI2",
                  "size": 1024
                }
              ]
            },
            {
              "type": "audio",
              "audio": [
                {
                  "url": "https://gptbots.ai/example.mp3",
                  "format": "mp3",
                  "name": "example1 audio",
                  "size": 1024
                }
              ]
            },
            {
              "type": "document",
              "document": [
                {
                  "url": "https://gptbots.ai/example.pdf",
                  "format": "pdf",
                  "name": "example pdf",
                  "size": 1024
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "message_id": "745dd86906931c4a9e0ffb1f",
      "parent_message_id": "645dd86906931c4a9e0ffb1f",
      "create_time": 1683871849906,
      "feedback": "POSITIVE",
      "source_page": "https://your-site.com/pricing",
      "sentiment_label": "positive",
      "role": "assistant",
      "content": [
        {
          "from_component_branch": "1",
          "branch_content": [
            {
              "type": "text",
              "text": "Hallo, kann ich Ihnen irgendwie weiterhelfen?"
            },
            {
              "type": "audio",
              "audio": [
                {
                  "url": "http://gptbots.ai/example.mp3",
                  "transcript": "Transkribierter Inhalt der Audiodatei"
                }
              ]
            }
          ]
        },
        {
          "from_component_branch": "2",
          "branch_content": [
            {
              "type": "document",
              "document": [
                {
                  "url": "https://gptbots.ai/example.pdf",
                  "format": "pdf",
                  "name": "example pdf"
                }
              ]
            },
            {
              "type": "image",
              "image": [
                {
                  "url": "https://gptbots.ai/example.png",
                  "format": "png",
                  "name": "TAXI2"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "audio_record_url": "https://gptbots.ai/record/full-call.mp3",
  "user_sender": {
    "channel_type": "Channel::Whatsapp",
    "user_id": "+66812345678",
    "profile": { "name": "John Doe" },
    "additional_attributes": {},
    "provider": "whatsapp_cloud",
    "phone_number": "+66900000000"
  }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
total	string	Gesamtanzahl der Nachrichten im Gespräch.
conversation_content	JSON Array	Details zu den Nachrichten.
message_id	string	Eindeutige Kennung der Nachricht.
parent_message_id	string	Eindeutige Kennung der übergeordneten Nachricht.
create_time	long	Zeitstempel der Erstellung der Nachricht.
feedback	string	Benutzer-Feedback zur Nachricht, Werte: `POSITIVE`, `NEGATIVE`. Kein Feedback = leer.
source_page	string	Quellseite dieser Nachricht, d. h. die URL der Webseite, auf der sich der Benutzer beim Erstellen der Nachricht befand. Derzeit unterstützt nur der Livechat-Kanal dieses Feld; der Wert ist leer, wenn die Konversationsquelle nicht Livechat ist.
sentiment_label	string	Stimmungslabel der Nachricht, abgestimmt auf das Stimmungsfeld in den Konversationsprotokollen.
role	string	Nachrichtenrolle: `user` oder `assistant`.
content	JSON Array	Nachrichteninhalt.
from_component_branch	string	Komponenten-Branch-ID der Nachrichtenquelle. Bei Benutzer-Nachrichten und regulären Agenten leer.
branch_content	JSON Array	Branch-Inhalt der Nachricht.
type	string	Nachrichtentyp: `text`, `image`, `audio`, `document`, `video`, `file`.
text	string	Inhalt der Textnachricht.
image	JSON Array	Inhalt der Bildnachricht.
audio	JSON Array	Inhalt der Audionachricht.
document	JSON Array	Inhalt der Dokumentennachricht.
video	JSON Array	Inhalt der Videonachricht.
file	JSON Array	Inhalt der Dateinachricht.
audio_record_url	string	URL der Aufzeichnungsdatei des gesamten Sprachanrufs, nur bei Sprach-Agenten (Audio) vorhanden; ohne Aufzeichnung wird dieses Feld nicht zurückgegeben.
user_sender	JSON Object	Kanalinformationen des Benutzers. Bei Anbindung über Drittkanäle (derzeit LiveDesk) wird das Feld beim Gesprächseingang gespeichert; es stammt aus den Absender-Kanalinformationen des Kanal-Webhooks (unterstützt Kanäle wie WhatsApp / LINE) und hat dieselbe Quelle wie die Flussvariable `ld_user_sender`. Wenn nicht erfasst, wird dieses Feld nicht zurückgegeben; häufige Felder siehe folgende Tabelle.

Häufige Felder von user_sender

Dieses Objekt enthält die vom Quellkanal durchgereichten Kanalinformationen des Benutzers. Die Felder variieren je nach Kanal; nachfolgend die häufigsten Felder, maßgeblich ist die tatsächliche Rückgabe des Kanals.

Feld	Typ	Beschreibung
channel_type	string	Kanaltyp, z. B. Channel::Whatsapp, Channel::Line, Channel::Webwidget usw.
user_id	string	Benutzerkennung auf Kanalseite: bei WhatsApp die Telefonnummer/wa_id, bei LINE die userId, bei anderen Kanälen der identifier.
profile	JSON Object	Benutzerprofil (z. B. name).
additional_attributes	JSON Object	Zusätzliche Kanalattribute.
provider	string	Provider des Kanals.
phone_number	string	Auf Kanalseite konfigurierte Telefonnummer.

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode.
message	string	Fehlerdetails.

Fehlercodes

Code	Nachricht
40000	Ungültige Parameter
40005	Paginierungsparameter überschreitet tatsächliche Anzahl
40127	Entwickler-Authentifizierung fehlgeschlagen
40356	Gespräch existiert nicht
20059	Agent wurde gelöscht