Tipos de mensajes de WhatsApp

Aquí está la lista de tipos de mensajes soportados que se pueden enviar con WhatsApp On-Premise:

Texto

Mensaje de texto de WhatsApp

{
  "type": "TEXT",
  "text": "¡Hola Mundo!",
}

Copiar

Propiedad	Descripción	Obligatorio
type	TEXT	S
text	Cadena; limitado a 2000 caracteres	S

Imagen

Imagen de WhatsApp

{
  "type": "IMAGE",
  "text": "¡Soy Sanuker!",
  "attachment_id": "289832336612941",
}

Copiar

Propiedad	Descripción	Obligatorio
type	IMAGE	S
text	Cadena; leyenda para la imagen	N
attachment_id	ID del medio de la imagen	S (o url)
url	URL de la imagen	S (o attachment_id)

consejo

La imagen debe ser un formato de archivo de imagen válido: .jpeg o .png
La imagen debe ser 8 bits, RGB o RGBA
El tamaño máximo de archivo es 5MB

Audio

Mensaje de audio de WhatsApp

{
  "type": "AUDIO",
  "attachment_id": "668795277867495"
}

Copiar

Propiedad	Descripción	Obligatorio
type	AUDIO	S
attachment_id	ID del medio del audio	S (o url)
url	URL del audio	S (o attachment_id)

consejo

El audio debe ser un formato de archivo de audio válido, incluyendo .aac, mp4, mpeg, amr, ogg (solo códecs opus, base ogg no es soportado)
El tamaño máximo del archivo es 16MB

Video

Video de WhatsApp

{
  "type": "VIDEO",
  "attachment_id": "496729438556614",
  "text": "TEXT"
}

Copiar

Propiedad	Descripción	Obligatorio
type	VIDEO	S
text	Cadena; leyenda para el video	N
attachment_id	ID del medio del video	S (o url)
url	URL del video	S (o attachment_id)

consejo

El video debe ser un formato válido de archivo de video, incluyendo mp4 y 3gp.
El tamaño máximo del archivo es 16MB.
Solo soporta el códec de video H.264 y el códec de audio AAC.
Soporta video con un solo canal de audio o sin canal de audio

Sticker

Sticker de WhatsApp

{
  "type": "STICKER",
  "attachment_id": "1030335650902052"
}

Copiar

Propiedad	Descripción	Obligatorio
type	VIDEO	S
url	URL del sticker	S (o attachment_id)
attachment_id	ID del medio del sticker	S (o url)

consejo

El formato de imagen debe ser en webp y de 512x512 px en dimensiones
El tamaño máximo del archivo para sticker estático: 100KB
El tamaño máximo del archivo para sticker animado: 500KB

Archivo

Archivo de WhatsApp

{
  "type": "FILE",
  "filename": "TEXT",
  "attachment_id": "496729438556614"
}

Copiar

Propiedad	Descripción	Obligatorio
type	FILE	S
filename	Cadena; nombre de vista previa del archivo	N
url	URL del archivo	S (o attachment_id)
attachment_id	ID del medio del archivo	S (o url)

consejo

El archivo debe ser un formato válido de archivo, incluyendo plain, pdf, vnd.ms-powerpoint, msword1, vnd.ms-excel, vnd.openxmlformats-officedocument.wordprocessingml.document, vnd.openxmlformats-officedocument.presentationml.presentation, vnd.openxmlformats-officedocument.spreadsheetml.sheet.
El tamaño máximo del archivo es 100MB

Ubicación

Ubicación de WhatsApp

{
  "type": "LOCATION",
  "location": {
    "name": "Compañía ABC",
    "address": "Sala C, 1/F, Edificio DFG, 101 Rainbow Road",
    "lat": "22.31586918460027",
    "long": "114.20883121469535"
  }
}

Copiar

Propiedad	Descripción	Obligatorio
type	LOCATION	S
name	Cadena; nombre de la ubicación	N
address	Cadena; dirección de la ubicación	N
lat	Latitud	S
long	Longitud	S

Contacto

{
  "type": "CONTACTS",
  "contacts": [
    {
      "id": "YXpJfusT",
      "name": {
        "formatted_name": "John Lee",
        "first_name": "John",
        "last_name": "Lee",
        "prefix": "Sr"
      },
      "addresses": [
        {
          "type": "work",
          "city": "Hong Kong",
          "street": "Rainbow Road 131, Edificio ABC"
        }
      ],
      "emails": [
        {
          "type": "work",
          "email": "workmail123@gmail.com"
        }
      ],
      "phones": [
        {
          "type": "main",
          "phone": "+1 413-252-1446",
          "wa_id": "14132521446"
        }
      ],
      "urls": [
        {
          "type": "work",
          "url": "www.sanuker.com"
        }
      ],
      "org": {
        "company": "Sanuker"
      }
    }
  ]
}

