Secuencia

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 de secuencia (carrusel) con tarjetas desplazables. 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.

Secuencia

Mensaje de texto único acompañado de un conjunto de hasta 10 tarjetas de carrusel en una vista desplazable horizontalmente. Se envía como un componente carousel con sus tarjetas en cards.

Cuerpo

Campos de Secuencia:

Nombre	Descripción	Tipo	Requerimientos
type	El valor es "carousel".	String	Obligatorio
cards	Una lista de hasta 10 objetos de tipo cards. Las tarjetas en el carrusel deben: Tener un encabezado multimedia (imagen o video) Texto del cuerpo Al menos un botón. Soporta 2 botones. Los botones pueden ser los mismos o una combinación de botones de respuesta rápida, botones de números de teléfono o botones de URL.	Lista objetos	Obligatorio El formato del encabezado multimedia y los tipos de botones deben ser los mismos en todas las tarjetas que componen una plantilla de carrusel.

Objeto card

Nombre	Descripción	Tipo	Requerimientos
card_index	Orden en que la tarjeta aparece dentro de la secuencia de la tarjeta. Se expresa como un índice que comienza en 0, es decir que 0 indica la primera tarjeta; 1, la segunda, etc.	Integer	Obligatorio
components	Arreglo de componentes que agregaría a su card. Estos componentes podrían ser de tipo "header", "body" y "button".	Lista objetos	Obligatorio

Ejemplo

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

Petición HTTP secuencia

curl --location --request 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": "{{wa-phone-number}}",
    "to": "{{recipient-wa-id}}",
    "type": "template",
    "template":
    {
        "language": "es_MX",
        "name": "concepto_movil_carrusel_products",
        "components":
        [
            {
                "type": "body",
                "parameters":
                [
                    {
                        "type": "text",
                        "text": "25OFF"
                    },
                    {
                        "type": "text",
                        "text": "25%"
                    }
                ]
            },
            {
                "type": "carousel",
                "cards":
                [
                    {
                        "card_index": 0,
                        "components":
                        [
                            {
                                "type": "header",
                                "parameters":
                                [
                                    {
                                        "type": "image",
                                        "media_id": "966046148378667"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "card_index": 1,
                        "components":
                        [
                            {
                                "type": "header",
                                "parameters":
                                [
                                    {
                                        "type": "image",
                                        "media_id": "448282164313965"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "card_index": 2,
                        "components":
                        [
                            {
                                "type": "header",
                                "parameters":
                                [
                                    {
                                        "type": "image",
                                        "media_id": "1583971738812030"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "card_index": 3,
                        "components":
                        [
                            {
                                "type": "header",
                                "parameters":
                                [
                                    {
                                        "type": "image",
                                        "media_id": "1104222870702261"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}'

Body secuencia

{
 "from": "{{wa-phone-number}}",
 "to": "{{recipient-wa-id}}",
 "type": "template",
 "template": {
   "language": "es_MX",
   "name": "concepto_movil_carrusel_products",
   "components": [
     {
       "type": "body",
       "parameters": [
         {
           "type": "text",
           "text": "25OFF"
         },
         {
           "type": "text",
           "text": "25%"
         }
       ]
     },
     {
       "type": "carousel",
       "cards": [
         {
           "card_index": 0,
           "components": [
             {
               "type": "header",
               "parameters": [
                 {
                   "type": "image",
                   "media_id": "966046148378667"
                 }
               ]
             }
           ]
         },
         {
           "card_index": 1,
           "components": [
             {
               "type": "header",
               "parameters": [
                 {
                   "type": "image",
                   "media_id": "448282164313965"
                 }
               ]
             }
           ]
         },
         {
           "card_index": 2,
           "components": [
             {
               "type": "header",
               "parameters": [
                 {
                   "type": "image",
                   "media_id": "1583971738812030"
                 }
               ]
             }
           ]
         },
         {
           "card_index": 3,
           "components": [
             {
               "type": "header",
               "parameters": [
                 {
                   "type": "image",
                   "media_id": "1104222870702261"
                 }
               ]
             }
           ]
         }
       ]
     }
   ]
 }
}

WhatsApp Flows

Cupones y ofertas por tiempo limitado