Resumen
Wati proporciona interfaces de programación de aplicaciones (API) que le permiten conectar Wati con sus sistemas existentes, automatizar la mensajería, gestionar contactos, ejecutar campañas y acceder a otras funciones de Wati mediante programación.
Esta guía ofrece una descripción general de las API de Wati disponibles, incluidos sus endpoints, las versiones de API compatibles y enlaces a recursos adicionales para desarrolladores.
Importante: se recomienda usar la v3 para todas las integraciones nuevas. Los endpoints heredados v1 y v2 siguen estando disponibles cuando son compatibles.
Instrucciones
1. Comprender las versiones y los endpoints de la API de Wati
Los endpoints de la API de Wati utilizan diferentes formatos de URL según la versión de la API.
URL base: https://live-mt-server.wati.io
Versión de la API | Formato de ruta URL | ¿Se requiere el ID del inquilino en la ruta? |
v3 |
| No |
v1 |
| Sí |
v2 |
| Sí |
Para los endpoints v1 y v2, reemplace {tenantId} por su ID de inquilino de Wati. Para los endpoints v3, el ID del inquilino no se incluye en la ruta de la URL.
Utilice la v3 para nuevas integraciones siempre que la operación requerida sea compatible. Utilice los endpoints heredados cuando la operación requerida no esté disponible en la v3.
2. Crear un token de API
Necesita un token de API para autenticar las solicitudes a los endpoints de la API de Wati.
Para crear un token de API:
Inicie sesión en su cuenta de Wati.
Vaya a Connector > API.
Seleccione Create API Token.
Cree un token con los permisos adecuados para las operaciones de API que desea realizar.
Para los endpoints v3, seleccione el alcance (scope) del token necesario:
Alcance del token | Utilizado para |
| Operaciones de contacto |
| Operaciones de conversación |
| Envío de plantillas de mensajes |
Asegúrese de que su token tenga el alcance necesario para el endpoint que desea utilizar.
3. Explorar las API de Wati disponibles
Las siguientes secciones agrupan las API de Wati por funcionalidad. Cada tabla enumera las operaciones disponibles y sus rutas de endpoint documentadas.
3.1 API de Canales
Utilice la API de Canales para recuperar información sobre sus números de WhatsApp conectados.
Operación | Método | Endpoint v3 | Endpoint v1 |
Listar números de WhatsApp conectados | GET |
|
|
3.2 API de Mensajería
Utilice la API de Mensajería para enviar mensajes, recuperar el historial de mensajes de las conversaciones y gestionar conversaciones.
Operación | Método | Endpoint v3 | Endpoint v1 |
Obtener el historial de mensajes de un contacto | GET |
|
|
Enviar un mensaje de texto de sesión | — | v3 disponible |
|
Enviar un archivo de sesión | — | v3 disponible |
|
Enviar un archivo de sesión mediante URL | — | v3 disponible |
|
Enviar un mensaje de plantilla | — | v3 disponible |
|
Enviar mensajes de plantilla de forma masiva | — | v3 disponible |
|
Enviar mensajes de plantilla usando un archivo CSV | POST | — |
|
Enviar un mensaje de botón interactivo | — | v3 disponible |
|
Enviar un mensaje de lista interactiva | — | v3 disponible |
|
Enviar un mensaje de llamada a la acción (CTA) con URL | POST | — |
|
Actualizar el estado de la conversación | PUT |
|
|
Asignar un operador a una conversación | PUT |
|
|
Notas importantes:
La API de historial de mensajes recupera el historial de conversación de un contacto específico. No recupera todos los mensajes recibidos por su número de WhatsApp.
Una respuesta HTTP
200exitosa de una API de envío de mensajes significa que la solicitud fue aceptada. No confirma que el mensaje haya sido entregado al destinatario.Utilice el evento de webhook
sentMessageDELIVERED_v2para realizar un seguimiento de la entrega de mensajes. El eventotemplateMessageFailedinforma de errores en el envío de mensajes.
3.3 API de Contactos
Utilice la API de Contactos para crear, recuperar, actualizar, eliminar y organizar contactos en Wati.
Operación | Método | Endpoint v3 | Endpoint v1 |
Listar contactos | GET |
|
|
Agregar un contacto | POST |
|
|
Actualizar atributos de contacto | PUT |
|
|
Actualizar múltiples contactos | POST | — |
|
Obtener detalles del contacto | GET |
| — |
Obtener el recuento total de contactos | GET |
| — |
Eliminar un contacto | — | v3 disponible | — |
Asignar contactos a equipos | PUT |
| — |
Requisito del plan: Actualizar múltiples contactos a través del endpoint v1 requiere un plan Business.
3.4 API de Plantillas de Mensajes
Utilice la API de Plantillas de Mensajes para recuperar, crear y eliminar plantillas de mensajes de WhatsApp.
Operación | Método | Endpoint v3 | Endpoint v1 |
Listar plantillas de mensajes | GET |
|
|
Obtener una plantilla por ID | GET |
| — |
Crear una plantilla | POST | — |
|
Eliminar una plantilla | DELETE | — |
|
3.5 API de Campañas
Utilice la API de Campañas para recuperar información de campañas, estimar los costes de las campañas y gestionar difusiones programadas.
Operación | Método | Endpoint v3 | Endpoint v1 |
Listar campañas | GET |
| — |
Obtener detalles de la campaña | GET |
| — |
Obtener destinatarios de la campaña | GET |
| — |
Obtener descripción general de la campaña | GET |
| — |
Estimar coste de la campaña | POST |
| — |
Programar una campaña | POST | — |
|
Eliminar una campaña programada | DELETE | — |
|
3.6 API de Etiquetas
Utilice la API de Etiquetas para organizar conversaciones añadiendo o eliminando etiquetas.
Operación | Disponibilidad en v3 |
Añadir una etiqueta a una conversación | Disponible |
Eliminar una etiqueta de una conversación | Disponible |
Consulte la documentación de la API de Wati para conocer las rutas de los endpoints relevantes y los detalles de la solicitud.
3.7 API de Indicador de Escritura
Utilice la API de Indicador de Escritura para mostrar un indicador de escritura a un contacto durante una sesión de mensajería activa.
Operación | Disponibilidad en v3 |
Enviar un indicador de escritura | Disponible |
Consulte la documentación de la API de Wati para obtener detalles sobre el endpoint.
3.8 API de Llamadas
Utilice la API de Llamadas para recuperar registros de llamadas, grabaciones, transcripciones y resúmenes.
Operación | Método | Endpoint v3 |
Obtener registros de llamadas | GET |
|
Obtener una grabación de llamada | GET |
|
Obtener una transcripción de llamada | GET |
|
Obtener un resumen de llamada | GET |
|
Recuperar múltiples grabaciones, transcripciones o resúmenes | — | v3 disponible |
Consulte la documentación de la API de Wati para obtener los detalles de la solicitud para operaciones por lotes.
3.9 API de Chatbots
Utilice la API de Chatbots para recuperar chatbots disponibles e iniciar flujos de chatbot.
Operación | Método | Endpoint v3 | Endpoint v1 |
Listar chatbots | GET |
|
|
Iniciar un chatbot | POST |
|
|
Requisito del plan: La API de Chatbots requiere un plan Pro o Business.
3.10 API de Segmentos
Utilice la API de Segmentos para recuperar segmentos de contactos, evaluar filtros de segmentos y crear segmentos personalizados.
Operación | Método | Endpoint v3 | Endpoint v1 |
Listar segmentos | GET |
| — |
Obtener un segmento | GET |
| — |
Evaluar filtros de segmentos | — | v3 disponible | — |
Crear un segmento personalizado | POST | — |
|
Requisito del plan: Crear un segmento personalizado a través del endpoint v1 requiere un plan Pro o Business.
3.11 API de Gestión de Webhooks
Los webhooks permiten que Wati envíe notificaciones de eventos a una URL que usted configure. Puede utilizar la API de Gestión de Webhooks para gestionar las suscripciones a webhooks mediante programación.
Operación | Método | Endpoint v3 | Endpoint v2 |
Listar suscripciones a webhooks | GET |
| — |
Obtener una suscripción a webhook | GET |
| — |
Actualizar una suscripción a webhook | PUT |
| — |
Eliminar una suscripción a webhook | DELETE |
| — |
Listar tipos de eventos de webhook disponibles | — | v3 disponible | — |
Crear una suscripción a webhook | POST | — |
|
Para obtener instrucciones sobre cómo configurar y gestionar eventos de webhook, consulte la documentación de Webhooks de Wati.
3.12 API de Instagram
Utilice la API de Instagram para recuperar publicaciones y comentarios de Instagram y responder a los comentarios.
Operación | Método | Endpoint v3 |
Listar publicaciones de Instagram | GET |
|
Obtener una publicación de Instagram | GET |
|
Listar comentarios en una publicación | GET |
|
Obtener el recuento de comentarios no leídos | GET |
|
Responder a un comentario | POST |
|
Enviar una respuesta privada a un comentario | POST |
|
3.13 API de Créditos de Cuenta
Utilice la API de Créditos de Cuenta para comprobar el saldo de créditos de su cuenta de Wati.
Operación | Método | Endpoint v3 |
Obtener créditos de la cuenta | GET |
|
3.14 API de Gestión de Medios y Tokens
Utilice las API de Medios para recuperar archivos multimedia y la API de gestión de tokens para bloquear un token de API.
Operación | Método | Endpoint v3 | Endpoint v1 |
Obtener medios por nombre de archivo | GET | — |
|
Obtener medios por ID de mensaje | GET |
| — |
Bloquear un token | POST | — |
|
Importante: el endpoint v1 rotateToken bloquea el token especificado. No genera un token de reemplazo. Para crear un nuevo token de API, vaya a Connector > API > Create API Token en su cuenta de Wati.
3.15 Servidor de protocolo de contexto de modelo (MCP)
Wati proporciona un servidor de protocolo de contexto de modelo (MCP) que permite a las herramientas y agentes de IA conectarse directamente a las capacidades de Wati.
Para obtener instrucciones de configuración, consulte la documentación para desarrolladores de Wati.
4. Recursos adicionales
Utilice los siguientes recursos para explorar los endpoints de la API, configurar webhooks y probar las solicitudes de API.
Documentación de la API de Wati: explore los endpoints de la API y los detalles de las solicitudes.
Documentación de Webhooks de Wati: aprenda a configurar webhooks y a gestionar notificaciones de eventos.
Colección Postman de Wati: encuentre una colección para probar las solicitudes de la API de Wati usando Postman.
5. Notas importantes sobre la API
Tenga en cuenta los siguientes puntos al realizar la integración con Wati:
Elija la versión correcta de la API: utilice la v3 para las nuevas integraciones siempre que la operación requerida sea compatible. Los endpoints heredados v1 y v2 siguen estando disponibles donde están documentados.
Utilice el formato de URL correcto: los endpoints v3 no incluyen el ID del inquilino en la ruta. Los endpoints v1 y v2 documentados incluyen
/{tenantId}/.Utilice el alcance de token correcto: cree un token de API con los permisos necesarios para sus operaciones v3.
Compruebe la entrega de mensajes por separado: una respuesta HTTP
200exitosa de un endpoint de envío de mensajes no confirma la entrega. Utilice el evento de webhook correspondiente para realizar un seguimiento de la entrega o el fallo.Comprenda la rotación de tokens: el endpoint v1
rotateTokenbloquea un token en lugar de crear uno nuevo.
Para parámetros específicos de endpoints, formatos de solicitud, respuestas y ejemplos, consulte la documentación de la API de Wati.
