🔷 Aprende cómo enviar mensajes mediante la documentación de la API Send de Whaticket y descubre los principales campos y ejemplos para integrar sistemas externos con la plataforma.
La API de Whaticket permite el envío de mensajes a través de conexiones de WhatsApp integradas en la plataforma.
Todas las solicitudes realizadas a la API requieren un token Bearer para la autenticación. Este token se genera en la sección Tokens dentro del panel de Whaticket.
Es fundamental asegurarse de otorgar todos los permisos necesarios al momento de crear el token para poder utilizar correctamente las funciones de la API.
▪️ Servidor base de la API
https://api.whaticket.com/api/v1
🟢 Cómo obtener los datos necesarios
Antes de realizar envíos utilizando la API Send, es necesario recopilar algunos identificadores dentro de la plataforma.
WhatsApp ID
El WhatsApp ID corresponde al identificador de la conexión de WhatsApp que será utilizada para enviar los mensajes.
Para obtenerlo:
▪️ Accede a Conexiones.
▪️ Haz clic en Editar sobre la conexión deseada.
▪️ Copia el ID de la conexión utilizando el ícono 📋.
ID de Departamento
El ID de departamento se utiliza cuando deseas asignar el ticket generado a un departamento específico.
Para obtenerlo:
▪️ Accede a Departamentos & Chatbots.
▪️ Selecciona el ícono del lápiz para editar el departamento.
▪️ Copia el ID del departamento utilizando el ícono 📋.
ID de Usuario
El ID de usuario permite asignar automáticamente el ticket generado a un agente específico.
Para obtenerlo:
▪️ Accede a Equipo.
▪️ Selecciona el ícono del lápiz para editar el usuario.
▪️ Copia el ID del usuario utilizando el ícono 📋.
ID de plantilla de mensaje (Template)
Si deseas utilizar plantillas de WhatsApp Business, también será necesario obtener el ID de la plantilla.
Para obtenerlo:
▪️ Accede a Plantillas de mensajes.
▪️ Selecciona el ícono de visualización.
▪️ Copia el ID que aparece junto a “Editar plantilla”.
🟢 Activar la API mediante Token
La activación de la API en Whaticket se realiza mediante el Token generado dentro de la plataforma. Este token permitirá autorizar todas las solicitudes realizadas a la API.
Crear el Token
Para generar el token:
▪️ Ve al apartado Tokens ubicado en el menú izquierdo de Whaticket.
▪️ Haz clic en el botón Nuevo Token.
▪️ Asigna un nombre al Token.
▪️ Acepta los permisos que se utilizarán para el envío de mensajes (se recomienda seleccionar todos).
▪️ Haz clic en el botón Guardar.
Una vez creado, se generará una clave de permiso del Token.
Copia esta clave haciendo clic en el ícono de carpeta para utilizarla posteriormente en la API.
Autorizar el uso de la API
Dentro de la plataforma existe una documentación interactiva de la API que permite realizar pruebas de envío.
Para autorizar el uso de la API:
▪️ Accede al apartado Documentación ubicado en el menú izquierdo.
▪️ Haz clic en el botón Authorize.
▪️ Pega la clave del Token en el campo correspondiente.
▪️ Cierra la ventana de autorización.
Cuando el candado del campo “Authorize” aparece cerrado, significa que la API está correctamente habilitada y lista para utilizarse.
🟢 Enviar tu primer mensaje
Una vez activada la API, puedes comenzar a realizar envíos de mensajes desde la documentación.
Para hacerlo:
▪️ Accede al apartado Messages dentro de la documentación de la API.
▪️ Haz clic en el ícono de flecha para desplegar la información del endpoint.
▪️ Haz clic en el botón Try it out para editar el mensaje.
Dentro del apartado Examples encontrarás varios ejemplos de mensajes que puedes utilizar como base para personalizar tu envío.
Ejemplo de mensaje utilizando la API:
{
"whatsappId": "TU_WHATSAPP_ID",
"messages": [
{
"number": "5513991113966",
"body": "Hola {{name}}, gracias por tu mensaje.",
"contactData": {
"name": "Nombre del contacto",
"email": "[email protected]",
"number": "5513991113966",
"force": true,
"customFields": [
{
"name": "Consulta",
"value": "Necesito más info"
}
]
}
}
]
}
🟢 Ejemplos de envíos utilizando la API
Enviar mensaje personalizado
{
"whatsappId": "TU_WHATSAPP_ID",
"messages": [
{
"number": "5513991113966",
"name": "Test Contact",
"body": "This is a test message body..."
}
]
}
Enviar el mismo mensaje a múltiples contactos
{
"whatsappId": "TU_WHATSAPP_ID",
"globalBody": "Hi, im here to talk about...!",
"messages": [
{
"number": "5513991113966"
},
{
"number": "5513991113966"
},
{
"number": "5513991113966"
}
]
}
Enviar el mismo archivo multimedia a múltiples contactos
{
"whatsappId": "TU_WHATSAPP_ID",
"globalMediaKey": "mstile150x150_88e21cba92da4f1ca4cfbeef453b1fbe.png",
"globalMediaType": "image",
"messages": [
{
"number": "5513991113966"
},
{
"number": "5513991113966"
},
{
"number": "5513991113966"
}
]
}
Enviar mensaje y asignarlo a un usuario y departamento
{
"whatsappId": "TU_WHATSAPP_ID",
"messages": [
{
"number": "5513991113966",
"body": "Mensaje asignado",
"ticketData": {
"userId": "ID_USUARIO",
"queueId": "ID_DEPARTAMENTO",
"status": "pending"
}
}
]
}
Enviar un mensaje y asignar su ticket a un usuario y una fila predeterminados
{
"whatsappId": "TU_WHATSAPP_ID",
"messages": [
{
"number": "5513991113966",
"name": "Test Contact",
"body": "This is a test message body...",
"ticketData": {
"status": "open",
"userId": "d58b13dd-3dd5-47e5-a601-a8383b8cd58b",
"queueId": "324d90c5-a4f2-4fb6-a9f9-e28dd6839609",
"force": true
}
}
]
}
Enviar un mensaje y mantener el ticket asignado hasta una fecha específica
{
"whatsappId": "TU_WHATSAPP_ID",
"messages": [
{
"number": "5513991113966",
"name": "Test Contact",
"body": "This is a test message body...",
"ticketData": {
"userId": "d58b13dd-3dd5-47e5-a601-a8383b8cd58b",
"keepAssigned": true,
"keepAssignedUntil": "2025-09-30",
"force": true
}
}
]
}
Enviar un mensaje y completar su contacto con información personalizada
{
"whatsappId": "TU_WHATSAPP_ID",
"messages": [
{
"number": "5513991113966",
"body": "This is a test message body...",
"contactData": {
"name": "New name for my contact",
"force": true,
"customFields": [
{
"name": "custom_id",
"value": "11111"
},
{
"name": "country",
"value": "Brazil"
}
]
}
}
]
}
Enviar mensajes de plantilla de WhatsApp Business API
{
"whatsappId": "TU_WHATSAPP_ID",
"templateId": "TU_TEMPLATE_ID",
"messages": [
{
"number": "5513991113966",
"name": "Test Contact"
}
]
}
Enviar mensajes de plantilla de WhatsApp Business API con variables
{
"whatsappId": "TU_WHATSAPP_ID",
"templateId": "TU_TEMPLATE_ID",
"messages": [
{
"number": "5513991113966",
"name": "Test Contact",
"variables": [
{
"name": "{{1}}",
"value": "{{contactName}}"
},
{
"name": "{{2}}",
"value": "{{contactNumber}}"
}
]
}
]
}
Enviar plantilla con medios utilizando WhatsApp API
{
"whatsappId": "TU_WHATSAPP_ID",
"globalMediaKey": "TU_Media_Key",
"globalMediaType": "image",
"templateId": "TU_TEMPLATE_ID",
"messages": [
{
"number": "5513991113966",
"body": "This is the body of the message"
},
{
"number": "5513991113966",
"body": "This is the body of the message"
},
{
"number": "5513991113966",
"body": "This is the body of the message"
}
]
}
🟢 Explicación de los campos del código
SendMessages
▪️ whatsappId
ID de la conexión de WhatsApp.
▪️ campaignName
Nombre de la campaña.
▪️ globalBody
Mensaje global para todos los contactos.
▪️ globalMediaKey
Clave del archivo a enviar.
▪️ globalMediaType
Tipo de medio.
▪️ template
Plantilla de mensaje de la API de WhatsApp.
▪️ name
Nombre de la plantilla.
▪️ language
Idioma de la plantilla.
▪️ variables
Variables incluidas en el mensaje.
▪️ media
Archivo de plantilla adjunto.
▪️ link
Enlace del archivo.
▪️ filename
Nombre del archivo cargado.
▪️ messages
Cuerpo del mensaje.
▪️ number
Número de WhatsApp del contacto.
▪️ name
Nombre del contacto.
▪️ body
Contenido del mensaje individual.
Crear contacto en Whaticket mediante CreateContactData
▪️ name
Nombre del contacto.
▪️ number
Número de WhatsApp.
▪️ treatmentName
Apodo o apellido del contacto.
▪️ email
Correo electrónico.
▪️ customFields
Campos personalizados del contacto.
Ejemplo:
▪️ name: empresa
▪️ value: Whaticket
¿Tienes dudas adicionales? No te preocupes, estamos aquí para ayudarte. Entra en contacto con nuestro equipo presionando el botón de "Soporte" ubicado en el menú izquierdo de nuestra plataforma.
