En el detalle técnico debajo encontrarás las diferentes respuestas que informaremos al webhook que nos indiques, cuando ejecutes los distintos endpoints de consulta disponibles en API Live.
⇒Ten en cuenta que el webhook es fundamental, porque será el espacio que te permitirá recibir las respuestas o eventos, que serán los de atención, transferencia, mensaje del cliente y cierre de conversación.
1. Evento de atención: este evento se enviará cuando algún agente reciba la conversación que se haya encolado, ya sea por un evento de encolar ocasionado por ustedes o un evento de transferencia ocasionado por otro agente. El evento tiene el siguiente formato:
{ "name": "attended", "roomId": "d5211892-e170-4d4a-b2dd-de705b595674", "timestamp": 1706293970842633079, "botId": 1000, "eventTime": 1706293970, "data": { "agent": { "name": "Tomas", "nickname": "Tomas NICKK", "groupId": 2179 } } } |
2. Evento de transferencia: se enviará una vez que se haya ejecutado un evento de transferencia, es decir que la conversación tendrá un destino diferente al cual se la había encolado. Por ejemplo, la conversación se encoló al grupo de Atención al cliente y luego, es derivado al grupo Ventas para cerrar la tratativa con el cliente en cuestión. El evento tiene el siguiente formato:
{ "name": "transfer", "roomId": "4f4bef4b-5cc3-4d9a-980b-c7426b4084a1", "timestamp": 1706215088420049502, "botId": 1000, "eventTime": 1706215088, "data": { "value": "Transfer to group", "hash": "23423456emvnghtisk456f08", "originGroup": 2333, "target": 5, "agent": {} } } |
Datos clave
- El campo origin group refiere al id del grupo de donde está siendo transferida la conversación.
- El campo target, hace referencia al id de grupo al cual busca llegar la conversación. Es decir, el destino.
3. Evento de mensaje al cliente: en este evento se informarán todos los mensajes que se escriben del lado del agente/live y que se dirigen al cliente/usuario. El evento tiene el siguiente formato:
{ "name": "messageToClient", "roomId": "7f185acb-214f-4d59-8612-357796a146b7", "timestamp": 1706293179331454146, "botId": 1000, "eventTime": 1706293179, "data": { "action": "text", "value": "¿Puedo ayudarlo en algo más?1", "source": "trigger", "hash": "b9e8f46b56efbace7a64cdab3_71146a36682af3c0915577", "agent": {} } } |
Datos clave
- El campo source puede ser tanto agent como trigger.
- Campo action puede ser tanto text, image cómo file.
- Campo value puede ser el texto que escribió el agente o directorio del archivo/imagen.
4. Evento de cierre de conversación: se publicará cada vez que se cierre la conversación. En el campo reason, dentro de su estructura, verás información extra del motivo de cierre. Por ejemplo, cierre del agente, cierre por trigger de inactividad, cierre por fila de espera etc. El evento tiene el siguiente formato:
{ "name": "close", "roomId": "21f4e58c-c1c3-452c-b7d3-b0c93aca0986", "timestamp": 1706293127429583428, "botId": 1000, "eventTime": 1706293127, "data": { "hash": "b9e8f46b56efbace7a64cdab3_7114636682af3c0915577", "reason": "queue clean process", "agent": {} } } { "name": "close", "roomId": "27101a99-d4f2-4c0c-98ad-8fe65366362d", "timestamp": 1706289577835959833, "botId": 1000, "eventTime": 1706289577, "data": { "hash": "b9e8f46b56efbace764cdab3_7114636682f3c0915577", "reason": "agent", "agent": {} } } |