Documentación de la API de WhatsApp
Documentación de la API de WhatsApp: guía de uso de la plataforma.
la plataforma-SOP-MANUAL-
Documentación WhatsApp via 01-Documentacion-
API WhatsApp-API
Versión 1
05/05/2026
Plantilla para enviar mensajes de texto
POST https://api.getincloud.online/balerion/v3/messages
Una vez que la plantilla de mensaje de texto de WhatsApp ha sido creada mediante la
interfaz de usuario o la API y ha sido aprobada, el siguiente paso es enviar la plantilla a los
usuarios finales a través de la API de mensajes.
Body Params
Whatsapp Message Request
placeholders (object)
Objeto de campos personalizados (marcadores de posición) que contienen el cuerpo del
mensaje de texto.
Desde el objeto placeholders, establezca como parámetro el marcador de posición que
configuró dentro de llaves dobles {{...}} al crear la plantilla. Luego, asigne el valor
correspondiente al parámetro del marcador.
Los marcadores de posición deben estar correctamente formateados en el mismo orden en
que se creó la plantilla.
Ejemplo: para un mensaje como “Here is your {{code}}”, debe establecer el marcador
como code: 34871.
templateName (string)
Nombre de la plantilla creada en su cuenta de WhatsApp Business.
templateLanguage (string)
Idioma de la plantilla definido al momento de su creación.
Actualmente la API soporta 3 idiomas: Inglés, Español y Portugués. Es obligatorio si desea
enviar plantillas en un idioma diferente al inglés.
• English: en
• Spanish: es
• Portuguese: pt_BR, pt_PT
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje de plantilla. Los números
deben especificarse en formato E.164 (incluye + y código de país).
templateId (string)
Identificador único de la plantilla.
callbacks (array de strings)
Compartimos un curl de ejemplo:
curl --location 'https://api.getincloud.online/balerion/v3/messages' \
--header 'accept: application/json' \
--header 'authorization: Bearer tutoken \
--header 'content-type: application/json' \
--data
{
"templateName": "test_getincloud20042026",
"templateLanguage": "es",
"from": "573212417473",
"to": "573104258723",
"placeholders": {
"1": "Camilo"
}
}
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación.
410 Gone
El recurso solicitado ya no está disponible.
500 Internal Server Error
Error interno del servidor.
Envío de Plantilla de Mensaje Multimedia
POST https://api.getincloud.online/balerion/v3/messages
Una vez que la plantilla de mensaje multimedia de WhatsApp ha sido creada mediante la
interfaz de usuario o la API y ha sido aprobada, el siguiente paso es enviar la plantilla a los
usuarios finales a través de la API de mensajes.
Compartimos un curl de ejemplo:
curl --location
'https://api.getincloud.online/balerion/v2/whatsapp/templates/?wabaId=1560277425307032'
\
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{toToken}} \
--data
{
"category": "MARKETING",
"name": "test_juan2",
"templateLanguages": [
{
"language": "es",
"components": [
{
"type": "BODY",
"text": "This is a message of test from GETINCLOUD, welcome {{1}}, have a
nice day",
"example": {
"body_text": [
[
"Juan"
]
]
}
}
]
}
]
}
Body Params
Whatsapp Message Request
placeholders (object)
Aplica únicamente si el tipo BODY contiene campos personalizados (placeholders).
Objeto de campos personalizados (placeholders) que contienen el cuerpo del mensaje de
texto.
Desde el objeto placeholders, establezca como parámetro el marcador configurado dentro
de llaves dobles {{...}} al crear la plantilla. Luego, asigne el valor correspondiente al
parámetro del marcador.
Los marcadores deben estar correctamente formateados en el mismo orden en que se creó la
plantilla.
Ejemplo: para un mensaje como “Here is your {{code}}”, debe establecer el marcador
como code: 34871.
templateName (string)
Nombre de la plantilla creada en su cuenta de WhatsApp Business.
templateLanguage (string)
Idioma de la plantilla definido al momento de su creación.
Actualmente la API soporta 3 idiomas: Inglés, Español y Portugués. Es obligatorio si desea
enviar plantillas en un idioma diferente al inglés.
• English: en
• Spanish: es
• Portuguese: pt_BR, pt_PT
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje de plantilla. Los números
deben especificarse en formato E.164 (incluye + y código de país).
templateId (string)
Identificador único de la plantilla.
callbacks (array de strings)
templateHeader (object)
Aplica únicamente si la plantilla contiene el tipo HEADER con un campo personalizado
(placeholder) en el encabezado de texto o una URL basada en el tipo de encabezado
multimedia seleccionado (imagen, video, documento).
Objeto de campos personalizados (placeholders) o URL que contiene el tipo de encabezado
definido al crear la plantilla.
templateButtons (array)
Aplica únicamente si la plantilla contiene el tipo BUTTONS con URL dinámica o botones de
respuesta rápida (Quick Reply).
Si configura el tipo de botón como Call To Action, es obligatorio cuando el botón contiene
una URL dinámica.
Si configura el tipo de botón como Quick Reply, es obligatorio cuando el botón contiene un
payload o palabras clave.
Arreglo que contiene el valor del sufijo de URL (placeholder) para botones de tipo Call To
Action con URL dinámica, y los payloads o palabras clave de los botones Quick Reply
definidos al crear la plantilla.
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible o la plantilla no es válida.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.
Envío de Plantilla de Autenticación
POST https://api.getincloud.online/balerion/v3/messages
Una vez que la plantilla de autenticación de WhatsApp ha sido creada mediante la interfaz
de usuario o la API y ha sido aprobada, el siguiente paso es enviar la plantilla a los usuarios
finales a través de la API de mensajes.
Body Params
Whatsapp Message Request
placeholders (object)
Establezca code como parámetro.
Corresponde a la contraseña de un solo uso (OTP) o código de verificación que será
enviado al cliente.
templateName (string)
Nombre de la plantilla creada en su cuenta de WhatsApp Business.
templateLanguage (string)
Idioma de la plantilla definido al momento de su creación.
Actualmente la API soporta 3 idiomas: Inglés, Español y Portugués. Es obligatorio si desea
enviar plantillas en un idioma diferente al inglés.
• English: en, en_GB, en_US
• Spanish: es, es_AR, es_ES
• Portuguese: pt_BR, pt_PT
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para la plantilla de autenticación. Los números
deben especificarse en formato E.164 (incluye + y código de país).
callbacks (array de strings)
templateButtons (array)
Arreglo que contiene el botón de copia de código para un botón de tipo Call To Action.
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible o la plantilla no es válida.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.
Envío de Plantilla de Mensaje Tipo Carrusel
POST https://api.getincloud.online/balerion/v3/messages
Una vez que la plantilla de mensaje tipo carrusel de WhatsApp ha sido creada mediante la
API y ha sido aprobada, el siguiente paso es enviar la plantilla a los usuarios finales a través
de la API de mensajes.
Body Params
Whatsapp Message Request
placeholders (object)
Aplica únicamente si el tipo BODY (cuerpo del mensaje) contiene campos personalizados
(placeholders).
Objeto de campos personalizados (placeholders) que contienen el cuerpo del mensaje.
Desde el objeto placeholders, establezca como parámetro el marcador configurado dentro
de llaves dobles {{...}} al crear la plantilla. Luego, asigne el valor correspondiente al
parámetro del marcador.
Los marcadores deben estar correctamente formateados en el mismo orden en que se creó la
plantilla.
Ejemplo: para un mensaje como “Here is your {{code}}”, debe establecer el marcador
como code: 34871.
templateName (string)
Nombre de la plantilla creada en su cuenta de WhatsApp Business.
templateLanguage (string)
Idioma de la plantilla definido al momento de su creación.
Actualmente la API soporta 3 idiomas: Inglés, Español y Portugués. Es obligatorio si desea
enviar plantillas en un idioma diferente al inglés.
• English: en
• Spanish: es
• Portuguese: pt_BR, pt_PT
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje de plantilla. Los números
deben especificarse en formato E.164 (incluye + y código de país).
type (string)
Especifica el tipo de plantilla de mensaje que se está enviando.
Para plantillas tipo carrusel, este valor debe establecerse como carousel.
templateId (string)
Identificador único de la plantilla de mensaje.
callbacks (array de strings)
cards (array de objetos)
Arreglo que define el contenido de cada tarjeta del carrusel en el momento del envío.
Cada objeto dentro de este arreglo corresponde a una tarjeta definida en la plantilla del
mensaje y debe seguir el mismo orden.
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible o la plantilla no es válida.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.
Envío de Mensaje de Texto
POST https://getincloud.online/balerion/v3/messages
Si un usuario de WhatsApp ha enviado un mensaje a su aplicación — ya sea como
respuesta a una plantilla previamente enviada o iniciando la conversación — su aplicación
dispone de una ventana de 24 horas para enviar mensajes sin necesidad de usar plantillas.
Estos se conocen como mensajes de sesión.
Los mensajes de texto contienen únicamente un cuerpo de texto.
Body Params
Whatsapp Message Request
externalId (string)
Identificador alfanumérico utilizado para fines de reporte.
callbacks (array de strings)
URL de webhook para notificar los eventos del mensaje de WhatsApp.
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje. Los números deben
especificarse en formato E.164 (incluye + y código de país).
body (string)
Longitud entre 0 y 4096.
Aplica únicamente para los tipos text, image, audio, document.
Para mensajes de tipo text, corresponde al contenido del mensaje a enviar. El texto tiene
un límite de 1024 caracteres.
Para mensajes multimedia, corresponde a la URL del archivo (imagen, video o documento).
La URL debe ser válida, iniciar con http:// o https:// y permitir descarga directa. No se
soportan redirecciones.
type (string)
Tipo de mensaje que se desea enviar.
Opciones soportadas:
• text: Envía un mensaje de texto plano.
• image: Envía un archivo de imagen (.jpeg, .png).
• audio: Envía un archivo de audio (.acc, .mp3, .amr, .mpeg).
• video: Envía un archivo de video (.mp4, .3gpp).
• document: Envía un archivo de documento (.pdf).
• contacts: Envía información de contacto.
• location: Envía una ubicación con latitud y longitud.
• interactive: Envía un mensaje interactivo con botones o listas.
En este caso, se utiliza el valor text.
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento. El mensaje ha sido
encolado para envío.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.
Envío de Mensaje Multimedia
POST https://api.getincloud.online/balerion/v3/messages
Si un usuario de WhatsApp ha enviado un mensaje a su aplicación — ya sea como
respuesta a una plantilla previamente enviada o iniciando la conversación — su aplicación
dispone de una ventana de 24 horas para enviar mensajes sin necesidad de usar plantillas.
Estos se conocen como mensajes de sesión.
Los mensajes multimedia incluyen contenido como imágenes, archivos de audio, videos y
documentos.
Body Params
Whatsapp Message Request
externalId (string)
Identificador alfanumérico utilizado para fines de reporte.
callbacks (array de strings)
URL de webhook para notificar los eventos del mensaje de WhatsApp.
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje. Los números deben
especificarse en formato E.164 (incluye + y código de país).
body (string)
Longitud entre 0 y 4096.
Aplica únicamente para los tipos text, image, audio, document.
Para mensajes de tipo text, corresponde al contenido del mensaje a enviar. El texto tiene
un límite de 1024 caracteres.
Para mensajes multimedia, corresponde a la URL del archivo (imagen, video o documento).
La URL debe ser válida, iniciar con http:// o https:// y permitir descarga directa. No se
soportan redirecciones.
type (string)
Tipo de mensaje que se desea enviar.
Opciones soportadas:
• text: Envía un mensaje de texto plano.
• image: Envía un archivo de imagen (.jpeg, .png).
• audio: Envía un archivo de audio (.acc, .mp3, .amr, .mpeg).
• video: Envía un archivo de video (.mp4, .3gpp).
• document: Envía un archivo de documento (.pdf).
• contacts: Envía información de contacto.
• location: Envía una ubicación con latitud y longitud.
• interactive: Envía un mensaje interactivo con botones o listas.
En este caso, se utiliza el valor image.
caption (string)
Aplica únicamente para el tipo image.
Texto descriptivo de la imagen.
fileName (string)
Aplica únicamente para el tipo document.
Nombre del archivo incluyendo su extensión (.pdf).
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento. El mensaje ha sido
encolado para envío.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.
Envío de Mensaje de Contactos
POST https://getincloud.online/balerion/v3/messages
Si un usuario de WhatsApp ha enviado un mensaje a su aplicación — ya sea como
respuesta a una plantilla previamente enviada o iniciando la conversación — su aplicación
dispone de una ventana de 24 horas para enviar mensajes sin necesidad de usar plantillas.
Estos se conocen como mensajes de sesión.
Los mensajes de contactos permiten enviar información de contacto enriquecida
directamente a los usuarios de WhatsApp, como nombres, números de teléfono, direcciones
físicas y correos electrónicos.
Body Params
Whatsapp Message Request
contacts (array de objetos)
Aplica únicamente para el tipo contacts.
Arreglo que contiene la información del contacto.
Opciones de información de contacto:
• addresses: Direcciones completas del contacto.
• birthday: Fecha de cumpleaños del contacto.
• emails: Direcciones de correo electrónico del contacto.
• name: Nombre completo del contacto formateado.
• org: Información de la organización del contacto.
• phones: Números de teléfono del contacto.
• urls: URLs del contacto.
externalId (string)
Identificador alfanumérico utilizado para fines de reporte.
callbacks (array de strings)
URL de webhook para notificar los eventos del mensaje de WhatsApp.
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje. Los números deben
especificarse en formato E.164 (incluye + y código de país).
type (string)
Tipo de mensaje que se desea enviar.
Opciones soportadas:
• text: Envía un mensaje de texto plano.
• image: Envía un archivo de imagen (.jpeg, .png).
• audio: Envía un archivo de audio (.acc, .mp3, .amr, .mpeg).
• video: Envía un archivo de video (.mp4, .3gpp).
• document: Envía un archivo de documento (.pdf).
• contacts: Envía información de contacto.
• location: Envía una ubicación con latitud y longitud.
• interactive: Envía un mensaje interactivo con botones o listas.
En este caso, se utiliza el valor contacts.
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento. El mensaje ha sido
encolado para envío.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.
Envío de Mensaje de Ubicación
POST https://api.getincloud.online/balerion/v3/messages
Si un usuario de WhatsApp ha enviado un mensaje a su aplicación — ya sea como
respuesta a una plantilla previamente enviada o iniciando la conversación — su aplicación
dispone de una ventana de 24 horas para enviar mensajes sin necesidad de usar plantillas.
Estos se conocen como mensajes de sesión.
Los mensajes de ubicación permiten enviar coordenadas geográficas (latitud y longitud) a
un usuario de WhatsApp.
Body Params
Whatsapp Message Request
location (object)
Aplica únicamente para el tipo location.
Objeto que contiene la información geográfica que se desea compartir.
externalId (string)
Identificador alfanumérico utilizado para fines de reporte.
callbacks (array de strings)
URL de webhook para notificar los eventos del mensaje de WhatsApp.
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje. Los números deben
especificarse en formato E.164 (incluye + y código de país).
type (string)
Tipo de mensaje que se desea enviar.
Opciones soportadas:
• text: Envía un mensaje de texto plano.
• image: Envía un archivo de imagen (.jpeg, .png).
• audio: Envía un archivo de audio (.acc, .mp3, .amr, .mpeg).
• video: Envía un archivo de video (.mp4, .3gpp).
• document: Envía un archivo de documento (.pdf).
• contacts: Envía información de contacto.
• location: Envía una ubicación con latitud y longitud.
• interactive: Envía un mensaje interactivo con botones o listas.
En este caso, se utiliza el valor location.
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento. El mensaje ha sido
encolado para envío.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.
Envío de Mensaje con Botones de Respuesta (Reply Button)
POST https://api.getincloud.online/balerion/v3/messages
Si un usuario de WhatsApp ha enviado un mensaje a su aplicación — ya sea como
respuesta a una plantilla previamente enviada o iniciando la conversación — su aplicación
dispone de una ventana de 24 horas para enviar mensajes sin necesidad de usar plantillas.
Estos se conocen como mensajes de sesión.
Los mensajes interactivos con botones de respuesta permiten enviar hasta tres opciones
predefinidas para que el usuario seleccione una respuesta.
Body Params
Whatsapp Message Request
interactive (object)
Aplica únicamente para el tipo interactive.
Este objeto contiene los detalles del mensaje interactivo, especificando el tipo de
interacción (en este caso, botones de respuesta) y la estructura de botones, encabezado,
cuerpo del mensaje y pie de página.
externalId (string)
Identificador alfanumérico utilizado para fines de reporte.
callbacks (array de strings)
URL de webhook para notificar los eventos del mensaje de WhatsApp.
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje. Los números deben
especificarse en formato E.164 (incluye + y código de país).
type (string)
Tipo de mensaje que se desea enviar.
Opciones soportadas:
• text: Envía un mensaje de texto plano.
• image: Envía un archivo de imagen (.jpeg, .png).
• audio: Envía un archivo de audio (.acc, .mp3, .amr, .mpeg).
• video: Envía un archivo de video (.mp4, .3gpp).
• document: Envía un archivo de documento (.pdf).
• contacts: Envía información de contacto.
• location: Envía una ubicación con latitud y longitud.
• interactive: Envía un mensaje interactivo con botones o listas.
En este caso, se utiliza el valor interactive.
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento. El mensaje ha sido
encolado para envío.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.
Envío de Mensaje Interactivo tipo Lista
POST https://api.getincloud.online/balerion/v3/messages
Si un usuario de WhatsApp ha enviado un mensaje a su aplicación — ya sea como
respuesta a una plantilla previamente enviada o iniciando la conversación — su aplicación
dispone de una ventana de 24 horas para enviar mensajes sin necesidad de usar plantillas.
Estos se conocen como mensajes de sesión.
Los mensajes interactivos tipo lista permiten presentar al usuario de WhatsApp una lista de
opciones para elegir. Estas opciones se definen como filas dentro del payload de la
solicitud.
Body Params
Whatsapp Message Request
interactive (object)
Aplica únicamente para el tipo interactive.
Define el tipo de mensaje interactivo.
• button: Se utiliza para incluir botones de respuesta.
• list: Se utiliza para incluir una lista interactiva.
En este caso, se utiliza el valor list.
externalId (string)
Identificador alfanumérico utilizado para fines de reporte.
callbacks (array de strings)
URL de webhook para notificar los eventos del mensaje de WhatsApp.
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje. Los números deben
especificarse en formato E.164 (incluye + y código de país).
type (string)
Tipo de mensaje que se desea enviar.
Opciones soportadas:
• text: Envía un mensaje de texto plano.
• image: Envía un archivo de imagen (.jpeg, .png).
• audio: Envía un archivo de audio (.acc, .mp3, .amr, .mpeg).
• video: Envía un archivo de video (.mp4, .3gpp).
• document: Envía un archivo de documento (.pdf).
• contacts: Envía información de contacto.
• location: Envía una ubicación con latitud y longitud.
• interactive: Envía un mensaje interactivo con botones o listas.
En este caso, se utiliza el valor interactive.
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento. El mensaje ha sido
encolado para envío.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.
Envío de Flujo Estático
POST https://api.getincloud.online/balerion/v3/messages
Una vez que un Flujo Estático de WhatsApp ha sido publicado, puede ser entregado a los
usuarios finales a través de este endpoint. Este método de entrega está diseñado para
escenarios donde la interacción ocurre dentro de una ventana activa de conversación de 24
horas iniciada por el usuario, siguiendo las mismas reglas de los mensajes de sesión de
WhatsApp, por lo tanto no requiere una plantilla preaprobada.
Body Params
Whatsapp Message Request
interactive (object)
Objeto contenedor que define el payload del mensaje interactivo. Toda la configuración
relacionada con el Flow se define dentro de este objeto.
externalId (string)
Identificador alfanumérico utilizado para fines de reporte.
callbacks (array of strings)
Indica una o más URLs de webhook (separadas por coma) para notificar el estado de
entrega del mensaje.
Si desea recibir el estado del mensaje enviado a sus usuarios, debe especificar su endpoint.
El endpoint debe aceptar método HTTP POST y recibir un cuerpo en formato JSON.
La URL es el callback externo donde se registrarán y publicarán los eventos del mensaje.
Una vez procesado el mensaje, su estado será enviado a la URL configurada.
Para ver la lista completa de estados y su significado, consulte la sección de WhatsApp
Status.
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje. Los números deben
especificarse en formato E.164 (incluye + y código de país).
type (string)
Tipo de mensaje. Para el envío de un Flow, este valor debe establecerse como
interactive.
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento. El mensaje ha sido
encolado para envío.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.
Envío de Flow mediante Plantilla de Mensaje
POST https://api.getincloud.online/balerion/v3/messages
Cuando una plantilla de mensaje de WhatsApp incluye un Flow estático, este se convierte
en parte integral de la definición de la plantilla. Se entrega automáticamente cada vez que
dicha plantilla es enviada a un usuario final.
Este método está diseñado para escenarios de comunicación saliente, donde la empresa
inicia la interacción sin depender de una ventana de conversación activa con el cliente.
Desde la perspectiva de envío, la plantilla actúa como punto de entrada, mientras que el
Flow representa la experiencia interactiva que el usuario inicia al seleccionar el botón de
llamada a la acción (CTA). Una vez que el usuario selecciona el CTA, WhatsApp renderiza
el Flow asociado directamente dentro del chat.
Body Params
Whatsapp Message Request
placeholders (object)
Objeto que contiene los valores personalizados asignados a cada variable definida en el
encabezado, cuerpo del mensaje o ambos.
templateName (string)
Nombre de la plantilla de mensaje creada y aprobada en su cuenta de WhatsApp Business.
templateLanguage (string)
Idioma de la plantilla definido al momento de su creación.
Actualmente la API soporta 3 idiomas: Inglés, Español y Portugués. Es obligatorio si desea
enviar plantillas en un idioma diferente al inglés.
• English: en
• Spanish: es
• Portuguese: pt_BR, pt_PT
externalId (string)
Identificador alfanumérico utilizado para fines de reporte.
callbacks (array of strings)
Indica una o más URLs de webhook (separadas por coma) para notificar el estado de
entrega del mensaje.
Si desea recibir el estado del mensaje enviado a sus usuarios, debe especificar su endpoint.
El endpoint debe aceptar método HTTP POST y recibir un cuerpo en formato JSON.
La URL es el callback externo donde se registrarán y publicarán los eventos del mensaje.
Una vez procesado el mensaje, su estado será enviado a la URL configurada.
Para ver la lista completa de estados y su significado, consulte la sección de WhatsApp
Status.
from (string) required
Número de teléfono del remitente.
El número de teléfono proporcionado durante la configuración de la cuenta WABA se
utilizará como remitente del mensaje de notificación.
Solo acepta caracteres numéricos. No incluir el signo +.
to (string) required
Determina el número de teléfono de destino para el mensaje de plantilla. Los números
deben especificarse en formato E.164 (incluye + y código de país).
Responses
202 Accepted
La solicitud fue aceptada correctamente para su procesamiento. El mensaje ha sido
encolado para envío.
400 Bad Request
La solicitud contiene errores o parámetros inválidos.
401 Unauthorized
Error de autenticación. Credenciales inválidas o token expirado.
410 Gone
El recurso solicitado ya no está disponible.
500 Internal Server Error
Error interno del servidor al procesar la solicitud.