Modo webhook

Actualmente, el agente de GPTBots admite tres modos de respuesta: blocking, streaming y webhook. Cuando se utiliza el modo webhook para recibir mensajes de respuesta, tanto las respuestas de IA como las respuestas humanas se enviarán a la URL de webhook especificada.

La API de envío de mensajes envía los mensajes de respuesta al webhook

Método de solicitud

POST

Endpoint

Configure su dirección de recepción de mensajes en la página Agent > Integration > API > webhook.

Autenticación

Se admiten dos métodos de autenticación: Basic auth y Bearer auth. Los desarrolladores pueden elegir el método adecuado y configurarlo en la página Agent > Integration > API > webhook.

• Al integrar una dirección de webhook, si el desarrollador completa únicamente el webhook username, GPTBots utiliza de forma predeterminada la autenticación Bearer al enviar solicitudes a la URL del webhook del desarrollador, siendo el valor el webhook username.
• Al integrar una dirección de webhook, si el desarrollador completa tanto el webhook username como el webhook secret, GPTBots utiliza la autenticación Basic, siendo el nombre de usuario el webhook username y la contraseña el webhook secret.

Ejemplo de solicitud

                      
                      curl -X POST 'YOUR_API_URL' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "create_time": 1679587005,
    "user_id": "65a4ccfc7ce58e728d5897e0",
    "anonymous_id": "device_abcdef123456",
    "conversation_id": "657303a8a764d47094874bbe",
    "message_id": "65a4ccfC7ce58e728d5897e0",
    "output": [
        {
            "from_component_branch": "1",
            "from_component_name": "Component Name",
            "content": {
                "text": "Hi, is there anything I can help you?",
                "audio": [
                    {
                        "audio": "http://gptbots.ai/example.mp3",
                        "transcript": "The transcribed content of the audio"
                    }
                ]
            }
        }
    ],
    "usage": {
        "tokens": {
           "total_tokens": 29,
            "prompt_tokens": 19,
            "prompt_tokens_details": 
                {  
                    "audio_tokens": 0,
                    "text_tokens": 0
                },
            "completion_tokens": 10,
            "completion_tokens_details": 
                {
                    "reasoning_tokens": 0,
                    "audio_tokens": 0,
                    "text_tokens": 0
                }
        },
        "credits": {
            "total_credits": 0.0,
            "text_input_credits": 0.0,
            "text_output_credits": 0.0,
            "audio_input_credits": 0.0,
            "audio_output_credits": 0.0
        }
    }
}'

                    

Cuerpo de la solicitud

Especificación de la respuesta

Después de que el servicio webhook del desarrollador reciba correctamente el mensaje, debe devolver el código de estado HTTP 200 y un indicador de éxito en formato JSON en el cuerpo de la respuesta.

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

                    

Detección del estado del servicio Webhook de GPTBots

GPTBots proporciona una interfaz de comprobación de estado (health check) para detectar su propio servicio webhook. Los desarrolladores pueden llamarla para comprobar si el servicio webhook de GPTBots está disponible. Si devuelve el código de estado HTTP 200 y el cuerpo de la respuesta es el indicador de servicio normal en texto plano (por ejemplo, service is normal), el servicio webhook de GPTBots está disponible. Esta interfaz no requiere autenticación y devuelve texto plano.

Método de solicitud

GET

Endpoint

https://api.gptbots.ai/v1/webhook/service/health

Ejemplo de solicitud

                      
                      curl -X GET 'https://api.gptbots.ai/v1/webhook/service/health'

                    

Respuesta

Cuando el servicio de GPTBots está disponible, devuelve el código de estado HTTP 200 y un indicador de servicio normal en texto plano.

                      
                      service is normal

                    

Recomendación para evaluar la disponibilidad

El llamador solo necesita el código de estado HTTP como criterio:

Establezca un tiempo de espera de solicitud razonable (por ejemplo, de 3 a 5 segundos) y realice el sondeo a una frecuencia fija (QPM: 3). Esta interfaz no requiere autenticación; no se necesita ninguna API Key.