Canal de chat API
Cuando este complemento de socio está habilitado, el espacio de trabajo del cliente podrá configurar un webhook para el canal de chat API.
Este complemento permite la integración de usuarios desde fuentes externas al sistema nativo de chat en vivo de OneChat. Una vez agregados, estos usuarios pueden participar en conversaciones en tiempo real con agentes dentro de OneChat, igual que los de los canales de comunicación habituales. Esto garantiza una experiencia de mensajería unificada, permitiendo a los agentes gestionar y responder todas las consultas de los usuarios desde una sola plataforma.
Comunícate con el soporte de OneChat para este canal.
Instrucciones
Configuración inicial
1. Habilita el complemento de socio, Api Chat
2. Configura el webhook de api chat para el espacio de trabajo mediante la partner api; la URL del webhook debe verificarse
bot_url de la respuesta de configuración del webhook de api chat se usará para enviar mensajes desde el usuario bot
revisa los ejemplos de payload para diferentes tipos de mensajes3. cuando el bot responda o el agente responda, el payload del mensaje se enviará a la URL del webhook de api chat proporcionada con una firma en el encabezado
Partner Api para obtener/configurar/eliminar webhook
Debes usar tu clave de partner api para la autenticación
- Obtener webhook
GET {{baseUrl}}/api/partner/workspace/{{workspace_id}}/apichat-webhookRequest body: (vacío)
POST {{baseUrl}}/api/partner/workspace/{{workspace_id}}/set-apichat-webhookRequest body:
DELETE {{baseUrl}}/api/partner/workspace/{{workspace_id}}/remove-apichat-webhookRequest body: (vacío)
POST https://bot.dfktv2.com/api/apichat/{{unique_code_to_bot}}Request body:
POST https://bot.dfktv2.com/api/apichat/{{unique_code_to_bot}}Request body:
POST https://bot.dfktv2.com/api/apichat/{{unique_code_to_bot}}Request body:
POST https://bot.dfktv2.com/api/apichat/{{unique_code_to_bot}}Request body:
POST https://bot.dfktv2.com/api/apichat/{{unique_code_to_bot}}Request body:
POST https://bot.dfktv2.com/api/apichat/{{unique_code_to_bot}}Request body:
Payload del Webhook
Cuando el bot o el agente envíen un mensaje, tu URL del webhook recibirá el payload del mensaje. Para cada solicitud, puedes revisar los siguientes encabezados.
Código de ejemplo en php para verificar la firma del payload
body();
$verification_key = "{{VERIFICATION_TOKEN}}";
$sign = 'sha256='.hash_hmac('sha256', $payload, $verification_key);
//debes verificar que el valor de la firma en el encabezado coincida
request()->header('X-Hub-Signature-256') == $sign]]>