logo

Objetos

Last update: a year ago by Irais Aguirre

Estructura general

NombreDescripciónTipoRequerimientos
fromTeléfono (con código de país) del que se enviará el mensaje.NumberObligatorio
toIdentificador de WhatsApp devuelto por el servicio contacts.StringObligatorio
typeEl valor por defecto es "template"StringObligatorio
templateObjeto que contiene las propiedades de la plantillaObjetoObligatorio

Objeto template

NombreDescripciónTipoRequerimientos
languageLenguaje local, Ejemplo: es_ES, es_MX, es_USStringOblicatorio
nameNombre de la plantillaStringObligatorio
componentsObjecto que contiene la configuracion de la plantillaObjetoOpcional

Objeto components

NombreDescripciónTipoRequerimientos
typeTipo de componente. Los valores pueden ser:
  • header: encabezado de la plantilla.
  • body: cuerpo de la plantilla.
  • button: botones para acciones de la plantilla
StringObligatorio
subtypeSubtipo del componente. Solo puede tener el valor quick_reply y es utilizado para botones de repuestas rápidas.StringEs obligatorio cuando se utiliza con el tipo button.
indexIndice para los parametros de tipo payload.String
  • Opcional
  • Se utiliza con el tipo button
  • Los valores del index pueden ser: 0,1,2
parametersArreglo de tipos de Plantilla. Los valores pueden ser:
  • text
  • currency
  • date_time
  • image
  • document
  • video
  • location
  • payload
ArrayObligatorio

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

Tipos de Parámetroheaderbodybutton
textSiSiNo
currencySiSiNo
date_timeSiSiNo
imageSiNoNo
documentSiNoNo
videoSiNoNo
locationSiNoNo
payloadNoNoSi

Objeto texto

NombreDescripciónTipoRequerimientos
typeEl valor es “text”.StringObligatorio

Objeto currency

NombreDescripciónTipoRequerimientos
typeEl valor es “currency”.StringObligatorio
fallback_valueEn caso de que no se reconozca el código de moneda, se utilizará el valor de fallback_value.StringOpcional
codeCódigo de moneda (ISO 4217).StringOpcional
amountMonto.NumberOpcional

Objeto date time

NombreDescripciónTipoRequerimientos
typeEl valor es “date_time”.StringObligatorio
fallback_valueEn caso de que no se reconozca la fecha, se utilizará el valor de fallback_value.StringObligatorio
day_of_monthDía del mes.NumberObligatorio
yearAño.NumberOpcional
monthMes.NumberOpcional
hourHora.NumberOpcional
minuteMinuto.NumberOpcional

Contenido multimedia

Objeto image

NombreDescripciónTipoRequerimientos
typeEl valor es “image”.StringObligatorio
linkURL de la imágen.StringObligatorio

Objeto document

NombreDescripciónTipoRequerimientos
typeEl valor es “document”.StringObligatorio
linkURL del documento.StringObligatorio
captionDescripción del documento.String
  • Opcional.
  • El tamaño máximo es de 178 caracteres.
filenameNombre del archivo del documento.StringObligatorio

Objeto video

NombreDescripciónTipoRequerimientos
typeEl valor es “video”.StringObligatorio
linkURL de la video.StringObligatorio

Objeto location

NombreDescripciónTipoRequerimientos
typeEl valor es “location”.StringObligatorio
longitudeValor de la Longitud.NumberObligatorio.
latitudeValor de la Latitud.NumberObligatorio.
nameNombre de la ubicación.StringOpcional.
addressDirección de la ubicación.StringOpcional.

Botones

NombreDescripciónTipoRequerimientos
typeEl valor es “payload”.StringObligatorio
payloadDescripció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
Conexión HTTP
Siguiente — Whatsapp
Ejemplos