Objetos

Last update: 2 years ago by Irais Aguirre

Estructura general

Nombre	Descripción	Tipo	Requerimientos
from	Teléfono (con código de país) del que se enviará el mensaje.	Number	Obligatorio
to	Identificador de WhatsApp devuelto por el servicio contacts.	String	Obligatorio
type	El valor por defecto es "template"	String	Obligatorio
template	Objeto que contiene las propiedades de la plantilla	Objeto	Obligatorio

Objeto template

Nombre	Descripción	Tipo	Requerimientos
language	Lenguaje local, Ejemplo: es_ES, es_MX, es_US	String	Oblicatorio
name	Nombre de la plantilla	String	Obligatorio
components	Objecto que contiene la configuracion de la plantilla	Objeto	Opcional

Objeto components

Nombre	Descripción	Tipo	Requerimientos
type	Tipo de componente. Los valores pueden ser: header: encabezado de la plantilla. body: cuerpo de la plantilla. button: botones para acciones de la plantilla	String	Obligatorio
subtype	Subtipo del componente. Solo puede tener el valor quick_reply y es utilizado para botones de repuestas rápidas.	String	Es obligatorio cuando se utiliza con el tipo button.
index	Indice para los parametros de tipo payload.	String	Opcional Se utiliza con el tipo button Los valores del index pueden ser: 0,1,2
parameters	Arreglo de tipos de Plantilla. Los valores pueden ser: text currency date_time image document video location payload	Array	Obligatorio

Relación de Tipos de Parámetros vs Tipos de Componente

Tipos de Parámetro	header	body	button
text	Si	Si	No
currency	Si	Si	No
date_time	Si	Si	No
image	Si	No	No
document	Si	No	No
video	Si	No	No
location	Si	No	No
payload	No	No	Si

Objeto texto

Nombre	Descripción	Tipo	Requerimientos
type	El valor es “text”.	String	Obligatorio

Objeto currency

Nombre	Descripción	Tipo	Requerimientos
type	El valor es “currency”.	String	Obligatorio
fallback_value	En caso de que no se reconozca el código de moneda, se utilizará el valor de fallback_value.	String	Opcional
code	Código de moneda (ISO 4217).	String	Opcional
amount	Monto.	Number	Opcional

Objeto date time

Nombre	Descripción	Tipo	Requerimientos
type	El valor es “date_time”.	String	Obligatorio
fallback_value	En caso de que no se reconozca la fecha, se utilizará el valor de fallback_value.	String	Obligatorio
day_of_month	Día del mes.	Number	Obligatorio
year	Año.	Number	Opcional
month	Mes.	Number	Opcional
hour	Hora.	Number	Opcional
minute	Minuto.	Number	Opcional

Contenido multimedia

Objeto image

Nombre	Descripción	Tipo	Requerimientos
type	El valor es “image”.	String	Obligatorio
link	URL de la imágen.	String	Obligatorio

Objeto document

Nombre	Descripción	Tipo	Requerimientos
type	El valor es “document”.	String	Obligatorio
link	URL del documento.	String	Obligatorio
caption	Descripción del documento.	String	Opcional. El tamaño máximo es de 178 caracteres.
filename	Nombre del archivo del documento.	String	Obligatorio

Objeto video

Nombre	Descripción	Tipo	Requerimientos
type	El valor es “video”.	String	Obligatorio
link	URL de la video.	String	Obligatorio

Objeto location

Nombre	Descripción	Tipo	Requerimientos
type	El valor es “location”.	String	Obligatorio
longitude	Valor de la Longitud.	Number	Obligatorio.
latitude	Valor de la Latitud.	Number	Obligatorio.
name	Nombre de la ubicación.	String	Opcional.
address	Dirección de la ubicación.	String	Opcional.

Botones

Nombre	Descripción	Tipo	Requerimientos
type	El valor es “payload”.	String	Obligatorio
payload	Descripción del botón para respuesta rápida.	String	Opcional. Se utiliza con el tipo de parámetro payload. Se utiliza en el componente button. El tamaño máximo es de 128 caracteres.

Whatsapp — Anterior

Siguiente — Whatsapp