Exemplos de Webhooks de sincronização de mensagens enviadas do WhatsApp Business App

Para ver o catálogo completo derivado do esquema, consulte todos os exemplos.

O que é

Manipule eventos de sincronização de mensagens enviadas do WhatsApp Business App.

Antes de começar

Crie um endpoint HTTPS público na sua aplicação.
Configure um endpoint de webhook da YCloud para os tipos de eventos necessários.
Armazene o segredo de assinatura do endpoint de forma segura.
Torne o processamento de eventos idempotente.

Como funciona

A YCloud envia uma requisição HTTP POST quando o evento ocorre. Verifique a assinatura, registre o evento de forma duradoura, retorne uma resposta 2xx e processe tarefas demoradas de forma assíncrona.

Requisição

Os cenários abaixo mostram requisições entregues ao seu URL de webhook. Trate o id do evento como o identificador de entrega e use type para rotear o payload.

Resposta

Retorne um status 2xx após aceitar o evento.

HTTP/1.1 200 OK

Para configuração do endpoint, validação de assinatura e comportamento de novas tentativas, consulte Configurar webhooks.

Mensagem de texto enviada

Neste caso, seu endpoint de webhook recebeu uma mensagem de texto de saída enviada por um cliente comercial para um usuário do WhatsApp com o aplicativo WhatsApp Business ou dispositivo complementar compatível.:

Contém texto sem formatação enviado anteriormente.
Contém as informações da mensagem mencionada em context.

Requisição

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "image",
    "image": {
      "link": "https://api.ycloud.com/v2/whatsapp/media/download/5926236...",
      "id": "592623615738103",
      "sha256": "LeRpQJq/h4HTjm...",
      "mime_type": "image/jpeg"
    }
  }
}'

Resposta

Confirme a entrega após aceitar o evento de forma duradoura.

HTTP/1.1 200 OK

Explicação

Roteie o evento por type, desduplique-o por id e transfira tarefas lentas ou sujeitas a falhas para um processador assíncrono.

Mensagem de imagem enviada

Neste caso, seu endpoint de webhook recebeu uma mensagem de imagem de saída enviada por um cliente comercial para um usuário do WhatsApp com o aplicativo WhatsApp Business ou dispositivo complementar compatível.:

Contém a imagem enviada anteriormente.

Requisição

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "image",
    "image": {
      "link": "https://api.ycloud.com/v2/whatsapp/media/download/5926236...",
      "id": "592623615738103",
      "sha256": "LeRpQJq/h4HTjm...",
      "mime_type": "image/jpeg"
    }
  }
}'

Resposta

Confirme a entrega após aceitar o evento de forma duradoura.

HTTP/1.1 200 OK

Explicação

O image.link pode ser acessado diretamente em poucos minutos para conveniência do consumidor, mas você sempre deve incluir um cabeçalho X-API-Key para baixar este arquivo dentro de 30 dias.

Mensagem de vídeo enviada

Neste caso, seu endpoint de webhook recebeu uma mensagem de vídeo de saída enviada por um cliente comercial para um usuário do WhatsApp com o aplicativo WhatsApp Business ou dispositivo complementar compatível.:

Contém o vídeo enviado anteriormente.

Requisição

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "video",
    "video": {
      "link": "https://api.ycloud.com/v2/whatsapp/media/download/5926236...",
      "id": "592623615738103",
      "sha256": "LeRpQJq/h4HTjm...",
      "mime_type": "video/mp4"
    }
  }
}'

Resposta

Confirme a entrega após aceitar o evento de forma duradoura.

HTTP/1.1 200 OK

Explicação

O video.link pode ser acessado diretamente em poucos minutos para conveniência do consumidor, mas você sempre deve incluir um cabeçalho X-API-Key para baixar este arquivo dentro de 30 dias.

Mensagem de áudio enviada

Neste caso, seu endpoint de webhook recebeu uma mensagem de áudio de saída enviada por um cliente comercial para um usuário do WhatsApp com o aplicativo WhatsApp Business ou dispositivo complementar compatível.:

Contém o áudio enviado anteriormente.

Requisição

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "audio",
    "audio": {
      "link": "https://api.ycloud.com/v2/whatsapp/media/download/5926236...",
      "id": "592623615738103",
      "sha256": "LeRpQJq/h4HTjm...",
      "mime_type": "audio/ogg; codecs=opus"
    }
  }
}'

Resposta

Confirme a entrega após aceitar o evento de forma duradoura.

HTTP/1.1 200 OK

Explicação

O audio.link pode ser acessado diretamente em poucos minutos para conveniência do consumidor, mas você sempre deve incluir um cabeçalho X-API-Key para baixar este arquivo dentro de 30 dias.

Mensagem de documento enviada

Neste caso, seu endpoint de webhook recebeu uma mensagem de documento de saída enviada por um cliente comercial para um usuário do WhatsApp com o aplicativo WhatsApp Business ou dispositivo complementar compatível.:

Contém o documento enviado anteriormente.

Requisição

curl 'https://YOUR-WEBHOOK-ENDPOINT-URL' \
-H 'Content-Type: application/json' \
-d '{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "document",
    "document": {
      "link": "https://api.ycloud.com/v2/whatsapp/media/download/5926236...",
      "id": "592623615738103",
      "caption": "图片",
      "sha256": "LeRpQJq/h4HTjm...",
      "mime_type": "image/jpeg"
    }
  }
}'

Resposta

Confirme a entrega após aceitar o evento de forma duradoura.

HTTP/1.1 200 OK

Explicação

O document.link pode ser acessado diretamente em poucos minutos para conveniência do consumidor, mas você sempre deve incluir um cabeçalho X-API-Key para baixar este arquivo dentro de 30 dias.

Primeiros passos

Guias

Endpoints

Webhooks

Exemplos de Webhooks de sincronização de mensagens enviadas do WhatsApp Business App

O que é

Antes de começar

Como funciona

Requisição

Resposta

Mensagem de texto enviada

Requisição

Resposta

Explicação

Mensagem de imagem enviada

Requisição

Resposta

Explicação

Mensagem de vídeo enviada

Requisição

Resposta

Explicação

Mensagem de áudio enviada

Requisição

Resposta

Explicação

Mensagem de documento enviada

Requisição

Resposta

Explicação

​O que é

​Antes de começar

​Como funciona

​Requisição

​Resposta

​Mensagem de texto enviada

​Requisição

​Resposta

​Explicação

​Mensagem de imagem enviada

​Requisição

​Resposta

​Explicação

​Mensagem de vídeo enviada

​Requisição

​Resposta

​Explicação

​

​Mensagem de áudio enviada

​Requisição

​Resposta

​Explicação

​Mensagem de documento enviada

​Requisição

​Resposta

​Explicação

O que é

Antes de começar

Como funciona

Requisição

Resposta

Mensagem de texto enviada

Requisição

Resposta

Explicação

Mensagem de imagem enviada

Requisição

Resposta

Explicação

Mensagem de vídeo enviada

Requisição

Resposta

Explicação

Mensagem de áudio enviada

Requisição

Resposta

Explicação

Mensagem de documento enviada

Requisição

Resposta

Explicação