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 "interactive"	String	Obligatorio
listMessages	Lista objetos.	Lista objetos	Obligatorio
replyButtons	Lista objetos.	Lista objetos	Obligatorio
flow	Lista objetos.	Lista objetos	Obligatorio

Lista de mensajes

Objeto listMessages

Nombre	Descripción	Tipo	Requerimientos
headerText	Texto del encabezado.	String	Obligatorio
body	Contiene el texto del mensaje, que puede incluir formato y URL.	String	Obligatorio
footer	El pie de página del mensaje. Se admiten emojis y Markdown.	String	Obligatorio
buttonText	Contenido del botón. No puede ser una cadena vacía y debe ser única dentro del mensaje. No admite ni emojis ni Markdown.	String	Obligatorio
sections	Lista de secciones del mensaje.	Lista objetos	Obligatorio

Objeto sections

Nombre	Descripción	Tipo	Requerimientos
title	Título de la sección.	String	Obligatorio si el mensaje tiene más de una sección.
messages	Lista de mensajes.	Lista objetos	Obligatorio

Botones de réplica

Objeto replyButtons

Nombre	Descripción	Tipo	Requerimientos
headerText	Texto del encabezado.	String	Obligatorio
headerImage	Imágen del encabezado.	Objeto	Obligatorio
headerVideo	Video del encabezado.	Objeto	Obligatorio
headerDocument	Contiene el texto del mensaje, que puede incluir formato y URL.	Objeto	Obligatorio
body	Contiene el texto del mensaje, que puede incluir formato y URL.	String	Obligatorio
footer	El pie de página del mensaje. Se admiten emojis y Markdown.	String	Obligatorio
buttons	Lista objetos	Lista Object	Obligatorio

Objeto headerImage

Nombre	Descripción	Tipo	Requerimientos
link	Liga del archivo.	String	Obligatorio.

Objeto headerVideo

Nombre	Descripción	Tipo	Requerimientos
link	Liga del archivo.	String	Obligatorio.

Objeto headerDocument

Nombre	Descripción	Tipo	Requerimientos
link	Liga del archivo.	String	Obligatorio.
filename	Nombre del archivo.	String	Opcional.

Objeto buttons

Nombre	Descripción	Tipo	Requerimientos
id	Id del botón.	String	Obligatorio.
title	Título de la sección.	String	Obligatorio.

WhatsApp Flows

Objeto flow

Nombre	Descripción	Tipo	Requerimientos
body	El contenido del mensaje	String	Obligatorio
action	La acción que deseas que realice el usuario después de leer el mensaje.	Objeto	Obligatorio

Objeto action

Nombre	Descripción	Tipo	Requerimientos
mode	El flujo puede estar en modo draft (borrador) published (publicado)	String	Opcional. El valor por defecto es "published"
flow_message_version	El valor debe ser “3”.	String	Obligatorio.
flow_id	ID único del Flow proporcionado por WhatsApp.	String	Obligatorio.
flow_token	Texto del botón de llamada a la acción, por ejemplo. "Registrarse".	String	Obligatorio.
flow_cta	El valor debe ser “3”.	String	Obligatorio Límite de caracteres: 20 caracteres (sin emojis).
flow_action	navigate (navegar). Predefinir la primera pantalla como parte del mensaje data_exchange (intercambiar datos). Casos de uso avanzados en los que tu punto de conexión proporciona la primera plantilla.	String	Opcional. El valor por defecto es "published"
flow_action_payload		Objeto	Obligatorio si el flow_action es de tipo “navigate”. En caso contrario, deberá omitirse.

Objeto flowActionPayload

Nombre	Descripción	Tipo	Requerimientos
screen	El ID de la pantalla que se muestra primero.	String	Tiene que ser una pantalla de entrada
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

Whatsapp — Anterior

Siguiente — Whatsapp