Modo webhook

Los modos actuales de respuesta de mensajes del agente GPTBots admiten: blocking, streaming y webhook. Cuando los desarrolladores utilizan el modo webhook para recibir mensajes de respuesta, el contenido del mensaje proporcionado por el agente o por el servicio de atención al cliente humano se enviará a la dirección de webhook especificada.

Método de solicitud

POST

Endpoint

Configurar la dirección de recepción de mensajes en Agent - Integration - API - webhook.

Autenticación

Para más información, consultar la descripción del método de autenticación en Visión general de la API (API Overview).

Solicitud

Ejemplo de solicitud

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"
}'

Este bloque de código en una ventana flotante

Encabezados de solicitud

Campo	Tipo	Descripción
Authorization	Bearer o Basic ${token}	Para autenticarse, se utiliza `Authorization: Bearer` o `Basic ${token}`. El token se obtiene en la página API Key.
Content-Type	application/json	Tipo de contenido. El valor es `application/json`.

Parámetros de solicitud

Campo	Tipo	Descripción
message_id	string	ID único del mensaje.
message_type	string	Tipo de mensaje. Valores: ANSWER, QUESTION.
text	string	Contenido de texto proporcionado por el agente.
flow_output	JSON Array	Contenido de la respuesta del agente en modo Flow (Flow mode).
flow_output[].content	string	Respuesta de texto del componente del agente en modo Flow.
flow_output[].branch	string	Rama del agente en modo Flow.
flow_output[].from_component_name	string	Nombre del componente ascendente del agente en modo Flow.
create_time	long	Marca de tiempo de creación del mensaje de respuesta.
conversation_id	string	ID de la conversación.

Respuesta

Ejemplo de respuesta

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

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

Este bloque de código en una ventana flotante