Mode Webhook

Les modes de réponse aux messages de l'Agent GPTBots prennent actuellement en charge : bloquant, streaming et webhook. Lorsque vous utilisez le mode webhook pour recevoir les messages de réponse, le contenu du message fourni par l'Agent ou le service client humain sera soumis à l'adresse webhook spécifiée.

Méthode de requête

POST

Endpoint

Veuillez configurer votre adresse de réception des messages sur la page Agent - Intégration - API - webhook.

Authentification

Pour plus de détails, consultez la description de la méthode d'authentification dans l'Aperçu de l'API.

Requête

Exemple de requête

curl -X POST 'YOUR_API_URL' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "message_id": "65a4ccfC7ce58e728d5897e0", "message_type": "ANSWER", "text": "Hi, is there anything I can help you?", "flow_output": [ { "content": "你好", "branch": "1", "from_component_name": "User Input" } ], "create_time": 1679587005, "conversation_id": "657303a8a764d47094874bbe" }'

                      
                      curl -X POST 'YOUR_API_URL' \ 
-H 'Authorization: Bearer ${API Key}' \	
-H 'Content-Type: application/json' \ 
-d '{
  "message_id": "65a4ccfC7ce58e728d5897e0",
  "message_type": "ANSWER",
  "text": "Hi, is there anything I can help you?",
  "flow_output": [
    {
      "content": "你好",
      "branch": "1",
      "from_component_name": "User Input"
    }
  ],
  "create_time": 1679587005,
  "conversation_id": "657303a8a764d47094874bbe"
}'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Bearer ou Basic ${token}	Utilisez Authorization: Bearer OU Basic ${token} pour l'authentification. Obtenez le token depuis la page Clé API.
Content-Type	application/json	Type de données, la valeur est application/json.

Paramètres de la requête

Champ	Type	Description
message_id	string	ID unique du message.
message_type	string	Type de message, valeurs : ANSWER, QUESTION.
text	string	Contenu textuel fourni par l'Agent.
flow_output	Tableau JSON	Contenu de la réponse de l'Agent en mode Flow.
content	string	Réponse textuelle du composant Agent en mode Flow.
branch	string	Branche de l'Agent en mode Flow.
from_component_name	string	Nom du composant amont de l'Agent en mode Flow.
create_time	long	Horodatage de création du message de réponse.
conversation_id	string	ID de la conversation.

Réponse

Exemple de réponse

{ "code": 200, "msg": "succès" }

                      
                      {
  "code": 200,
  "msg": "succès"
}

Ce bloc de code dans la fenêtre flottante