Llamada a la acción (URL)

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 con un botón que abre una URL. Permiten dirigir al usuario a un sitio web sin mostrar la URL completa en el texto del mensaje. Se envían con POST /v1/messaging; los encabezados, los campos comunes y la respuesta están en Conexión HTTP.

Llamada a la acción (URL)

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

Cuerpo

Campos de Llamada a la acción (URL):

Nombre	Descripción	Tipo	Requerimientos
call_to_action_url	Objeto para enviar un mensaje con un botón que abre una URL.	Objeto	Obligatorio si se envía un mensaje de llamada a la acción (URL).

Objeto call to action url

Nombre	Descripción	Tipo	Requerimientos
headerText	Texto del encabezado.	String	Opcional.
headerImage	Imagen del encabezado.	Objeto	Opcional.
headerVideo	Video del encabezado.	Objeto	Opcional.
headerDocument	Documento del encabezado.	Objeto	Opcional.
body	Contiene el texto del mensaje, que puede incluir formato y URL.	String	Obligatorio.
footer	El pie de página del mensaje.	String	Opcional.
action	Objeto que contiene los datos del botón.	Objeto	Obligatorio.

Solo se puede usar un encabezado multimedia por mensaje. Si se envía más de uno, se toma con la siguiente prioridad: headerDocument, headerImage, headerVideo.

Objeto headerImage (CTA)

Nombre	Descripción	Tipo	Requerimientos
link	URL de la imagen.	String	Se requiere `link` o `media_id` (uno de los dos).
media_id	ID del recurso en WhatsApp.	String	Se requiere `link` o `media_id` (uno de los dos).

Objeto headerVideo (CTA)

Nombre	Descripción	Tipo	Requerimientos
link	URL del video.	String	Se requiere `link` o `media_id` (uno de los dos).
media_id	ID del recurso en WhatsApp.	String	Se requiere `link` o `media_id` (uno de los dos).

Objeto headerDocument (CTA)

Nombre	Descripción	Tipo	Requerimientos
link	URL del documento.	String	Se requiere `link` o `media_id` (uno de los dos).
media_id	ID del recurso en WhatsApp.	String	Se requiere `link` o `media_id` (uno de los dos).
fileName	Nombre del archivo.	String	Opcional

Objeto action URL

Nombre	Descripción	Tipo	Requerimientos
parameters	Objeto con el texto y la URL del botón.	Objeto	Obligatorio.

Objeto parameters URL

Nombre	Descripción	Tipo	Requerimientos
display_text	Texto que se muestra en el botón.	String	Obligatorio.
url	URL que se abre al presionar el botón.	String	Obligatorio.

Ejemplo

Ejemplo completo de Llamada a la acción (URL) (petición HTTP y cuerpo JSON):

Petición HTTP llamada a la acción

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",
    "call_to_action_url": {
        "headerImage": {
            "link": "https://www.ejemplo.com/ejemplo_imagen.jpg"
        },
        "body": "Consulta el estado de tu pedido en nuestro sitio web.",
        "footer": "Gracias por tu compra",
        "action": {
            "parameters": {
                "display_text": "Ver pedido",
                "url": "https://www.ejemplo.com/pedidos/12345"
            }
        }
    }
}'

Body llamada a la acción

{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "interactive",
    "call_to_action_url": {
        "headerImage": {
            "link": "https://www.ejemplo.com/ejemplo_imagen.jpg"
        },
        "body": "Consulta el estado de tu pedido en nuestro sitio web.",
        "footer": "Gracias por tu compra",
        "action": {
            "parameters": {
                "display_text": "Ver pedido",
                "url": "https://www.ejemplo.com/pedidos/12345"
            }
        }
    }
}

Botones de réplica

Solicitud de información de contacto