Ejemplos de Webhook para mensajes entrantes de WhatsApp

Para consultar el catálogo exhaustivo derivado del esquema, consulta todos los ejemplos.

Qué es

Gestiona los tipos de mensajes entrantes de WhatsApp con ejemplos de cargas útiles comentadas.

Antes de comenzar

Crea un endpoint HTTPS público en tu aplicación.
Configura un endpoint de webhook de YCloud para los tipos de eventos que necesites.
Almacena el secreto de firma del endpoint de forma segura.
Haz que el procesamiento de eventos sea idempotente.

Cómo funciona

YCloud envía una solicitud HTTP POST cuando ocurre el evento. Verifica la firma, registra el evento de forma duradera, devuelve una respuesta 2xx y procesa el trabajo lento de forma asíncrona.

Solicitud

Los siguientes escenarios muestran solicitudes enviadas a tu URL de webhook. Trata el evento id como el identificador de entrega y utiliza type para enrutar la carga útil.

Respuesta

Devuelve un estado 2xx tras aceptar el evento.

HTTP/1.1 200 OK

Para la configuración del endpoint, la validación de firmas y el comportamiento de reintentos, consulta Configurar webhooks.

Mensaje entrante no admitido

En este caso, tu endpoint de webhook recibió un mensaje entrante no admitido:

type está establecido en unsupported.
errors explica por qué el mensaje no es compatible o no está disponible.
unsupported.type identifica la categoría del mensaje, como poll_creation, poll_update, edit o pin.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f8709b741c165b4342a714",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "errors": [
       {
          "code": 131051,
          "title": "Message type unknown",
          "message": "Message type unknown",
          "error_data": {
             "details": "Message type is currently not supported."
          }
       }
     ],
     "type": "unsupported",
     "unsupported": {
       "type": "poll_update"
     }
  }
}'

Respuesta

Confirma la recepción tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

El error 131051 con Message type unknown significa que WhatsApp Cloud API no admite el tipo de mensaje.
El error 131060 con This message is currently unavailable. significa que WhatsApp no pudo proporcionar el contenido del mensaje.
unsupported.type identifica la categoría general. No contiene el contenido original del mensaje.
Consulta Mensajes no admitidos en Inbox para ver una lista legible de tipos de mensajes. Consulta la referencia de webhooks de mensajes no admitidos de Meta para conocer el contrato actual de carga útil.

Mensaje de texto entrante

En este caso, tu endpoint de webhook recibió un mensaje de texto entrante:

Contiene el texto sin formato que envió el usuario.
Contiene la información del mensaje mencionado en context.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEkn26qar3nOB8md",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f872f6741c165b4342a751",
    "wamid": "wamid.HBgNODi...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "text",
    "text": {
      "body": "OK"
    },
    "context": {
      "from": "447901614024",
      "id": "wamid.HBgNODr..."
    }
  }
}'

Respuesta

Confirma la recepción tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Los mensajes entrantes son aquellos que envían los clientes a tus números de teléfono de empresa.
El objeto context (opcional) contiene la información del mensaje mencionado, que se utiliza normalmente para responder a un mensaje anterior enviado por el usuario o por tu empresa.
- context.from es el ID de WhatsApp (número de teléfono sin el prefijo ’+’) del usuario que envió el mensaje mencionado.
- context.id es el ID original del mensaje mencionado en la plataforma de WhatsApp, que comienza con wamid..

Mensaje de texto entrante activado por un anuncio con clic a WhatsApp

En este caso, tu endpoint de webhook recibió un mensaje de texto entrante activado por un anuncio con clic a WhatsApp:

