POST
https://api.getincloud.online/balerion/v3/messagesEnviar plantilla de mensaje multimedia
Envía una plantilla multimedia de WhatsApp aprobada, con encabezado, botones y marcadores.
API de Mensajería
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
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.
POST https://api.getincloud.online/balerion/v3/messagesParámetros del cuerpo (Whatsapp Message Request)
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| placeholders | object | No | Aplica únicamente si el tipo BODY contiene campos personalizados. Objeto de campos personalizados que contienen el cuerpo del mensaje de texto. Establece como parámetro el marcador configurado dentro de llaves dobles {{...}} al crear la plantilla y asigna el valor correspondiente. Los marcadores deben estar en el mismo orden en que se creó la plantilla. Ejemplo: para "Here is your {{code}}", establece code: 34871. |
| templateName | string | No | Nombre de la plantilla creada en tu cuenta de WhatsApp Business. |
| templateLanguage | string | No | Idioma de la plantilla definido al momento de su creación. La API soporta inglés, español y portugués. Es obligatorio si deseas enviar plantillas en un idioma diferente al inglés. |
| from | string | Sí | Número de teléfono del remitente. El número proporcionado durante la configuración de la cuenta WABA se utilizará como remitente. Solo acepta caracteres numéricos. No incluir el signo +. |
| to | string | Sí | Número de teléfono de destino. Formato E.164 (incluye + y código de país). |
| templateId | string | No | Identificador único de la plantilla. |
| callbacks | array de strings | No | Sin descripción adicional en el manual. |
| templateHeader | object | No | Aplica únicamente si la plantilla contiene el tipo HEADER con un campo personalizado en el encabezado de texto o una URL basada en el tipo de encabezado multimedia seleccionado (imagen, video, documento). Objeto de campos personalizados o URL que contiene el tipo de encabezado definido al crear la plantilla. |
| templateButtons | array | No | Aplica únicamente si la plantilla contiene el tipo BUTTONS con URL dinámica o botones de respuesta rápida (Quick Reply). Si el botón es Call To Action, es obligatorio cuando contiene una URL dinámica. Si es Quick Reply, es obligatorio cuando contiene un payload o palabras clave. Arreglo con el valor del sufijo de URL (placeholder) para botones Call To Action con URL dinámica, y los payloads o palabras clave de los botones Quick Reply definidos al crear la plantilla. |
Idiomas soportados
- English:
en - Spanish:
es - Portuguese:
pt_BR,pt_PT
Ejemplo del manual
El manual incluye este curl de ejemplo. Corresponde a la creación de una plantilla con marcador en el cuerpo (endpoint de plantillas), tal cual figura en el documento:
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"
]
]
}
}
]
}
]
}Respuestas
| Código | Descripción |
|---|---|
| 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. |
¿Te sirvió esta página?