Gesprächsliste abrufen

Rufen Sie Informationen zu allen Gesprächen eines Agenten innerhalb der angegebenen Filterkriterien ab, darunter conversation_id, user_id, Zeitpunkt des letzten Chats, Gesprächsthema, Gesprächstyp, Gesamtanzahl der Nachrichten und verbrauchte Credits.

Anfragemethode

GET

Anfrage-URL

https://api-${endpoint}.gptbots.ai/v1/bot/conversation/page

Authentifizierung der Anfrage

Siehe API-Übersicht für Authentifizierungsanweisungen.

Anfrage

Beispielanfrage

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/conversation/page?page=1&conversation_type=ALL&start_time=1691942400000&end_time=1699868066999&page_size=50&user_id=1234567890' \ -H 'Authorization: Bearer ${API Key}' \

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/conversation/page?page=1&conversation_type=ALL&start_time=1691942400000&end_time=1699868066999&page_size=50&user_id=1234567890'  \
-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-Schlüssel erhalten Sie auf der API-Key-Seite.

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
conversation_type	string	Ja	Quellentyp der Gesprächs-ID. Kann auf folgende Werte gesetzt werden: `ALL`, `API`, `EMBED` und weitere Quelltypen.
user_id	string	Nein	Benutzer-ID. Wenn nicht angegeben, besteht keine Einschränkung.
start_time	long	Ja	Startzeit des letzten Gesprächs, im Zeitstempel-Format.
end_time	long	Ja	Endzeit des letzten Gesprächs, im Zeitstempel-Format.
page	int	Ja	Seitenzahl, gibt an, welche Seite abgerufen werden soll, beginnend mit 1.
page_size	int	Ja	Anzahl der Datensätze pro Seite, Bereich 10–100.

Hinweis: Mögliche Werte für conversation_type finden Sie in der Werteliste für das Quellfeld der Gesprächs-ID (conversation_id) in der Tabelle unter Benutzerübersicht.

Antwort

Beispielantwort

{ "list": [ { "conversation_id": "AaACmo05Yrqb6bOSTbsg", "user_id": "3", "anonymous_id": "202607000198150", "recent_chat_time": 1694572952383, "subject": "2+3=?", "conversation_type": "API", "source_page": null, "message_count": 2, "cost_credit": 0.01, "bot_id": "64b902a84f1ff25d1c60c10b", "quality_score": null }, { "conversation_id": "64ec1508c9c1ed5605e6ff28", "user_id": "33", "anonymous_id": "202607000198151", "recent_chat_time": 1693194862160, "subject": "Hello!", "conversation_type": "LIVECHAT", "source_page": "https://www.livechat.com/", "message_count": 20, "cost_credit": 0.59, "bot_id": "64b902a84f1ff25d1c60c10b", "quality_score": null } ], "total": 2 }

                      
                      {
  "list": [
    {
      "conversation_id": "AaACmo05Yrqb6bOSTbsg",
      "user_id": "3",
      "anonymous_id": "202607000198150",
      "recent_chat_time": 1694572952383,
      "subject": "2+3=?",
      "conversation_type": "API",
      "source_page": null,
      "message_count": 2,
      "cost_credit": 0.01,
      "bot_id": "64b902a84f1ff25d1c60c10b",
      "quality_score": null
    },
    {
      "conversation_id": "64ec1508c9c1ed5605e6ff28",
      "user_id": "33",
      "anonymous_id": "202607000198151",
      "recent_chat_time": 1693194862160,
      "subject": "Hello!",
      "conversation_type": "LIVECHAT",
      "source_page": "https://www.livechat.com/",
      "message_count": 20,
      "cost_credit": 0.59,
      "bot_id": "64b902a84f1ff25d1c60c10b",
      "quality_score": null
    }
  ],
  "total": 2
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
list	JSON-Array	Liste der Gespräche.
conversation_id	string	Gesprächs-ID.
user_id	string	Benutzer-ID. Kann bei Gesprächen aus Drittanbieter-Kanälen wie LINE oder Telegram null sein; verwenden Sie in diesem Fall `anonymous_id`, um den Benutzer zu identifizieren.
anonymous_id	string	Anonyme ID, die von GPTBots automatisch anhand der Quellplattform des Benutzers generiert wird.
recent_chat_time	long	Zeitpunkt des letzten Gesprächs.
subject	string	Gesprächsthema.
conversation_type	string	Gesprächstyp.
source_page	string	Quellseite der ersten Nachricht des Benutzers. Derzeit unterstützt nur der LIVECHAT-Kanal dieses Feld; der Wert ist null, wenn `conversation_type` nicht `LIVECHAT` ist.
message_count	int	Gesamtanzahl der Nachrichten im Gespräch.
cost_credit	float	Anzahl der im Gespräch verbrauchten Credits.
bot_id	string	Agenten-ID.
quality_score	float	Qualitätsbewertung des Gesprächs. null, wenn das Gespräch noch nicht bewertet wurde.
total	int	Gesamtzahl der Gespräche, die den Filterkriterien entsprechen (nicht die Anzahl der auf der aktuellen Seite zurückgegebenen Einträge).

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode.
message	string	Fehlerdetails.

Fehlercodes

Code	Nachricht
40000	Ungültiger Parameter
20059	Agent gelöscht
40127	Entwicklerauthentifizierung fehlgeschlagen