Objetos

Last update: 2 days 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 carousel: mensaje de texto único acompañado de un conjunto de hasta 10 tarjetas de carrusel en una vista desplazable horizontalmente limited_time_offer: permiten mostrar fechas de caducidad y temporizadores de cuenta regresiva para códigos de oferta	String	Obligatorio
subtype	quick_reply: Se refiere a un botón de respuesta rápida creado previamente que permite al cliente devolver un mensaje predefinido. URL: se refiere a un botón creado previamente que permite al cliente visitar la URL generada al agregar el parámetro de texto a la URL del prefijo predefinido en la plantilla. catálogo: Se refiere a un botón de catálogo creado previamente que permite al cliente devolver un catálogo de productos completo.	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 action	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
action	No	Si	Si

Texto

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

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

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

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 Flows

Nombre	Descripción	Tipo	Requerimientos
type	El valor es "action".	String	Obligatorio
action	La acción que deseas que realice el usuario después de leer el mensaje.	Object	Obligatorio

Objeto action

Nombre	Descripción	Tipo	Requerimientos
flow_token	Un token que genera el negocio y sirve como identificador.	String	Obligatorio
flow_action_data	Datos de entrada opcionales para la primera pantalla del Flow. Si se proporciona, debe ser un objeto que no esté vacío.	Map<String, Object>	Opcional

Secuencia

Nombre	Descripción	Tipo	Requerimientos
type	El valor es "carrousel".	String	Obligatorio
cards	Una lista de hasta 10 objetos de tipo cards. Las tarjetas en el carrusel deben: Tener un encabezado multimedia (imagen o video) Texto del cuerpo Al menos un botón. Soporta 2 botones. Los botones pueden ser los mismos o una combinación de botones de respuesta rápida, botones de números de teléfono o botones de URL.	Lista objetos	Obligatorio El formato del encabezado multimedia y los tipos de botones deben ser los mismos en todas las tarjetas que componen una plantilla de carrusel.

Objeto card

Nombre	Descripción	Tipo	Requerimientos
card_index	Orden en que la tarjeta aparece dentro de la secuencia de la tarjeta. Se expresa como un índice que comienza en 0, es decir que 0 indica la primera tarjeta; 1, la segunda, etc.	Number	Obligatorio
components	Arreglo de componentes que agregaría a su card. Estos componentes podrían ser de tipo "header", "body" y "button".	Lista objetos	Obligatorio

Cupones

Nombre	Descripción	Tipo	Requerimientos
type	El valor es "button".	String	Obligatorio
subtype	El valor es “COPY_CODE”.	String	Obligatorio
index	Orden en el que el botón aparece en la parte inferior del mensaje de plantilla. Se expresa como un índice que comienza en 0, es decir que 0 indica el primer botón; 1, el segundo, etc.	String	Obligatorio
parameters		Lista objetos	Obligatorio

Objeto parameters

Nombre	Descripción	Tipo	Requerimientos
type	El valor es "coupon_code".	String	Obligatorio
coupon_code	El código del cupón que se copiará cuando el cliente toque el botón.	String	Obligatorio

Oferta por tiempo limitado

Nombre	Descripción	Tipo	Requerimientos
type	El valor es “limited_time_offer”.	String	Obligatorio
limited_time_offer	Objeto en donde se especificará la fecha de expiración de la oferta.	Object	Obligatorio

Objeto limited_time_offer

Nombre	Descripción	Tipo	Requerimientos
expiration_date_time	Define la fecha y hora exactas en que la oferta expira, después de la cual no estará disponible. Este campo debe seguir el formato "YYYY-MM-DD HH:mm" que corresponde a la fecha y la hora local sin la especificación de la zona horaria. Asegúrese de que cualquier sistema que interprete esta fecha entienda que se refiere a una zona horaria específica.	String	Obligatorio

Whatsapp — Anterior

Siguiente — Whatsapp