Formato de proveedores WhatsApp
Esta página ofrece una detallada referencia sobre los formatos JSON destinados a los mensajes de proveedores de WhatsApp. Aquí se presentan todos los tipos de mensajes disponibles, excluyendo texto e imágenes, para su envío. Hasta la fecha, la integración ha sido exitosamente llevada a cabo con Gupshup e Infobip.
- 1 Botones Interactivos
- 1.1 Propiedades
- 1.2 Texto
- 1.3 Documento
- 1.4 Imagen
- 1.5 Video
- 2 Lista de botones interactiva
- 2.1 Propiedades
- 3 Contacto
- 3.1 Propiedades
- 4 Ubicación
- 4.1 Propiedades
- 5 Templates/HSM
Botones Interactivos
Propiedades
Propiedad | Descripción | Requerido |
header | Contiene las propiedades de la parte superior del elemento. | Si |
text | Contiene el texto incluido en la cabecera. | Si* |
imageUrl | Contiene la URL de la imagen en la cabecera. | Si* |
videoUrl | Contiene la URL del video en la cabecera. | Si* |
documentUrl | Contiene la URL de la ubicación del documento. | Si* |
filename | Nombre del archivo para enviar tipo documento. | No |
body | Contiene el texto que aparecerá debajo de la cabecera. | Si |
buttonsList | Contiene un array con los botones. (1-3) | Si |
button | Información del botón.
| Si Si Si |
footer | Contiene el texto que era en el pie del elemento. | No |
*Solo una de estas propiedades es requerida, dependiendo de cuál será el tipo de la cabecera de los botones interactivos. Ej: imageUrl > Tipo Imagen, text > Tipo texto, etc.
Texto
{
"interactiveButtons": {
"header": {
"text": "text"
},
"body": "body text",
"buttonsList": [
{
"id": "1",
"title": "Si"
},
{
"id": "2",
"title": "No"
}
],
"footer": "footer"
}
}Documento
{
"interactiveButtons": {
"header": {
"documentUrl": "https://integraccs.ucontactcloud.com/attachments/20220201/000ESPMarcadores.pdf",
"filename": "Marcadores"
},
"body": "body text",
"buttonsList": [
{
"id": "1",
"title": "Si"
},
{
"id": "2",
"title": "No"
}
],
"footer": "footer"
}
}Imagen
{
"interactiveButtons": {
"header": {
"imageUrl": "https://integraccs.ucontactcloud.com/attachments/20220201/e2f3323a-2cb3-4ff7-9e81-1ff4ce893d26.logo192.png"
},
"body": "body text",
"buttonsList": [
{
"id": "1",
"title": "Si"
},
{
"id": "2",
"title": "No"
}
],
"footer": "footer"
}
}Video
Lista de botones interactiva
Propiedades
Propiedad | Descripción | Requerido |
header | Texto ubicado en la cabecera del elemento. | No |
body | Texto ubicado por debajo de la cabecera. | Si |
buttonMenu | Texto en el botón para abrir el menú. | Si |
sections | Arreglo con las secciones (1-2). | Si |
title | Título para cada sección. | No* |
rows | Arreglo con las diferentes opciones. | Si |
row | Información de cada opción:
| Si
|
footer | Texto ubicado en el pie del elemento. | No |
*Requerido en caso de tener más de una sección.
El rango de opciones de cada sección es de 1-10
Contacto
Propiedades
Propiedad | Descripción | Requerido |
firstName | Primer nombre. | Si |
lastName | Apellido. | No |
middleName | Nombre del medio. | No |
formattedName | Nombre y apellido sin espacio. | Si |
namePrefix | Prefijo usado en el nombre. | No |
birthday | Fecha de nacimiento. | No |
phones | Arreglo con los distintos teléfonos. | No |
phone | Número y tipo del teléfono.
| No |
emails | Arreglo con los distintos emails. | No |
Dirección de correo y el tipo.
| No | |
addresses | Arreglo con los distintas direcciones. | No |
address | Información de cada dirección.
| No |
org | Información de la organización donde trabaja.
| No |
urls | Arreglo con los diferentes URLs. | No |
url |
| No |
Ubicación
Propiedades
Propiedad | Descripción | Requerido |
address | Dirección del lugar en el mapa: calle y ciudad. | No |
name | Nombre del lugar. | No |
latitude | Coordenada específica norte-sur. | Si |
longitude | Coordenada específica este-oeste. | Si |
Templates/HSM
Propiedades
Propiedad | Descripción | Requerido |
name | Nombre o id del template aprobado por WhatsApp. | Si |
type | Tipo del template. | Si |
language | Lenguaje del template. | Si |
contentHeader | Texto incluido en la cabecera. | Si(1) |
latitude | Coordenada específica norte-sur. | Si(2) |
longitude | Coordenada específica este-oeste. | Si(2) |
filename | Nombre del documento. | No(3) |
placeholders | Arreglo con las variables en el texto del template. | Si(4) |
buttonType | Tipo de botón (URL o QUICK_REPLY). | Si(4) |
buttonsList | Arreglo con variables para el texto en el botón. | Si(4) |
1: Dependiendo el tipo, Ej: en caso de imagen debe ir la URL de la imagen.
2: Requerido si el tipo es location.
3: En caso de dejarlo vacío el nombre será “null”.
4: Requerido si el template contiene variables o botones, debe ser el número exacto de elementos en el array.