Webhook-Modus

Die aktuellen Antwortmodi für Nachrichten von GPTBots-Agenten unterstützen die Modi: blocking, streaming und webhook. Wenn Entwickler:innen den Webhook-Modus nutzen, um Antwortnachrichten zu empfangen, wird der vom Agenten oder vom menschlichen Kundenservice bereitgestellte Nachrichteninhalt an die angegebene Webhook-Adresse gesendet.

Anfragemethode

POST

Endpoint

Bitte konfigurieren Sie die Empfangsadresse für Nachrichten auf der Seite Agent – Integration – API – Webhook.

Authentifizierung

Weitere Details finden Sie in der Beschreibung zur Authentifizierung in der API-Übersicht.

Anfrage

Beispielanfrage

curl -X POST 'IHRE_API_URL' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "message_id": "65a4ccfC7ce58e728d5897e0", "message_type": "ANSWER", "text": "Hallo, kann ich Ihnen irgendwie behilflich sein?", "flow_output": [ { "content": "你好", "branch": "1", "from_component_name": "User Input" } ], "create_time": 1679587005, "conversation_id": "657303a8a764d47094874bbe" }'

                      
                      curl -X POST 'IHRE_API_URL' \ 
-H 'Authorization: Bearer ${API Key}' \	
-H 'Content-Type: application/json' \ 
-d '{
  "message_id": "65a4ccfC7ce58e728d5897e0",
  "message_type": "ANSWER",
  "text": "Hallo, kann ich Ihnen irgendwie behilflich sein?",
  "flow_output": [
    {
      "content": "你好",
      "branch": "1",
      "from_component_name": "User Input"
    }
  ],
  "create_time": 1679587005,
  "conversation_id": "657303a8a764d47094874bbe"
}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer oder Basic ${token}	Verwenden Sie zur Authentifizierung entweder Authorization: Bearer oder Basic ${token}. Den Token erhalten Sie auf der API-Key-Seite.
Content-Type	application/json	Datentyp, Wert ist application/json.

Anfrageparameter

Feld	Typ	Beschreibung
message_id	string	Eindeutige ID der Nachricht.
message_type	string	Typ der Nachricht; mögliche Werte: ANSWER, QUESTION.
text	string	Vom Agenten bereitgestellter Textinhalt.
flow_output	JSON Array	Inhalt der Agenten-Antwort im Flow-Modus.
content	string	Textantwort der Agenten-Komponente im Flow-Modus.
branch	string	Zweig des Agenten im Flow-Modus.
from_component_name	string	Name der vorgelagerten Komponente des Agenten im Flow-Modus.
create_time	long	Zeitstempel der Erstellung der Antwortnachricht (Unix-Zeitformat).
conversation_id	string	ID der Konversation.

Antwort

Beispielantwort

{ "code": 200, "msg": "success" }

                      
                      {
  "code": 200,
  "msg": "success"
}

Dieser Codeblock im schwebenden Fenster