WhatsApp

Solicitud HTTP para enviar vía WhatsApp

La trama para enviar un mensaje de WhatsApp es la siguiente:

POST https://api.obmessage.ai/api/v1/whatsapp
Authorization: {{API_KEY}}
Content-Type: application/json

{
    "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 por correo.

Contáctenos

Datos obligatorios

Los siguientes datos son requeridos:

Campo	Descripción
phone	Número telefónico al cual se enviará el WhatsApp. Debe ser compatible con la recomendación E.164.
whatsapp_template	Datos de la plantilla de WhatsApp. Solo es obligatorio si no se usa template_id.

whatsapp_template

El objeto whatsapp_template contiene la información necesaria para enviar el mensaje según la configuración de la plantilla.

Utiliza la misma estructura documentada por Meta en este enlace, con soporte para:

• 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 mensajes con botones quick_reply.
• Envío de mensajes con botones url.

También se soporta el reemplazo de variables definidas en fields dentro de OBMessage.

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

Ejemplos

Para los ejemplos que contienen variables, la plantilla debe estar configurada correctamente en Meta. Cuando en Meta se agrega una variable como {{1}}, significa que se utilizará el valor reemplazado desde OBMessage en parameters.

Los datos de parameters que pueden utilizar variables de OBMessage son:

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

Si se utilizan variables, estas no deben estar en blanco.

Enviar plantilla sin variables

{
    "phone": "+18099999999",
    "whatsapp_template": {
        "name": "hello_world",
        "language": {
            "code": "en_US"
        }
    }
}

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

Contáctenos

Enviar plantilla con variables

{
    "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 por correo.

Contáctenos

Enviar plantilla con botones, headers y body

{
    "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 por correo.

Contáctenos

Enviar imágenes, videos y documentos

Para este caso se utiliza el mismo payload. Solo debe cambiar image por video o document, según se requiera.

{
    "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 por correo.

Contáctenos