Copiar

Propiedad	Descripción	Obligatorio
name	Cadena; nombre del contacto	S
address	Cadena; dirección del contacto	N
birthday	Cadena; fecha	N
emails	Cadena; dirección de correo electrónico	N
org	Cadena; nombre de la empresa	N
phones	Cadena; número de teléfono	N
urls	Cadena; url	N

NOTA

Dentro del objeto phones, los campos phone y wa_id deben ser rellenados para que WhatsApp lo reconozca como una cuenta comercial válida para contactar.

De lo contrario, solo se mostrará el texto "Invitar a WhatsApp".

"phones": [
  {
    "type": "main",
    "phone": "+1 413-252-1446",
    "wa_id": "14132521446"
  }
]

Copiar

Cada objeto en Contact contiene uno o múltiples parámetros opcionales, puedes referirte a aquí para más detalles.

Reacción

Reacción de WhatsApp

{
  "type": "REACTION",
  "message_id": "wamid.HBgLODUyNTQwNjM1OTgVAgASGBQzRUIwOTVERkZCRDIwODg5REQwMAA=",
  "emoji": "😊"
},

Copiar

Propiedad	Descripción	¿Obligatorio?
type	REACTION	S
message_id	El ID para identificar el mensaje al que se reacciona	S
emoji	El emoji usado como reacción; la entrada puede ser el emoji mismo o en Unicode escapado, por ejemplo `\uD83D\uDE0A`	S

NOTA

El ID del mensaje previo se puede obtener desde el evento de mensaje en los registros o utilizando el ApiScope.chat en la API abierta.

Por ejemplo:

query chat {
    apiViewer{
        conversationHistory (first: 10, platform: "whatsapp-cloud", memberId: "999abe6524f9db0009963008") {
            edges{
                node{
                    memberId
                    messageEvent
                }
            }
        }
    }
}

Copiar

Mensajes interactivos

Los mensajes interactivos permiten a los usuarios responder rápidamente proporcionando botones en los que hacer clic. Los usuarios no pueden seleccionar más de una opción al mismo tiempo de una lista o mensaje de botones, pero pueden volver atrás y reabrir un mensaje previo.

Mensajes de lista

Mensaje de lista - 1

Mensaje de lista - 2

{
  "type": "WHATSAPP_LIST",
  "header": {
    "type": "text",
    "text": "Hola 👋🏻"
  },
  "body": {
    "text": "Sanuker ofrece soluciones de chatbot."
  },
  "footer": {
    "text": "Socio oficial de negocios de Facebook y WhatsApp"
  },
  "action": {
    "button": "Menú",
    "sections": [
      {
        "title": "título de la sección",
        "rows": [
          {
            "payload": "SALUDOS",
            "title": "Menú principal",
            "description": "¡Hola!"
          },
          {
            "payload": "ACERCA_DE_SANUKER",
            "title": "Acerca de Sanuker",
            "description": "¿Quién eres?"
          }
        ]
      }
    ]
  }
}

Copiar

Propiedad	Descripción	¿Obligatorio?
Header	El encabezado de tu mensaje de lista, solo se permite texto para mensajes de lista	N
Body	El contenido del cuerpo del mensaje (Máximo 1024 caracteres)	S
Footer	El contenido del pie de página (Máximo 60 caracteres)	N
Action	Dentro de action, debes incluir: - un campo button con el contenido de tu botón, y - al menos un objeto sección (máximo 10) Dentro de la sección, debes añadir al menos un objeto rows	S

action Objeto

Propiedad	Descripción	¿Obligatorio?
button	Contenido del botón. No puede ser una cadena vacía y debe ser único dentro del mensaje (Máximo 20 caracteres)	S
sections	Arreglo de objetos sección. Mínimo 1, máximo 10	S

section Objeto

Propiedad	Descripción	¿Obligatorio?
title	Título de la sección	S (si el mensaje tiene más de una sección.)
rows	Contiene una lista de filas. Cada fila debe tener un título y un ID. Puedes añadir una descripción, pero es opcional	S

Botones de respuesta

Botón de respuesta

