Lista de mensajes

Last update: 4 days ago by Irais Aguirre

Resumen para integración
Endpoint: POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging
Token: de mensajería, en el encabezado Authorization: Bearer {{wa-msg-api-token}} (cómo generarlo)
Campos comunes: from, to (teléfono o BSUID) y type (detalle)
Valores de type en esta página: "interactive"
Respuesta: la misma para todos los mensajes (ver respuesta)

Mensajes que incluyen un menú de hasta 10 opciones. Este tipo de mensaje ofrece una forma más sencilla y coherente para que los usuarios realicen una selección al interactuar con una empresa. Se envían con POST /v1/messaging; los encabezados, los campos comunes y la respuesta están en Conexión HTTP.

Lista de mensajes

El campo type debe ser "interactive" y el contenido del mensaje se envía en el objeto listMessages. Consulta la estructura general de los mensajes interactivos.

Cuerpo

Campos de Lista de mensajes:

Nombre	Descripción	Tipo	Requerimientos
listMessages	Objeto con la lista de mensajes. Envía solo uno: listMessages, replyButtons o flow (o algún otro tipo de mensaje interactivo).	Objeto	Condicional

Objeto listMessages

Nombre	Descripción	Tipo	Requerimientos
headerText	Texto del encabezado (máximo 60 caracteres).	String	Opcional
body	Contiene el texto del mensaje, que puede incluir formato y URL (máximo 1024 caracteres).	String	Obligatorio
footer	El pie de página del mensaje (máximo 60 caracteres). Se admiten emojis y Markdown.	String	Opcional
buttonText	Contenido del botón (máximo 20 caracteres). 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 (máximo 24 caracteres).	String	Obligatorio si el mensaje tiene más de una sección.
messages	Lista de mensajes (hasta 10 filas por sección).	Lista objetos	Obligatorio

Objeto messages (filas)

Nombre	Descripción	Tipo	Requerimientos
id	Identificador único de la fila.	String	Obligatorio
title	Título de la fila.	String	Obligatorio
description	Descripción opcional (máximo 72 caracteres).	String	Opcional

Ejemplo

Ejemplo completo de Lista de mensajes (petición HTTP y cuerpo JSON):

Petición HTTP lista mensajes

curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \
-H 'Authorization: Bearer {{wa-msg-api-token}}' \
-H 'Content-Type: application/json' \
-d '{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "interactive",
    "listMessages": {
        "headerText": "Header test", 
        "body": "Body test", 
        "footer": "Footer test", 
        "buttonText": "Ingles", 
        "sections": [
            {
                "title": "Cursos Online", 
                "messages": [
                    {
                        "id": "1",
                        "title": "Intensivos",
                        "description": "Clases en vivo de una hora diaria de lunes a viernes"
                    },
                    {
                        "id": "2",
                        "title": "Sabatino",
                        "description": "Clases en vivo de 3 hora el sábado"
                    },
                    {
                        "id": "3",
                        "title": "Alpha 12",
                        "description": "Clases en vivo, 12 horas divididas en 4 semanas"
                    },
                    {
                        "id": "4",
                        "title": "Alpha 20",
                        "description": "Clases en vivo, 20 horas divididas en 4 semanas"
                    },
                    {
                        "id": "5",
                        "title": "Alpha 40",
                        "description": "Clases en vivo, 40 horas divididas en 4 semanas"
                    },
                    {
                        "id": "6",
                        "title": "Intensivos",
                        "description": "Clases en vivo de una hora diaria de lunes a viernes"
                    },
                    {
                        "id": "7",
                        "title": "Sabatino",
                        "description": "Clases en vivo de 3 hora el sábado"
                    },
                    {
                        "id": "8",
                        "title": "Alpha 12",
                        "description": "Clases en vivo, 12 horas divididas en 4 semanas"
                    },
                    {
                        "id": "9",
                        "title": "Alpha 20",
                        "description": "Clases en vivo, 20 horas divididas en 4 semanas"
                    },
                    {
                        "id": "10",
                        "title": "Alpha 40",
                        "description": "Clases en vivo, 40 horas divididas en 4 semanas"
                    }
                ]
            } 
        ]
    }
}'

Body lista mensajes

{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "interactive",
    "listMessages": {
        "headerText": "Header test", 
        "body": "Body test", 
        "footer": "Footer test", 
        "buttonText": "Ingles", 
        "sections": [
            {
                "title": "Cursos Online", 
                "messages": [
                    {
                        "id": "1",
                        "title": "Intensivos",
                        "description": "Clases en vivo de una hora diaria de lunes a viernes"
                    },
                    {
                        "id": "2",
                        "title": "Sabatino",
                        "description": "Clases en vivo de 3 hora el sábado"
                    },
                    {
                        "id": "3",
                        "title": "Alpha 12",
                        "description": "Clases en vivo, 12 horas divididas en 4 semanas"
                    },
                    {
                        "id": "4",
                        "title": "Alpha 20",
                        "description": "Clases en vivo, 20 horas divididas en 4 semanas"
                    },
                    {
                        "id": "5",
                        "title": "Alpha 40",
                        "description": "Clases en vivo, 40 horas divididas en 4 semanas"
                    },
                    {
                        "id": "6",
                        "title": "Intensivos",
                        "description": "Clases en vivo de una hora diaria de lunes a viernes"
                    },
                    {
                        "id": "7",
                        "title": "Sabatino",
                        "description": "Clases en vivo de 3 hora el sábado"
                    },
                    {
                        "id": "8",
                        "title": "Alpha 12",
                        "description": "Clases en vivo, 12 horas divididas en 4 semanas"
                    },
                    {
                        "id": "9",
                        "title": "Alpha 20",
                        "description": "Clases en vivo, 20 horas divididas en 4 semanas"
                    },
                    {
                        "id": "10",
                        "title": "Alpha 40",
                        "description": "Clases en vivo, 40 horas divididas en 4 semanas"
                    }
                ]
            } 
        ]
    }
}

Mensajes interactivos

Botones de réplica