Contiene texto sin formato.
Contiene información sobre el anuncio.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEkn26qar3nOB8md",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f872f6741c165b4342a751",
    "wamid": "wamid.HBgNODi...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "text",
    "text": {
      "body": "OK"
    },
    "referral": {
      "source_url": "https://fb.me/xxx",
      "source_type": "ad",
      "source_id": "MEDIA-ID",
      "headline": "Chat with us",
      "media_type": "image",
      "image_url": "https://scontent.xx.fbcdn.net/v/t45.1600-4/xxx.jpg",
      "ctwa_clid": "feRgX__yiYtsI1HhjI2FRjyKInYlrU9cm9ml-Yl1MXp_fJy6Mwp-adZ-yLqOWX5CiZJYtjQERgKbAUetcwFXb_6FUYyOl9Kc6HFOBCd"
    }
  }
}'

Respuesta

Confirma la recepción tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

El objeto referral contiene información sobre el anuncio. Consulta también Anuncios con clic a WhatsApp.

Mensaje de imagen entrante

En este caso, tu endpoint de webhook recibió un mensaje de imagen entrante:

Contiene una URL de imagen.
Contiene un pie de foto para describir esta imagen.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEkv5wsCJItpaH01",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f87878509703399f3fd3d0",
    "wamid": "wamid.HBgNODi...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "image",
    "image": {
      "link": "https://api.ycloud.com/v2/whatsapp/media/download/592623615738103?sig=t%3D1677228150%2Cs%3D0aa4810392602afb2a91e28e54223c4c0e638bba298f19f07a6c3a2ccf6bdf1e&payload=eyJ3YWJhSWQiOiIxMDY2ODE3NzIxOTE4NzQiLCJpbmJvdW5kTWVzc2FnZUlkIjoiNjNmODc4Nzg1MDk3MDMzOTlmM2ZkM2QwIiwibWltZVR5cGUiOiJpbWFnZS9qcGVnIiwic2hhMjU2IjoiTGVScFFKcS9oNEhUam1QOHNtRkpRRXdZQm5rR0JVdDFjeDRxekZjblVoUT0ifQ",
      "caption": "Go for a walk.",
      "id": "592623615738103",
      "sha256": "LeRpQJq/h4HTjmP8smFJQEwYBnkGBUt1cx4qzFcnUhQ=",
      "mime_type": "image/jpeg"
    }
  }
}'

Respuesta

Confirma la recepción tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

La image.link se puede acceder directamente durante unos minutos para comodidad del usuario, pero siempre debes incluir un encabezado X-API-Key para descargar este archivo en un plazo de 30 días.

Mensaje de video entrante

En este caso, tu endpoint de webhook recibió un mensaje de video entrante:

Contiene una URL de video.
Contiene un pie de video para describir este video.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEkwhYtqMPmYdsN3",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f87991741c165b4342a797",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "video",
    "video": {
      "link": "https://api.ycloud.com/v2/whatsapp/media/download/919306472440541?sig=t%3D1677228430%2Cs%3D481b972ebc10e6b384f11274ba59e64b8c355543ea0b30e066b209361212abad&payload=eyJ3YWJhSWQiOiIxMDY2ODE3NzIxOTE4NzQiLCJpbmJvdW5kTWVzc2FnZUlkIjoiNjNmODc5OTE3NDFjMTY1YjQzNDJhNzk3IiwibWltZVR5cGUiOiJ2aWRlby9tcDQiLCJzaGEyNTYiOiJ4RHpyU1R1YnZURm53MytzMVdJbEFiSUZLanpBS2k1dFZWaVFOVjhKV3BnPSJ9",
      "caption": "Go for a walk.",
      "id": "919306472440541",
      "sha256": "xDzrSTubvTFnw3+s1WIlAbIFKjzAKi5tVViQNV8JWpg=",
      "mime_type": "video/mp4"
    }
  }
}'

Respuesta

Confirma la recepción tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

La video.link se puede acceder directamente durante unos minutos para comodidad del usuario, pero siempre debes incluir un encabezado X-API-Key para descargar este archivo en un plazo de 30 días.

Mensaje de audio entrante

En este caso, tu endpoint de webhook recibió un mensaje de audio entrante:

