WhatsApp Flows

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: "template"
Respuesta: la misma para todos los mensajes (ver respuesta)

Plantillas que abren un WhatsApp Flow. Todos se envían con POST /v1/messaging; los encabezados, los campos comunes y la respuesta están en Conexión HTTP. La estructura general de la plantilla (objetos template y components) está en Mensajes con plantilla.

WhatsApp Flows

Plantilla que abre un WhatsApp Flow desde un botón. En el objeto del parámetro, type debe ser "action".

Cuerpo

Campos de WhatsApp Flows:

Nombre	Descripción	Tipo	Requerimientos
type	El valor es "action".	String	Obligatorio
action	La acción que deseas que realice el usuario después de leer el mensaje.	Object	Obligatorio

Objeto action

Nombre	Descripción	Tipo	Requerimientos
flow_token	Un token que genera el negocio y sirve como identificador.	String	Obligatorio
flow_action_data	Datos de entrada opcionales para la primera pantalla del Flow. Si se proporciona, debe ser un objeto que no esté vacío.	Map<String, Object>	Opcional

Ejemplo

Ejemplo completo de WhatsApp Flows (petición HTTP y cuerpo JSON):

Petición HTTP con Body y Button

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": "template",
    "template": {
        "language": "en_US",
        "name": "FLOW_TEMPLATE",
        "components": [
            {
                "type": "body", 
                "parameters": [
                    {
                        "text": "This is a flows as template demo",
                        "type": "text"
                    }
                ]
            },
            {
                "type": "button",
                "subtype": "flow",
                "index": 0,
                "parameters": [
                    {
                        "type": "action",
                        "action": {
                            "flow_token":"AQAAAAACS5FpgQ_cAAAAAD0QI3s.",
                            "flow_action_data": {
                                "product_name": "name",
                                "product_description": "description",
                                "product_price": 100
                            }
                        }
                    }
                ]
            }
        ]
    }
}'

Body con header texto

{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "template",
    "template": {
        "language": "en_US",
        "name": "FLOW_TEMPLATE",
        "components": [
            {
                "type": "body", 
                "parameters": [
                    {
                        "text": "This is a flows as template demo",
                        "type": "text"
                    }
                ]
            },
            {
                "type": "button",
                "subtype": "flow",
                "index": 0,
                "parameters": [
                    {
                        "type": "action",
                        "action": {
                            "flow_token":"AQAAAAACS5FpgQ_cAAAAAD0QI3s.",
                            "flow_action_data": {
                                "product_name": "name",
                                "product_description": "description",
                                "product_price": 100
                            }
                        }
                    }
                ]
            }
        ]
    }
}

Botones

Secuencia