Webhook de Live Chat
Los webhooks son un recurso potente de NicoChat que te permite integrar tu propia plataforma con la automatización de chat de NicoChat. Esto es útil si tienes una plataforma de Live Chat propia y quieres aprovechar los recursos de automatización de NicoChat sin llevar a los contactos a la interfaz de NicoChat.
¿Quién debe usar Webhooks?
Los webhooks están diseñados para desarrolladores que tienen su propia plataforma y algo de experiencia con APIs.
Cómo configurar Webhooks en NicoChat
Consulta el paso a paso para configurar webhooks en NicoChat:
Configura la URL de tu Webhook:
- Ve a Integrations y luego a Webhooks entrantes.
- Opcionalmente, puedes configurar tus propios encabezados para mayor seguridad.
- Indica la URL del Webhook donde quieres recibir los datos.
Activa Webhooks en Channel Settings:
- Ve a Channel Settings del chat que quieres integrar a tu plataforma (por ejemplo, WhatsApp, SMS).
- En Live Chat Settings, selecciona Webhook.
Usa la acción Pause the Bot:
- En tu flujo de NicoChat, incluye la acción Pause the Bot en el punto en que quieres que la conversación pase a tu plataforma.
- Cuando un contacto interactúe después de ese punto, el mensaje se enviará a la URL de tu Webhook.
Ejemplo de payload
Los datos que NicoChat envía a la URL de tu Webhook son un payload JSON con varios detalles sobre el mensaje y la conversación. Consulta el desglose del payload de ejemplo de la imagen:
- meta
user_ns: identificador único del contacto. agent_id: ID del agente asignado a la conversación en ese momento (0 indica que no hay agente asignado). flow_ns: identificador único del flujo de chat. team_id: ID del equipo al que pertenece el chat. - message
_id: identificador único del mensaje. mid: identificador único del mensaje dentro del canal. type: indica el tipo de mensaje (por ejemplo, "in" para mensaje recibido). msg_type: especifica el tipo de contenido del mensaje (por ejemplo, "text"). sender_id: ID del remitente del mensaje. agent_id: ID del agente que recibió el mensaje (0 indica que no hay agente asignado). assigned_agent_id: ID del agente asignado a la conversación después de que se recibió el mensaje. - payload
text: contiene el contenido de texto del mensaje. content: también contiene el contenido de texto del mensaje. username: nombre de usuario del remitente del mensaje. date: muestra la fecha en que se envió el mensaje. timestamp: timestamp del mensaje en milisegundos. ts: otra representación del timestamp del mensaje. is_delivered: indica si el mensaje fue entregado (1 significa entregado). seen: este campo viene vacío en el payload de ejemplo, pero puede indicar si el mensaje fue visto.
Usando la API de NicoChat
Después de capturar el mensaje del contacto en tu plataforma, puedes usar la API de NicoChat para enviar una respuesta al contacto dentro de la conversación. La API de NicoChat usa el user_ns y el flow_ns del payload para identificar la conversación y enviar el mensaje.
Consideraciones adicionales
- Los webhooks son una herramienta potente, pero exigen experiencia en desarrollo.
- NicoChat ofrece soporte para varios tipos de mensaje, y el payload refleja el tipo de contenido (texto, imagen, etc.).
- Usa la API de NicoChat para la comunicación en los dos sentidos entre tu plataforma y los contactos de NicoChat.
Siguiendo estos pasos y entendiendo los datos del payload, puedes configurar webhooks para integrar tu propia plataforma a los recursos de automatización de NicoChat.