Contiene una URL de audio.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEl1TDAcquZUxzLn",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f87cd3509703399f3fd3f2",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "audio",
    "audio": {
      "link": "https://api.ycloud.com/v2/whatsapp/media/download/712063723747110?sig=t%3D1677229265%2Cs%3D5c6a65172ef8caa7bc969dacb831d6e15362fd7a5b6be7aa994aa83cdd15fc4e&payload=eyJ3YWJhSWQiOiIxMDY2ODE3NzIxOTE4NzQiLCJpbmJvdW5kTWVzc2FnZUlkIjoiNjNmODdjZDM1MDk3MDMzOTlmM2ZkM2YyIiwibWltZVR5cGUiOiJhdWRpby9tcGVnIiwic2hhMjU2IjoiQWtSWkR5dEx5MkkxSzFkT2VMNnBRT2pZblBwcGdqdFNDTzlNUStDcnkwUT0ifQ",
      "id": "712063723747110",
      "sha256": "AkRZDytLy2I1K1dOeL6pQOjYnPppgjtSCO9MQ+Cry0Q=",
      "mime_type": "audio/mpeg"
    }
  }
}'

Respuesta

Confirma la recepción tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

La audio.link se puede acceder directamente durante unos minutos para comodidad del usuario, pero siempre debes incluir un encabezado X-API-Key para descargar este archivo en un plazo de 30 días.

Mensaje de documento entrante

En este caso, tu endpoint de webhook recibió un mensaje de documento entrante:

Contiene una URL de documento.
Contiene un pie para describir este documento.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEkz3y7V6TCqgkbK",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f87b2e741c165b4342a79b",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "document",
    "document": {
      "link": "https://api.ycloud.com/v2/whatsapp/media/download/948915536111569?sig=t%3D1677228843%2Cs%3D6eb8b4fc2796bae9f2e95702fbbd4d211cace96bc5c934a12d97704140e47a16&payload=eyJ3YWJhSWQiOiIxMDY2ODE3NzIxOTE4NzQiLCJpbmJvdW5kTWVzc2FnZUlkIjoiNjNmODdiMmU3NDFjMTY1YjQzNDJhNzliIiwibWltZVR5cGUiOiJhcHBsaWNhdGlvbi9wZGYiLCJzaGEyNTYiOiJFcHZDdHpUallkcTRleG1xc2ZHYmVpK1NUZ1h4VnFUQzJ0b2laODB2bW5rPSJ9",
      "caption": "PDF example",
      "filename": "sample.pdf",
      "id": "948915536111569",
      "sha256": "EpvCtzTjYdq4exmqsfGbei+STgXxVqTC2toiZ80vmnk=",
      "mime_type": "application/pdf"
    }
  }
}'

Respuesta

Confirma la recepción tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

La document.link se puede acceder directamente durante unos minutos para comodidad del usuario, pero siempre debes incluir un encabezado X-API-Key para descargar este archivo en un plazo de 30 días.

Mensaje de sticker entrante

En este caso, tu endpoint de webhook recibió un mensaje de sticker entrante:

Contiene una URL de sticker.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63fc1678741c165b4342b38e",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "sticker",
    "sticker": {
      "link": "https://api.ycloud.com/v2/whatsapp/media/download/729118992174848?sig=t%3D1677465205%2Cs%3Dbc0d582e37cc701d5d090c1d11aa7eaed9b3f8e83925425a82d0aaab8b7da258&payload=eyJ3YWJhSWQiOiIxMDY2ODE3NzIxOTE4NzQiLCJpbmJvdW5kTWVzc2FnZUlkIjoiNjNmYzE2Nzg3NDFjMTY1YjQzNDJiMzhlIiwibWltZVR5cGUiOiJpbWFnZS93ZWJwIiwic2hhMjU2IjoiUlpFRWw1SFZXVDRTNkMwUG9PZ2pZQ1FWRFdzNWVzSU1Kc2pjRFlJODBaRT0ifQ",
      "id": "729118992174848",
      "sha256": "RZEEl5HVWT4S6C0PoOgjYCQVDWs5esIMJsjcDYI80ZE=",
      "mime_type": "image/webp"
    }
  }
}'

