Visión general
El canal de API es un canal genérico para integraciones personalizadas. En lugar de un canal listo (WhatsApp, correo, sitio web), conectas tu propio sistema o un canal no nativo: tu aplicación envía mensajes a la plataforma y recibe las respuestas vía API y webhooks.
Es la base ideal para integrar canales a medida, bots y sistemas externos, manteniendo las conversaciones centralizadas con historial, asignación y automatizaciones como en cualquier otro canal.
Requisitos previos
- Un perfil de administrador para crear la bandeja de API.
- Conocimiento técnico para consumir una API HTTP y tratar webhooks en tu sistema.
- Un endpoint público de tu lado para recibir los eventos de webhook (mensajes de la plataforma).
- Las credenciales de acceso de la API de tu cuenta (consulta la categoría de API y Desarrolladores).
Paso a paso
- En Configuración → Bandejas de entrada, crea una nueva bandeja y elige API.
- Indica el nombre del canal y, si aplica, la URL de webhook de tu sistema.
- Finaliza la creación — la bandeja pasa a tener un identificador propio.
- En tu sistema, usa la API para crear/identificar el contacto y enviar mensajes a la bandeja.
- Configura el webhook para recibir, en tu sistema, las respuestas y eventos de la plataforma.
- Envía un mensaje de prueba por la API y confirma que aparece como conversación.
Configuración y opciones
- Identificador de la bandeja: se usa en las llamadas de API para dirigir los mensajes a la bandeja correcta.
- URL de webhook: el endpoint de tu sistema que recibe los mensajes y eventos de la plataforma.
- Contactos y conversaciones: creados/actualizados vía API, con las mismas funciones que otros canales.
- Automatización y asignación: aplica reglas como en cualquier otro canal.
Casos de uso
- Conectar un canal propio o un sistema heredado sin integración nativa.
- Construir un bot personalizado que conversa con los contactos a través de la plataforma.
- Integrar una aplicación interna para registrar y responder conversaciones de forma automática.
Consejos, límites y buenas prácticas
- Trata el webhook de forma idempotente para evitar conversaciones o mensajes duplicados.
- Protege tus credenciales de API: mantenlas en el servidor, nunca expuestas en el cliente.
- Implementa reintentos en el envío para manejar fallos temporales de red.
Solución de problemas
- Los mensajes no entran: revisa el identificador de la bandeja y las credenciales usadas en la API.
- No recibo eventos en mi sistema: valida la URL de webhook y que tu endpoint responda con éxito.
- Conversaciones duplicadas: garantiza el tratamiento idempotente de los webhooks de tu lado.