{
  "type": "WHATSAPP_REPLY_BUTTONS",
  "header": {
    "type": "image",
    "image": {
      "id": "2e5a7aad-e8c7-43ba-ad5e-b298bb32f8af"
    }
  },
  "body": {
    "text": "Sanuker ofrece soluciones de chatbot."
  },
  "footer": {
    "text": "Socio oficial de negocios de Facebook y WhatsApp"
  },
  "action": {
    "buttons": [
      {
        "type": "reply",
        "reply": {
          "payload": "SALUDOS",
          "title": "Menú principal"
        }
      },
      {
        "type": "reply",
        "reply": {
          "payload": "ACERCA_DE_SANUKER",
          "title": "Acerca de Sanuker"
        }
      }
    ]
  }
}

Copiar

Propiedad	Descripción	Obligatorio
Header	El encabezado de tu mensaje de lista; puede ser texto o multimedia: "Imagen", "Video", "Documento"	N
Body	El contenido del cuerpo del mensaje (Máximo 1024 caracteres)	S
Footer	El contenido del pie de página (Máximo 60 caracteres)	N
Action	Debes añadir al menos un botón, e incluir tipo y título. No puedes añadir más de 3 botones	S

action Objeto

Propiedad	Descripción	¿Obligatorio?
buttons	Un botón puede contener los siguientes parámetros: type: el único tipo soportado es reply (para mensajes de botón de respuesta) title: Título del botón. No puede ser una cadena vacía y debe ser único dentro del mensaje (Máximo 20 caracteres)	S

Mensaje de producto único

{
  "type": "PRODUCT",
  "action": {
    "type": "single",
    "catalog_id": "1134377510532066",
    "product_retailer_id": "03-Pack"
  },
  "body": {
    "text": "Consulta nuestra Bolsa del Día"
  }
}

Copiar

Propiedad	Descripción	Obligatorio
body	El contenido del cuerpo del mensaje (Máximo 1024 caracteres)	N
footer	El contenido del pie de página (Máximo 60 caracteres)	N
action	Debe contener - Debe ser `single` para mensaje de producto único. - `catalogId`: un ID para el catálogo que deseas usar para este mensaje. Obtén este ID a través del Commerce Manager. - `productId`: un identificador único del producto (ID de contenido).	S

Mensaje de múltiples productos

consejo

El mensaje de múltiples productos solo puede contener una selección de hasta 30 productos del inventario.

{
  "type": "PRODUCT",
  "header": {
    "type": "text",
    "text": "Colección de otoño"
  },
  "action": {
    "type": "multi",
    "catalog_id": "1134377510532066",
    "sections": [
      {
        "title": "Esenciales urbanos",
        "product_items": [
          "01-Pack",
          "02-Bolso"
        ]
      },
      {
        "title": "Esenciales para senderismo",
        "product_items": [
          "03-Pack"
        ]
      }
    ]
  },
  "body": {
    "text": "Haz clic en ver artículos para ver nuestra Colección de otoño"
  }
}

Copiar

Propiedad	Descripción	Obligatorio
header	`type` debe ser `text`. Contiene un objeto de texto con el contenido deseado	S
body	El contenido del cuerpo del mensaje (Máximo 1024 caracteres)	S
footer	El contenido del pie de página (Máximo 60 caracteres)	N
action	Debe contener - Debe ser `multi` para mensaje de múltiples productos. - `catalogId`: un ID para el catálogo que deseas usar para este mensaje. Obtén este ID a través del Commerce Manager. - `sections`: arreglo de objetos sección. Debes incluir al menos una sección	S

sections campo:

Propiedad	Descripción	Obligatorio
title	un título para cada sección	S
product_items	`product_retailer_id`: identificador único del producto (ID de contenido)	S

Plantilla de mensaje de WhatsApp

{
  "type": "TEMPLATE",
  "components": [
    {
      "parameters": [
        {
          "image": {
            "id": "57ec1287-6915-4a44-8dc9-9caa620385e1"
          },
          "type": "image"
        }
      ],
      "type": "header"
    },
    {
      "type": "body",
      "text": "Este es el contenido del cuerpo de la plantilla"
    }
  ],
  "languagePolicy": "deterministic",
  "languageCode": "en",
  "namespace": "bc3ac5dd_6dfd_2345_d5f7_123456789bf",
  "elementName": "multiple_button_test_1",
  "accountId": "1234567890"
}

Copiar

Detalles de la plantilla