Respuesta

Confirma la entrega después de aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Se puede acceder directamente al sticker.link en unos minutos para comodidad del consumidor, pero siempre debes incluir un encabezado X-API-Key para descargar este archivo dentro de los 30 días.

Mensaje de ubicación entrante

En este caso, tu endpoint de webhook recibió un mensaje de ubicación entrante:

Contiene la latitud y longitud del lugar.
Contiene el nombre, la dirección y la URL del lugar.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63fc18ae509703399f3fe000",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "location",
    "location": {
      "latitude": 1.40435,
      "longitude": 103.79304,
      "name": "Singapore Zoo",
      "address": "80 Mandai Lake Road Singapore 72",
      "url": "https://www.zoo.com.sg"
    }
  }
}'

Respuesta

Confirma la entrega después de aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Enruta el evento mediante type, deduplícalo por id y traslada el trabajo lento o propenso a errores a un procesador asíncrono.

Mensaje de contactos entrante

En este caso, tu endpoint de webhook recibió un mensaje de contactos entrante:

Contiene un contacto con direcciones, fecha de cumpleaños, correos electrónicos, nombre, teléfonos y otros campos de contacto.
Contiene origin: contact_request cuando el usuario compartió el contacto en respuesta a un mensaje de solicitud de información de contacto.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f71fb8741c165b434292fb",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "contacts",
    "contacts": [
      {
        "addresses": [
          {
            "street": "<ADDRESS_STREET>",
            "city": "<ADDRESS_CITY>",
            "state": "<ADDRESS_STATE>",
            "zip": "<ADDRESS_ZIP>",
            "country": "<ADDRESS_COUNTRY>",
            "country_code": "<ADDRESS_COUNTRY_CODE>",
            "type": "HOME"
          }
        ],
        "birthday": "2001-01-01",
        "emails": [
          {
            "email": "joe@example.com",
            "type": "WORK"
          }
        ],
        "name": {
          "formatted_name": "<CONTACT_FORMATTED_NAME>",
          "first_name": "<CONTACT_FIRST_NAME>",
          "last_name": "<CONTACT_LAST_NAME>",
          "middle_name": "<CONTACT_MIDDLE_NAME>",
          "suffix": "<CONTACT_SUFFIX>",
          "prefix": "<CONTACT_PREFIX>"
        },
        "org": {
          "company": "<CONTACT_ORG_COMPANY>",
          "department": "<CONTACT_ORG_DEPARTMENT>",
          "title": "<CONTACT_ORG_TITLE>"
        },
        "phones": [
          {
            "phone": "+447901614024",
            "wa_id": "447901614024",
            "type": "WORK"
          }
        ],
        "origin": "contact_request",
        "urls": [
          {
            "url": "<CONTACT_URL>",
            "type": "WORK"
          }
        ]
      }
    ]
  }
}'

Respuesta

Confirma la entrega después de aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Enruta el evento mediante type, deduplícalo por id y traslada el trabajo lento o propenso a errores a un procesador asíncrono.

Mensaje de reacción entrante

En este caso, tu endpoint de webhook recibió un mensaje de reacción entrante:

Contiene el ID del mensaje al que reacciona el usuario.
Contiene el emoji.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f71fb8741c165b434292fb",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "reaction",
    "reaction": {
      "message_id": "wamid.HBgNODYxNTcwMDA3NzE0NRUCABIYIEYyMzY3OUJBMzY2RkFFQkRDQjYyQ0Q5RDE1QjA2RUYyAA==",
      "emoji": "👍"
    }
  }
}'

Respuesta

Confirma la entrega después de aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

El emoji está presente cuando el usuario reacciona a un mensaje con un emoji. Si no es así, indica que el usuario eliminó el emoji de un mensaje.

Mensaje de botón de plantilla entrante

En este caso, tu endpoint de webhook recibió un mensaje de botón de plantilla entrante:

