Saltar a contenido

WhatsApp

Solicitud HTTP para enviar via WhatsApp

La trama para enviar un WhatsApp es la siguiente:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
POST /api/v1/whatsapp
Authorization: {{API_KEY}}

{
    "phone": "+18099999999",
    "reference": "219012",
    "group": "campid01",
    "whatsapp_template": {
        "name": "hello_world",
        "language": {
            "code": "en_US"
        }
    }
}

Si desea realizar una integración de WhatsApp contáctenos via correo.

Contáctenos

Datos obligatorios

Los siguientes datos son requeridos:

Campo Descripción
phone Número telefónico al cual se enviara el WhatsApp. Debe ser compatible con la recomendación e164
whatsapp_template Datos de la plantilla de WhatsApp, solo obligatorio si no se usa un template_id

whatsapp_template

El objeto whatsapp_template es la información necesaria para la enviar el mensaje segun la configuración de la plantilla.

Se utiliza lo mismo que la doc en el enlace pero soportando lo siguiente:

  • Envío de body con o sin variables
  • Envío de headers con o sin variables
  • Envío de headers con imágenes, videos y documentos
  • Envío de mensaje con botones quick_reply
  • Envío de mensaje con botones url

También se soporta el reemplazo de variables con las definida en fields en OBMessage

También es posible crear la plantilla con los mismos datos de whatsapp_template, para que en cada petición solo agregar template_id y no enviar el payload completo cada vez.

Ejemplos

Para los ejemplos que tienen variables, la plantilla debe estar configurada correctamente en Meta, donde cuando se agrega la variable en meta llamada {{1}} es porque se va a utilizar lo que está ya reemplazado de nuestro lado en parameters.

Los datos de parameters que utilizan las variables de OBMessage son:

  • image.link
  • video.link
  • document.link
  • text
  • payload

Y si hay variables no deben estar en blanco.

Enviar plantilla sin variables

1
2
3
4
5
6
7
8
9
{
    "phone": "+18099999999",
    "whatsapp_template": {
        "name": "hello_world",
        "language": {
            "code": "en_US"
        }
    }
}
Si desea realizar una integración de WhatsApp contáctenos via correo.

Contáctenos

Enviar plantilla con variables

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
    "phone": "+18299999999",
    "fields":[
        {
            "name":"body_text",
            "value": "test"
        }
    ],
    "whatsapp_template": {
        "name": "prueba",
        "language": {
            "code": "es"
        },
        "components": [
            {
                "type": "body",
                "parameters": [
                    {
                        "type": "text",
                        "text": "{{body_text}} test"
                    }
                ]
            }
        ]
    }
}
Si desea realizar una integración de WhatsApp contáctenos via correo.

Contáctenos

Enviar plantilla con botones, headers y body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
{
    "phone": "+18099999999",
    "fields":[
        {
            "name":"header_text",
            "value": "test"
        },
        {
            "name":"body_text",
            "value": "test"
        },
        {
            "name":"btn_text_1",
            "value": "test"
        },
        {
            "name":"btn_text_2",
            "value": "logout"
        }
    ],
    "whatsapp_template": {
        "name": "prueba_header",
        "language": {
            "code": "es"
        },
        "components": [
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "text",
                        "text": "nombre {{header_text}}"
                    }
                ]
            },
            {
                "type": "body",
                "parameters": [
                    {
                        "type": "text",
                        "text": "{{body_text}} test"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "quick_reply",
                "index": 0,
                "parameters": [
                    {
                        "type": "payload",
                        "payload":"{{btn_text_1}}"
                    }
                ]
            },
            {
                "type": "button",
                "sub_type": "url",
                "index": 1,
                "parameters": [
                    {
                        "type": "text",
                        "text":"{{btn_text_2}}"
                    }
                ]
            }
        ]
    }
}
Si desea realizar una integración de WhatsApp contáctenos via correo.

Contáctenos

Enviar imágenes, videos y documentos

Para este caso es el mismo payload, solo cambiar image por video o document segun se requiera.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
    "phone": "+18099999999",
    "fields": [
        {
            "name": "image_link",
            "value": "https://dy9y48tmgyg6d.cloudfront.net/db931e22-1844-11ed-b9cc-000c2962f118/ceeb60c8-981a-4c33-96fd-4d532f72913d"
        }
    ],
    "whatsapp_template": {
        "name": "prueba_imagen",
        "language": {
            "code": "es"
        },
        "components": [
            {
                "type": "header",
                "parameters": [
                    {
                        "type": "image",
                        "image": {
                            "link": "{{image_link}}"
                        }
                    }
                ]
            }
        ]
    }
}

Si desea realizar una integración de WhatsApp contáctenos via correo.

Contáctenos