Propiedad	Descripción	¿Obligatorio?
Nombre	Solo puede contener caracteres alfanuméricos en minúscula y guiones bajos (_); no se permiten otros caracteres ni espacios en blanco	S
Categoría	Selecciona la categoría correcta para tu plantilla; Consulta la lista de categorías soportadas	S
Idioma	Selecciona el idioma correcto para tu plantilla; El nombre de la plantilla será el mismo para todas las traducciones; Especificarás el campo idioma al enviar la plantilla; Consulta la lista de idiomas soportados	S
Contenido	El contenido de tu plantilla de mensaje; Soporta marcadores de parámetros en formato `{{1}}`	S
Encabezado	El encabezado de tu plantilla de mensaje; Puede ser texto o multimedia: "Imagen", "Video", "Documento"	N
Cuerpo	El cuerpo de tu plantilla de mensaje (Límite de caracteres: 1024)	S
Pie de página	El pie de texto de tu plantilla de mensaje	N
Botones	El/los botón(es) de tu plantilla de mensaje; Llamado a la acción o Respuesta rápida; máximo 3 botones.	N

Límite máximo de caracteres

Propiedad	Límite de caracteres
Cuerpo (Sin encabezado/pie de página)	Hasta 1024 caracteres
Cuerpo (Con encabezado/pie de página)	Hasta 160 caracteres
Encabezado	60 caracteres
Pie de página	60 caracteres

Por favor, ten en cuenta que, dentro de una plantilla de mensaje de WhatsApp, el límite de caracteres no se aplica a la variable.

Procedimiento de configuración

Abre "Response Builder" y elige el tipo de respuesta "Plantilla de mensaje de WhatsApp".

Crear una respuesta de plantilla de mensaje de WhatsApp

Elige cualquier "Plantilla de mensaje" existente. Asegúrate de haber completado el proceso de Envío de plantilla de mensaje para poder ver tus plantillas existentes.
Configura la Política de idioma como Determinística.
Elige el Idioma de tu Plantilla de mensaje.

Consulta las configuraciones opcionales a continuación:

Agrega el payload si tu Plantilla de mensaje tiene un botón de Respuesta rápida.

Agregar botones de payload a plantilla de mensaje de WhatsApp

Agrega Media ID o url si tu Encabezado tiene archivos multimedia como imagen o video.

Agregar multimedia a plantilla de mensaje de WhatsApp

Responder a

Puedes enviar un mensaje como respuesta a un mensaje previo en la conversación. El mensaje previo será citado en el globo contextual y se mostrará junto con el mensaje de respuesta.

Al enviar cualquier mensaje a un usuario de WhatsApp, debes añadir la propiedad reply_to e identificar el mensaje contextual con el ID de mensaje

{
  "type": "TEXT",
  "text": "¡Hola! ¿Cómo va?",
  "reply_to": "wamid.HBgLODUyNTQwNjM1OTgVAgASGBQzRUIwQjBGOTBBREU1QTgzQkRFQwA="
}

Copiar

Propiedad	Descripción	Obligatorio
reply_to	ID de mensaje del mensaje al que se responde	S

NOTAS

Solo los mensajes de 30 días o menos pueden ser citados en el globo contextual. De lo contrario, el mensaje se enviará normalmente en lugar de como una respuesta.
Los destinatarios no verán el globo contextual si el mensaje de respuesta es una plantilla de mensaje.
Los destinatarios en KaiOS no verán el globo contextual si el mensaje de respuesta es una imagen, video, audio o PTT.
El ID de mensaje de un mensaje previo se puede obtener desde el evento de mensaje en los registros o usando ApiScope.chat en la API abierta.

Por ejemplo:

query chat {
    apiViewer{
        conversationHistory (first: 10, platform: "whatsapp-cloud", memberId: "999abe6524f9db0009963008") {
            edges{
                node{
                    memberId
                    messageEvent
                }
            }
        }
    }
}

Copiar

Última actualización el 28/09/2023

Tipos de mensajes soportados en WhatsApp On-Premise | WOZTELL

Tipos de mensajes de WhatsApp

Texto

Imagen

consejo

Audio

consejo

Video

consejo

Sticker

consejo

Archivo

consejo

Ubicación

Contacto

NOTA

Reacción

NOTA

Mensajes interactivos

Mensajes de lista

Botones de respuesta

Mensaje de producto único

Mensaje de múltiples productos

consejo

Plantilla de mensaje de WhatsApp

Detalles de la plantilla

Límite máximo de caracteres

Procedimiento de configuración

Responder a

NOTAS