Contiene el botón text de la plantilla que utilizaste al enviar una plantilla de mensaje.
Contiene el botón payload que proporcionaste al enviar una plantilla de mensaje.
Contiene el wamid (context.wamid) de la plantilla de mensaje que enviaste.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f71fb8741c165b434292fb",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "button",
    "button": {
      "payload": "more_about_marketing_friday",
      "text": "Learn more"
    },
    "context": {
      "from": "447901614024",
      "id": "wamid.HBgNODr..."
    }
  }
}'

Respuesta

Confirma la entrega después de aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Enruta el evento mediante type, deduplícalo por id y traslada el trabajo lento o propenso a errores a un procesador asíncrono.

Mensaje interactivo de respuesta de lista entrante

En este caso, tu endpoint de webhook recibió un mensaje interactivo de respuesta de lista entrante:

El campo interactive contiene la respuesta de la lista en la que el usuario hizo clic en un mensaje interactivo que enviaste anteriormente.
El campo context contiene información sobre el mensaje interactivo que enviaste previamente al usuario.

Haz clic en el botón para seleccionar un elemento.

El destinatario responde a tu mensaje seleccionando uno de los elementos de tu mensaje interactivo enviado previamente.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f73942741c165b43429f86",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "interactive",
    "interactive": {
      "type": "list_reply",
      "list_reply": {
        "id": "<LIST_SECTION_2_ROW_1_ID>",
        "title": "<SECTION_2_ROW_1_TITLE>",
        "description": "<SECTION_2_ROW_1_DESC>"
      }
    },
    "context": {
      "from": "447901614024",
      "id": "wamid.HBgNODr..."
    }
  }
}'

Respuesta

Confirma la entrega después de aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

El context contiene información sobre el mensaje interactivo que enviaste anteriormente.
- context.from es el WhatsApp ID (número de teléfono sin el prefijo ’+’) de quien envió el mensaje interactivo.
- context.id es el ID del mensaje original en la plataforma de WhatsApp, que comienza con wamid..

Mensaje interactivo de respuesta de botón entrante

En este caso, tu endpoint de webhook recibió un mensaje interactivo de respuesta de botón entrante:

El campo interactive contiene la respuesta del botón en el que el usuario hizo clic en un mensaje interactivo que enviaste anteriormente.
El campo context contiene información sobre el mensaje interactivo que enviaste previamente al usuario.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f71fb8741c165b434292fb",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "interactive",
    "interactive": {
      "type": "button_reply",
      "button_reply": {
        "id": "<UNIQUE_BUTTON_ID_2>",
        "title": "<BUTTON_TITLE_2>"
      }
    },
    "context": {
      "from": "447901614024",
      "id": "wamid.HBgNODr..."
    }
  }
}'

Respuesta

Confirma la entrega después de aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

El context contiene información sobre el mensaje interactivo que enviaste anteriormente.
- context.from es el WhatsApp ID (número de teléfono sin el prefijo ’+’) de quien envió el mensaje interactivo.
- context.id es el ID del mensaje original en la plataforma de WhatsApp, que comienza con wamid..

Mensaje interactivo de respuesta de Flow entrante

Al completarse el flow, se enviará un mensaje de respuesta al chat de WhatsApp. Lo recibirás de la misma manera que recibes todos los demás mensajes del usuario: a través del webhook de mensajes. El campo response_json contendrá datos específicos del flow.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f71fb8741c165b434292fb",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "interactive",
    "interactive": {
      "type": "nfm_reply",
      "nfm_reply": {
        "name": "flow",
        "body": "Sent",
        "response_json": "{\"flow_token\": \"<FLOW_TOKEN>\", \"optional_param1\": \"<value1>\", \"optional_param2\": \"<value2>\"}"
      }
    },
    "context": {
      "from": "447901614024",
      "id": "wamid.HBgNODr..."
    }
  }
}'

Respuesta

Confirma la entrega después de aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

