Ir al contenido principal

Descripción general de las API de Wati

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

/api/ext/v3/...

No

v1

/{tenantId}/api/v1/...

Sí

v2

/{tenantId}/api/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

contactsv3:*

Operaciones de contacto

conversationsv3:*

Operaciones de conversación

messagetemplatev3:write

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

/api/ext/v3/channels

/{tenantId}/api/v1/whatsApp/phoneNumbers

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

/api/ext/v3/conversations/{target}/messages

/{tenantId}/api/v1/getMessages/{target}

Enviar un mensaje de texto de sesión

—

v3 disponible

/{tenantId}/api/v1/sendSessionMessage/{whatsappNumber}

Enviar un archivo de sesión

—

v3 disponible

/{tenantId}/api/v1/sendSessionFile/{whatsappNumber}

Enviar un archivo de sesión mediante URL

—

v3 disponible

/{tenantId}/api/v1/sendSessionFileViaUrl/{whatsappNumber}

Enviar un mensaje de plantilla

—

v3 disponible

/{tenantId}/api/v1/sendTemplateMessage

Enviar mensajes de plantilla de forma masiva

—

v3 disponible

/{tenantId}/api/v1/sendTemplateMessages

Enviar mensajes de plantilla usando un archivo CSV

POST

—

/{tenantId}/api/v1/sendTemplateMessageCSV

Enviar un mensaje de botón interactivo

—

v3 disponible

/{tenantId}/api/v1/sendInteractiveButtonsMessage/{whatsappNumber}

Enviar un mensaje de lista interactiva

—

v3 disponible

/{tenantId}/api/v1/sendInteractiveListMessage/{whatsappNumber}

Enviar un mensaje de llamada a la acción (CTA) con URL

POST

—

/{tenantId}/api/v1/sendInteractiveCtaUrlMessage

Actualizar el estado de la conversación

PUT

/api/ext/v3/conversations/{target}/status

/{tenantId}/api/v1/updateChatStatus

Asignar un operador a una conversación

PUT

/api/ext/v3/conversations/{target}/operator

/{tenantId}/api/v1/assignOperator

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 200 exitosa 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_v2 para realizar un seguimiento de la entrega de mensajes. El evento templateMessageFailed informa 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

/api/ext/v3/contacts

/{tenantId}/api/v1/getContacts

Agregar un contacto

POST

/api/ext/v3/contacts

/{tenantId}/api/v1/addContact/{whatsappNumber}

Actualizar atributos de contacto

PUT

/api/ext/v3/contacts

/{tenantId}/api/v1/updateContactAttributes/{whatsappNumber}

Actualizar múltiples contactos

POST

—

/{tenantId}/api/v1/updateContactAttributesForMultiContacts

Obtener detalles del contacto

GET

/api/ext/v3/contacts/{target}

—

Obtener el recuento total de contactos

GET

/api/ext/v3/contacts/count

—

Eliminar un contacto

—

v3 disponible

—

Asignar contactos a equipos

PUT

/api/ext/v3/contacts/teams

—

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

/api/ext/v3/messageTemplates

/{tenantId}/api/v1/getMessageTemplates

Obtener una plantilla por ID

GET

/api/ext/v3/messageTemplates/{template_id}

—

Crear una plantilla

POST

—

/{tenantId}/api/v1/whatsApp/templates

Eliminar una plantilla

DELETE

—

/{tenantId}/api/v1/whatsApp/templates/{wabaId}/{name}/{language}

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

/api/ext/v3/broadcasts

—

Obtener detalles de la campaña

GET

/api/ext/v3/broadcasts/{broadcast_id}

—

Obtener destinatarios de la campaña

GET

/api/ext/v3/broadcasts/{broadcast_id}/recipients

—

Obtener descripción general de la campaña

GET

/api/ext/v3/broadcasts/overview

—

Estimar coste de la campaña

POST

/api/ext/v3/broadcasts/estimate-cost

—

Programar una campaña

POST

—

/{tenantId}/api/v1/broadcast/scheduleBroadcast

Eliminar una campaña programada

DELETE

—

/{tenantId}/api/v1/broadcast/deleteScheduledBroadcast/{broadcastId}

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

/api/ext/v3/calls

Obtener una grabación de llamada

GET

/api/ext/v3/calls/{call_id}/recording

Obtener una transcripción de llamada

GET

/api/ext/v3/calls/{call_id}/transcript

Obtener un resumen de llamada

GET

/api/ext/v3/calls/{call_id}/summary

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

/api/ext/v3/chatbots

/{tenantId}/api/v1/chatbots

Iniciar un chatbot

POST

/api/ext/v3/chatbots/start

/{tenantId}/api/v1/chatbots/start

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

/api/ext/v3/segments

—

Obtener un segmento

GET

/api/ext/v3/segments/{segmentId}

—

Evaluar filtros de segmentos

—

v3 disponible

—

Crear un segmento personalizado

POST

—

/{tenantId}/api/v1/createCustomSegment

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

/api/ext/v3/webhooks

—

Obtener una suscripción a webhook

GET

/api/ext/v3/webhooks/{id}

—

Actualizar una suscripción a webhook

PUT

/api/ext/v3/webhooks/{id}

—

Eliminar una suscripción a webhook

DELETE

/api/ext/v3/webhooks/{id}

—

Listar tipos de eventos de webhook disponibles

—

v3 disponible

—

Crear una suscripción a webhook

POST

—

/{tenantId}/api/v2/webhookEndpoints

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

/api/ext/v3/posts

Obtener una publicación de Instagram

GET

/api/ext/v3/posts/{post_id}

Listar comentarios en una publicación

GET

/api/ext/v3/posts/{post_id}/comments

Obtener el recuento de comentarios no leídos

GET

/api/ext/v3/posts/{post_id}/unreadCount

Responder a un comentario

POST

/api/ext/v3/comments/{comment_id}/replies

Enviar una respuesta privada a un comentario

POST

/api/ext/v3/comments/{comment_id}/privateReply

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

/api/ext/v3/account/credits

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

—

/{tenantId}/api/v1/getMedia

Obtener medios por ID de mensaje

GET

/api/ext/v3/conversations/messages/file/{message_id}

—

Bloquear un token

POST

—

/{tenantId}/api/v1/rotateToken

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.

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 200 exitosa 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 rotateToken bloquea 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.

¿Ha quedado contestada tu pregunta?