logo

Objetos

Last update: a month ago by Irais Aguirre

Texto

NombreDescripciónTipoRequerimientos
fromTeléfono (con código de país) del que se enviará el mensaje.StringObligatorio.
toTeléfono (con código de país) del cliente al que se le envía el mensaje. Se admiten signos más (+), guiones (-), paréntesis ((,)) y espacios.StringObligatorio.
typeEl valor por defecto es “text”.StringObligatorio.
textTexto del mensajeString
  • Obligatorio.
  • La longitud máxima es de 4096 caracteres.

Texto con vista previa de URL

NombreDescripciónTipoRequerimientos
fromTeléfono (con código de país) del que se enviará el mensaje.StringObligatorio.
toTeléfono (con código de país) del cliente al que se le envía el mensaje. Se admiten signos más (+), guiones (-), paréntesis ((,)) y espacios.StringObligatorio.
typeEl valor por defecto es “text”.StringObligatorio.
textTexto del mensaje.String
  • Obligatorio.
  • La longitud máxima es de 4096 caracteres
preview_urlAgregar una URL de vista previa.StringObligatorio.

Contenido multimedia

NombreDescripciónTipoRequerimientos
fromTeléfono (con código de país) del que se enviará el mensaje.StringObligatorio.
toTeléfono (con código de país) del cliente al que se le envía el mensaje. Se admiten signos más (+), guiones (-), paréntesis ((,)) y espacios.StringObligatorio.
typeEl valor por defecto es document. Los valores podrán ser: audio, document, image, sticker y video.StringObligatorio.
linkLiga del archivo.StringObligatorio.
filenameNombre del archivo.String
  • Opcional.
  • Solo se usa en el objeto document.
captionDescripción del archivoString
  • Opcional si type es document
  • No debe usarse para audio ni sticker.

Ubicación

NombreDescripciónTipoRequerimientos
fromTeléfono (con código de país) del que se enviará el mensaje.StringObligatorio.
toTeléfono (con código de país) del cliente al que se le envía el mensaje. Se admiten signos más (+), guiones (-), paréntesis ((,)) y espacios.StringObligatorio.
typeEl valor por defecto 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.

Contactos

NombreDescripciónTipoRequerimientos
fromTeléfono (con código de país) del que se enviará el mensaje.StringObligatorio.
toTeléfono (con código de país) del cliente al que se le envía el mensaje. Se admiten signos más (+), guiones (-), paréntesis ((,)) y espacios.StringObligatorio.
typeEl valor por defecto es “location”.StringObligatorio
contactsVObjeto que contiene los datos del contacto.ObjectObligatorio.

Objeto contacts

NombreDescripciónTipoRequerimientos
birthdayFecha de nacimiento del Contacto.StringOpcional.
addressesObjeto que contiene las direcciones del ContactoObjectOpcional.
emailsObjeto que contiene los emails del ContactoObjectOpcional.
nameObjeto que contiene el nombre del Contacto.ObjectObligatorio.
orgObjeto que contiene la compañía del Contacto.ObjectOpcional.
phonesObjeto que contiene los teléfonos del Contacto.ObjectOpcional.
urlsObjeto que contiene las URLs del Contacto.ObjectOpcional.

Objeto addresses

NombreDescripciónTipoRequerimientos
cityCiudad.StringOpcional.
countryPaís.StringOpcional.
stateEstado.StringOpcional.
streetCalle.StringOpcional.
typeLos valores podrán ser: WORK, HOME.StringOpcional.
zipCódigo Postal.StringOpcional.

Objeto emails

NombreDescripciónTipoRequerimientos
emailCorreo del Contacto.StringOpcional.
typeLos valores podrán ser: WORK.StringOpcional.

Objeto name

NombreDescripciónTipoRequerimientos
first_nameNombre del Contacto.StringObligatorio si middle_name y last_name no tienen valor.
middle_nameSegundo nombre del contacto.StringObligatorio si first_name y last_name no tienen valor.
last_nameApellido del Contacto.StringObligatorio si middle_name y first_name no tienen valor.
formatted_nameNombre Completo.StringObligatorio.

Objeto org

NombreDescripciónTipoRequerimientos
companyNombre de la compañía.StringObligatorio

Objeto phones

NombreDescripciónTipoRequerimientos
phoneTeléfono del Contacto.StringObligatorio.
typeLos valores podrán ser: WORK, HOME.StringObligatorio.

Objeto urls

NombreDescripciónTipoRequerimientos
urlURL del contacto.StringObligatorio.
typeLos valores podrán ser: WORK.StringObligatorio.

Responder a un mensaje

NombreDescripciónTipoRequerimientos
fromTeléfono (con código de país) del que se enviará el mensaje.StringObligatorio.
toTeléfono (con código de país) del cliente al que se le envía el mensaje. Se admiten signos más (+), guiones (-), paréntesis ((,)) y espacios.StringObligatorio.
typeEl valor por defecto es “text”.StringObligatorio.
contextObjeto que contiene información relacionada de un mensaje.ObjectObligatorio.

Objeto context

NombreDescripciónTipoRequerimientos
message_idId del mensaje a responder.StringObligatorio.

Reacción

NombreDescripciónTipoRequerimientos
fromTeléfono (con código de país) del que se enviará el mensaje.StringObligatorio.
toTeléfono (con código de país) del cliente al que se le envía el mensaje. Se admiten signos más (+), guiones (-), paréntesis ((,)) y espacios.StringObligatorio.
typeEl valor por defecto es “reaction”.StringObligatorio.
reactionObjeto que contiene información relacionada de un mensaje.ObjectObligatorio.

Objeto reaction

NombreDescripciónTipoRequerimientos
message_idId del mensaje a responder.StringObligatorio.
emojiEmoticón a enviar.StringObligatorio.

Enviar solicitud de permiso de llamada

NombreDescripciónTipoRequerimientos
fromTeléfono (con código de país) del que se enviará el mensajeStringObligatorio
toTeléfono (con código de país) del cliente al que se le envía el mensaje. Se admiten signos más (+), guiones (-), paréntesis ((,)) y espaciosStringObligatorio
typeTipo de mensaje. El valor es “interactive”StringObligatorio
call_permission_requestObjeto para enviar mensajes con FlowObjeto call_permission_request

Objeto call permission request

NombreDescripciónTipoRequerimientos
actionLa acción del mensaje interactivoObjeto actionObligatorio
bodyEl contenido del mensajeStringObligatorio

Objeto action

NombreDescripciónTipoRequerimientos
nameNombre de la acción Valor: call_permission_requestStringObligatorio

Solicitud de Ubicación

NombreDescripciónTipoRequerimientos
fromTeléfono (con código de país) del que se enviará el mensaje.StringObligatorio.
toTeléfono (con código de país) del cliente al que se le envía el mensaje. Se admiten signos más (+), guiones (-), paréntesis ((,)) y espacios.StringObligatorio.
typeEl valor por defecto es “interactive”.StringObligatorio.
interactiveObjeto que contiene información relacionada de un mensaje.ObjectObligatorio.
send_location_requestObjeto que contiene el envío de ubicación.ObjectObligatorio.
bodyTexto simple del mensaje.StringObligatorio.
actionLa acción que deseas que realice el usuario.ObjectObligatorio.
Whatsapp — Anterior
Conexión HTTP
Siguiente
Ejemplos