interactive.type siempre es nfm_reply. interactive.name siempre es flow. interactive.body siempre es Sent.
interactive.response_json corresponde a datos específicos del flow. La estructura se define en el JSON del flow (consulta Complete action) o, si el flow utiliza un endpoint, está controlada por el endpoint (consulta Final Response Payload en Data Exchange Request). Analiza la cadena JSON interactive.response_json a un objeto JSON, donde el tipo de datos de sus valores puede variar. Por lo general, los valores son texto sin formato, excepto:
- Cuando se origina a partir de un componente CheckboxGroup, el valor es una lista de cadenas.
- Cuando se origina a partir de un componente OptIn, el valor es un booleano, es decir, true o false. Actualmente, si está presente, el valor debe ser true, ya que no se incluirá dicha clave en response_json si el usuario no eligió aceptar (opt-in).
- Cuando se origina a partir de un componente DatePicker, el valor es una cadena que representa una marca de tiempo Unix en milisegundos, como "1725936737548"(es decir, 2024-09-10T02:52:17.548Z). A partir de la versión 5.0 de Flow JSON, las fechas se establecerán en formato “yyyy-MM-dd”, lo que hace que los valores sean independientes de las zonas horarias.
Para enviar un mensaje con un Flow, consulta Mensaje de plantilla Flow y Mensaje interactivo de Flow.

Mensaje de sistema entrante

En este caso, tu endpoint de webhook recibió un mensaje de sistema entrante:

type está establecido en system, y system.type está establecido en user_changed_number.
Un usuario cambia su número de teléfono en WhatsApp, y wa_id es el nuevo WhatsApp ID (número de teléfono sin el prefijo +).
user_id es el nuevo BSUID. parent_user_id solo se incluye cuando los BSUID principales están habilitados.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f71fb8741c165b434292fb",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "system",
    "system": {
      "body": "User A changed from 123456789 to 987654321",
      "wa_id": "987654321",
      "user_id": "US.13491208655302741919",
      "parent_user_id": "US.ENT.11815799212886844831",
      "type": "user_changed_number"
    }
  }
}'

Respuesta

Confirma la entrega tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Enruta el evento mediante type, deduplícalo mediante id y traslada el trabajo lento o propenso a fallos a un procesador asíncrono.

Mensaje de pedido entrante

En este caso, tu endpoint de webhook recibió un mensaje de pedido entrante cuando un cliente añade uno o más productos a su carrito y envía un pedido:

Contiene información sobre el producto solicitado.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f71fb8741c165b434292fb",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "order",
    "order": {
      "catalog_id": "the-catalog_id",
      "product_items": [
        {
          "product_retailer_id": "the-product-SKU-identifier",
          "quantity": "number-of-item",
          "item_price": "unitary-price-of-item",
          "currency": "price-currency"
        }
      ],
      "text": "text-message-sent-along-with-the-order"
    },
    "context": {
      "from": "16315551234",
      "id": "wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o"
    }
  }
}'

Respuesta

Confirma la entrega tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Enruta el evento mediante type, deduplícalo mediante id y traslada el trabajo lento o propenso a fallos a un procesador asíncrono.

Mensaje de consulta de producto entrante

En este caso, tu endpoint de webhook recibió un mensaje de texto entrante cuando un cliente consulta sobre un producto:

Contiene información sobre el producto.

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f71fb8741c165b434292fb",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "text",
    "text": {
      "body": "Can I get this in another color?"
    },
    "context": {
      "referred_product": {
        "catalog_id": "catalog-ID",
        "product_retailer_id": "product-ID"
      }
    }
  }
}'

Respuesta

Confirma la entrega tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Se recibe un mensaje de consulta de producto cuando un usuario solicita más información sobre un producto específico. Estos pueden recibirse en dos escenarios:
- Cuando un cliente responde a Mensajes de un solo producto o de múltiples productos.
- Cuando un cliente accede al catálogo de una empresa mediante otro punto de entrada, navega a la página de detalles del producto y hace clic en Enviar mensaje a la empresa sobre este producto.

Mensaje de bienvenida de solicitud entrante

