Kommo ofrece a los desarrolladores la posibilidad de integrar diversos canales de mensajería. Para los usuarios, la experiencia de interactuar con estos canales desde la interfaz de Kommo será sencilla, similar a los canales ya existentes como WhatsApp, Facebook y Telegram.
Por favor, ten en cuenta que necesitas crear un canal de chat y continuar con la API de Chats solo si estás desarrollando tu propia integración con un sistema de mensajería.
Este artículo te guiará a través de los pasos básicos necesarios para comenzar a desarrollar una integración con la API de Chats.
Para comenzar con el desarrollo, necesitarás:
- Una cuenta activa en Kommo. Puedes registrarte para una prueba gratuita.
- Un endpoint público en tu servidor donde se recibirán las notificaciones de nuevos mensajes desde la interfaz de Kommo.
- Un canal de chat registrado para ser utilizado con la API de Chats.
Solicitar un nuevo canal
IEn Kommo, la API de Chats es responsable de gestionar los chats, los canales y los mensajes.
Por defecto, un canal en Kommo hace referencia a un tipo específico de plataforma de chat, como WhatsApp, Viber, Facebook o un chat en línea en un sitio web. Esto facilita el intercambio de mensajes entre Kommo y la plataforma de chat respectiva a través de la integración.
Para registrar un canal para la API de Chats, debes enviar una solicitud al soporte técnico de Kommo.
Tu solicitud debe contener:
| Elemento de la lista | ¿Obligatorio? | Descripción |
|---|---|---|
| 1. Nombre del servicio | ✅ | El nombre del servicio para el cual planeas desarrollar la integración. Este nombre se mostrará junto al ícono SVG en el perfil social bajo el nombre del contacto creado utilizando este canal de chat. Asegúrate de que el nombre del servicio contenga solo caracteres latinos y no comience con un número. |
| 2. URL del webhook | ✅ | La URL del webhook donde Kommo enviará los mensajes debe tener el formato https://domain.com/location/:scope_id. El marcador scope_id será establecido dinámicamente por el sistema y se puede utilizar para identificar la cuenta de la que proviene el mensaje. |
| 3. ID de cuenta de Kommo | ✅ | Un ID de cuenta de Kommo que funcionará con el nuevo canal. |
| 4. Función Escribir primero | ❌ | Para utilizar la función "Escribir primero", es posible que necesites utilizar plantillas para garantizar una experiencia de alta calidad y minimizar los mensajes de spam. |
| 5. Ventana de tiempo | ❌ | Debido a que muchas integraciones limitan la posibilidad de enviar mensajes después de cierto período, hemos añadido soporte para ventanas de tiempo. La integración determina la duración de esta ventana. En el perfil, después de cada mensaje entrante, el temporizador se reinicia y comienza a contar el tiempo hasta que finalice la ventana de tiempo. La integración también puede indicar que se debe bloquear el control de envío de mensajes una vez que la ventana de tiempo haya expirado. Cuando el envío se bloquea, el usuario aún tendrá la opción de seleccionar una plantilla para enviar. Entonces, si necesitas una ventana de tiempo: 5.1 debes indicar la duración de la ventana en segundos, y 5.2 debes definir si las plantillas del chat se mostrarán después de que expire la ventana de tiempo. |
| 6. Correo | ✅ | Correo para comunicación en caso de cualquier problema. |
| 7. Icono svg | ✅ | Icono SVG de tu canal. El icono debe ser redondo o encajar dentro de un círculo, y su tamaño debe ser de 14x14 px. |
| 8. ID de la integración | ✅ | ID de la integración que funcionará con la API de Chats. Primero debes crear la integración, y el ID se puede obtener desde la pestaña Claves en las propiedades de la integración. |
| 9. Código del widget de la integración | ✅ | Código del widget de integración que funcionará con la Chat API y la API de Fuentes. La integración que hayas creado debe contener un widget. Para integraciones públicas, la clave del widget es definida por el integrador y también puede copiarse desde la pestaña "Mis envíos" en la sección de configuración/integraciones. En el caso de integraciones privadas, se puede obtener desde la pestaña "Claves" en las propiedades de la integración. |
| 10. Privado/público | ✅ | ¿Estás planeando publicar tu solución para todos los usuarios de Kommo? ¿Ya existe una solución similar en Kommo? Si existe una solución similar, ¿qué hace única a la tuya? |
| 11. Avanzado ¿La integración almacena archivos? | ❌ | Esto es necesario para determinar si la integración almacena archivos de su lado que luego se envían a la Chat API de Kommo. Esta configuración afecta el comportamiento de la funcionalidad de carga diferida. El archivo debe ser accesible a través del enlace enviado en el webhook. |
| 12. Avanzado ¿La integración admite reacciones? | ❌ | Si la integración admite ciertas reacciones, por favor proporciónalas en el siguiente formato: 👍😳. |
| 13. Avanzado ¿La integración admite citar mensajes? | ❌ | La función de citar mensajes en un mensajero permite a los usuarios hacer referencia a mensajes específicos dentro de una conversación. |
| 14. Avanzado ¿La integración admite mensajes de voz? | ❌ | La función de mensajes de voz en un mensajero permite a los usuarios enviar y recibir mensajes de audio en lugar de texto. |
| 15. Avanzado ¿Cuál es el tamaño máximo de archivo disponible para enviar en el chat? | ❌ | Si tu canal de chat admite el envío de archivos, por favor proporciona información sobre el tamaño máximo de archivo permitido. |
El equipo de soporte técnico de Kommo revisa las solicitudes en un plazo de 1 a 3 días hábiles.
Como respuesta, nuestro equipo te proporcionará los parámetros para acceder a la API de Chats y los datos del bot del canal registrado.
NO recomendamos conectar más de un canal de chat a una misma integración. Si lo haces, podrías experimentar consecuencias inesperadas.
Un ejemplo de la respuesta
{
"result": {
"en": {
"id": "dw2asda2-929f-47c3-b1e7-c845a941833b",
"code": "Codechat",
"secret_key": "1eqadw323ead22wW2E1SA",
"name": "Chat",
"webhook_url": "https://webhook.site/4e6a83e5-90d02-4212192c-9c6d-adwdas212",
"enabled": true,
"test_mode": true,
"allowed_acc_list": [
{
"id": "1232d-d75c-4ee0-2dasd3-21easda212",
"external_id": "amocrm:1234567"
}
],
"contact_email": "[email protected]",
"created_at": 1732273375,
"updated_at": 1732273375,
"widget_code": "sadedf234fdq2easd2312sdws",
"supports_reply": true,
"write_first": true,
"webhook_url_v2": "https://webhook.site/4e6a83e5-90d02-4212192c-9c6d-adwdas212",
"time_window": {
"enabled": true,
"expires": 100000,
"tags": null,
"need_template": true
},
"bot": {
"id": "adads312-7ad01b-asdw3d23-das213-243r513sa",
"name": "Chat",
"is_bot": true
},
"webhook_events": [
"messages",
"typing"
],
"saves_files": true,
"supports_voice": true,
"supports_delivery_notification": true,
"icon": "https://st1.kommo.com/origins_icons/Chat.svg?1732273375",
"webhook_v2": true,
"time_window_support": true,
"need_display_template": true,
"time_window_enum": 100000,
"reactions_all": true,
"reactions_list": "",
"picture_size": 2,
"video_size": 2,
"voice_size": 2,
"file_size": 2,
"opposite_platform_enabled": false,
"client_uuid": "adwdasd2-21e2sdd-40ee-2dasd21-21e21e2esa"
}
},
"error": null
}
Ejemplo de credenciales de acceso para chats en línea
| Parámetro | Ejemplo |
|---|---|
| Código del canal | amo.ext.12345678 |
| ID del canal | 1234567-12be-4sr6-qwe3-0r12345446t201 |
| Secreto del canal | 12345678supersecret1234567 |
| Una cuenta conectada al canal | 12345678 |
Parámetros del bot del canal registrado de ejemplo
| Parámetro | Tipo de dato | Descripción | Ejemplo |
|---|---|---|---|
| id | string | ID del participante en el chat en el lado de Kommo (amojo_id). | 55c5555a-5ad5-4555-a555-555d55b5e5b5 |
| client_id | string | ID del participante en el chat en el lado de la integración. | 987654321-48d75-r4c89nt7-9ct4c |
| name | string | Nombre del bot. | MiKommo |
Después de implementar la integración, puede ser publicada en nuestro Marketplace una vez que haya pasado la moderación. Esto permitirá que se conecte a otras cuentas.
Si el canal está conectado a una integración privada, solo será accesible para la cuenta especificada en la solicitud.