Puedes recibir una notificación por webhook cada vez que un usuario de WhatsApp abra un chat contigo por primera vez. Esto puede ser útil si deseas responder a estos usuarios con un mensaje de bienvenida especial con tu propio diseño. Si habilitas esta función y un usuario abre un chat, normalmente cuando pulsa un enlace universal (enlaces wa.me o api.whatsapp.com ), el cliente de WhatsApp verifica si existe un hilo de mensajes previo entre el usuario y el número de teléfono de tu empresa. Si no lo hay, el cliente activa un webhook request_welcome. A continuación, puedes responder al usuario con tu propio mensaje de bienvenida. example-inboundmessage-welcomemessage

Solicitud

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eF6mVJUj5OWfKXMD",
  "type": "whatsapp.inbound_message.received",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappInboundMessage": {
    "id": "63f71fb8741c165b434292fb",
    "wamid": "wamid.HBgNOD...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId" : "US.13491208655302741918",
    "fromParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeJoe"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "request_welcome"
  }
}'

Respuesta

Confirma la entrega tras aceptar el evento de forma duradera.

HTTP/1.1 200 OK

Explicación

Para habilitar esta función en un número de teléfono, ve a Meta Administrador de WhatsApp > Números de teléfono > Configuración > Automatizaciones.
Para probar el mensaje request_welcome, si ya tienes un hilo de chat en curso con el número de teléfono de la empresa, primero debes eliminar el chat.
Esta función solo activa un mensaje entrante request_welcome y no responde ningún mensaje automáticamente. Depende de ti enviar o no un mensaje de bienvenida.

​Qué es

​Antes de comenzar

​Cómo funciona

​Solicitud

​Respuesta

​Mensaje entrante no admitido

​Solicitud

​Respuesta

​Explicación

​Mensaje de texto entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de texto entrante activado por un anuncio con clic a WhatsApp

​Solicitud

​Respuesta

​Explicación

​Mensaje de imagen entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de video entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de audio entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de documento entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de sticker entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de ubicación entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de contactos entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de reacción entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de botón de plantilla entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje interactivo de respuesta de lista entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje interactivo de respuesta de botón entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje interactivo de respuesta de Flow entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de sistema entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de pedido entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de consulta de producto entrante

​Solicitud

​Respuesta

​Explicación

​Mensaje de bienvenida de solicitud entrante

​Solicitud

​Respuesta

Qué es

Antes de comenzar

Cómo funciona

Solicitud

Respuesta

Mensaje entrante no admitido

Solicitud

Respuesta

Explicación

Mensaje de texto entrante

Solicitud

Respuesta

Explicación

Mensaje de texto entrante activado por un anuncio con clic a WhatsApp

Solicitud

Respuesta

Explicación

Mensaje de imagen entrante

Solicitud

Respuesta

Explicación

Mensaje de video entrante

Solicitud

Respuesta

Explicación

Mensaje de audio entrante

Solicitud

Respuesta

Explicación

Mensaje de documento entrante

Solicitud

Respuesta

Explicación

Mensaje de sticker entrante

Solicitud

Respuesta

Explicación

Mensaje de ubicación entrante

Solicitud

Respuesta

Explicación

Mensaje de contactos entrante

Solicitud

Respuesta

Explicación

Mensaje de reacción entrante

Solicitud

Respuesta

Explicación

Mensaje de botón de plantilla entrante

Solicitud

Respuesta

Explicación

Mensaje interactivo de respuesta de lista entrante

Solicitud

Respuesta

Explicación

Mensaje interactivo de respuesta de botón entrante

Solicitud

Respuesta

Explicación

Mensaje interactivo de respuesta de Flow entrante

Solicitud

Respuesta

Explicación

Mensaje de sistema entrante

Solicitud

Respuesta

Explicación

Mensaje de pedido entrante

Solicitud

Respuesta

Explicación

Mensaje de consulta de producto entrante

Solicitud

Respuesta

Explicación

Mensaje de bienvenida de solicitud entrante

Solicitud

Respuesta