> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Exemplos de Webhook de Mensagem Recebida do WhatsApp
> Manipule tipos de mensagens recebidas do WhatsApp com exemplos de payload anotados.
Para o catálogo completo derivado do esquema, consulte [todos os exemplos](/pt/api-reference/guides/examples/webhook-examples/webhook-payload-examples).
## O que é
Manipule tipos de mensagens recebidas do WhatsApp com exemplos de payload anotados.
## 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 com segurança.
* Torne o processamento de eventos idempotente.
## Como funciona
A YCloud envia uma requisição HTTP `POST` quando o evento ocorre. Valide a assinatura, registre o evento de forma durável, retorne uma resposta `2xx` e processe tarefas lentas de forma assíncrona.
## Requisição
Os cenários abaixo mostram requisições entregues à sua 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 theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
Para configuração do endpoint, validação de assinatura e comportamento de novas tentativas, consulte [Configurar webhooks](/pt/api-reference/guides/api-fundamentals/configure-webhooks).
## Mensagem recebida não suportada
Neste caso, seu endpoint de webhook recebeu uma mensagem recebida não suportada:
* `type` está definido como `unsupported`.
* `errors` explica por que a mensagem não é suportada ou está indisponível.
* `unsupported.type` identifica a categoria da mensagem, como `poll_creation`, `poll_update`, `edit` ou `pin`.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* O erro `131051` com `Message type unknown` significa que a API Cloud do WhatsApp não suporta o tipo de mensagem.
* O erro `131060` com `This message is currently unavailable.` significa que o WhatsApp não conseguiu fornecer o conteúdo da mensagem.
* `unsupported.type` identifica a categoria geral. Ele não contém o conteúdo original da mensagem.
* Consulte [Mensagens não suportadas na Inbox](/pt/documentation/inbox/unsupported-messages-in-inbox) para obter uma lista legível dos tipos de mensagens. Consulte a [referência de webhook de mensagens não suportadas da Meta](https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/reference/messages/unsupported) para ver o contrato de payload atual.
## Mensagem de texto recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de texto recebida:
* Contém texto simples enviado pelo usuário.
* Contém as informações da mensagem mencionada em `context`.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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..."
}
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* **Mensagens recebidas são aquelas enviadas de clientes para os números de telefone da sua empresa.**
* O campo `context` (opcional) contém as informações da mensagem mencionada, normalmente utilizado para responder a uma mensagem anterior enviada pelo usuário ou pela sua empresa.
* `context.from` é o ID do WhatsApp (número de telefone sem o prefixo '+') do usuário que enviou a mensagem mencionada.
* `context.id` é o ID original da mensagem mencionada na plataforma do WhatsApp, começando com `wamid.`.
## Mensagem de texto recebida acionada por clique em Anúncios do WhatsApp
Neste caso, seu endpoint de webhook recebeu uma mensagem de texto recebida acionada por clique em Anúncios do WhatsApp:
* Contém texto simples.
* Contém informações sobre o anúncio.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* O campo `referral` contém informações sobre o anúncio. Consulte também [Anúncios de Clique para o WhatsApp](https://www.facebook.com/business/help/447934475640650).
## Mensagem de imagem recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de imagem recebida:
* Contém uma URL de imagem.
* Contém legenda para descrever esta imagem.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* A `image.link` pode ser acessada diretamente em poucos minutos para conveniência do consumidor, mas você deve sempre incluir um cabeçalho `X-API-Key` para baixar este arquivo dentro de 30 dias.
## Mensagem de vídeo recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de vídeo recebida:
* Contém uma URL de vídeo.
* Contém legenda para descrever este vídeo.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* A `video.link` pode ser acessada diretamente em poucos minutos para conveniência do consumidor, mas você deve sempre incluir um cabeçalho `X-API-Key` para baixar este arquivo dentro de 30 dias.
## Mensagem de áudio recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de áudio recebida:
* Contém uma URL de áudio.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* A `audio.link` pode ser acessada diretamente em poucos minutos para conveniência do consumidor, mas você deve sempre incluir um cabeçalho `X-API-Key` para baixar este arquivo dentro de 30 dias.
## Mensagem de documento recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de documento recebida:
* Contém uma URL de documento.
* Contém legenda para descrever este documento.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* A `document.link` pode ser acessada diretamente em poucos minutos para conveniência do consumidor, mas você deve sempre incluir um cabeçalho `X-API-Key` para baixar este arquivo dentro de 30 dias.
## Mensagem de figurinha recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de figurinha recebida:
* Contém uma URL de figurinha.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}'
```
### Resposta
Confirme o recebimento após aceitar o evento de forma duradoura.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* O `sticker.link` pode ser acessado diretamente em alguns minutos para conveniência do consumidor, mas você deve sempre incluir um cabeçalho `X-API-Key` para baixar esse arquivo em até 30 dias.
## Mensagem de localização recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de localização recebida:
* Contém latitude e longitude do local.
* Contém nome, endereço e URL do local.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}'
```
### Resposta
Confirme o recebimento após aceitar o evento de forma duradoura.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
Roteie o evento por `type`, deduplique-o por `id` e mova tarefas lentas ou propensas a falhas para um processador assíncrono.
## Mensagem de contatos recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de contatos recebida:
* Contém um contato com endereços, data de nascimento, e-mails, nome, telefones e outros campos de contato.
* Contém `origin: contact_request` quando o usuário compartilhou o contato em resposta a uma mensagem de solicitação de informações de contato.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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": "",
"city": "",
"state": "",
"zip": "",
"country": "",
"country_code": "",
"type": "HOME"
}
],
"birthday": "2001-01-01",
"emails": [
{
"email": "joe@example.com",
"type": "WORK"
}
],
"name": {
"formatted_name": "",
"first_name": "",
"last_name": "",
"middle_name": "",
"suffix": "",
"prefix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"phone": "+447901614024",
"wa_id": "447901614024",
"type": "WORK"
}
],
"origin": "contact_request",
"urls": [
{
"url": "",
"type": "WORK"
}
]
}
]
}
}'
```
### Resposta
Confirme o recebimento após aceitar o evento de forma duradoura.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
Roteie o evento por `type`, deduplique-o por `id` e mova tarefas lentas ou propensas a falhas para um processador assíncrono.
## Mensagem de reação recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de reação recebida:
* Contém o ID da mensagem à qual o usuário reagiu.
* Contém o emoji.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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": "👍"
}
}
}'
```
### Resposta
Confirme o recebimento após aceitar o evento de forma duradoura.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* O `emoji` está presente quando o usuário reage a uma mensagem com um emoji. Se não estiver, indica que o usuário removeu o emoji de uma mensagem.
## Mensagem de botão de modelo recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de botão de modelo recebida:
* Contém o botão `text` do modelo que você usou ao enviar uma mensagem de modelo.
* Contém o botão `payload` fornecido por você ao enviar uma mensagem de modelo.
* Contém o wamid (`context.wamid`) da mensagem de modelo que você enviou.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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..."
}
}
}'
```
### Resposta
Confirme o recebimento após aceitar o evento de forma duradoura.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
Roteie o evento por `type`, deduplique-o por `id` e mova tarefas lentas ou propensas a falhas para um processador assíncrono.
## Mensagem interativa de resposta de lista recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem interativa de resposta de lista recebida:
* O campo `interactive` contém a resposta da lista na qual o usuário clicou em uma mensagem interativa que você enviou anteriormente.
* O campo `context` contém informações sobre a mensagem interativa enviada anteriormente ao usuário.
 Clique no botão para selecionar um item.
 O destinatário responde à sua mensagem selecionando um dos itens na mensagem interativa enviada anteriormente.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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": "",
"title": "",
"description": ""
}
},
"context": {
"from": "447901614024",
"id": "wamid.HBgNODr..."
}
}
}'
```
### Resposta
Confirme o recebimento após aceitar o evento de forma duradoura.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* O `context` contém informações sobre a mensagem interativa que você enviou anteriormente.
* `context.from` é o WhatsApp ID (número de telefone sem o prefixo '+') de quem enviou a mensagem interativa.
* `context.id` é o ID original da mensagem na plataforma do WhatsApp, começando com `wamid.`.
## Mensagem interativa de resposta de botão recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem interativa de resposta de botão recebida:
* O campo `interactive` contém a resposta de botão na qual o usuário clicou em uma mensagem interativa que você enviou anteriormente.
* O campo `context` contém informações sobre a mensagem interativa enviada anteriormente ao usuário.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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": "",
"title": ""
}
},
"context": {
"from": "447901614024",
"id": "wamid.HBgNODr..."
}
}
}'
```
### Resposta
Confirme o recebimento após aceitar o evento de forma duradoura.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* O `context` contém informações sobre a mensagem interativa que você enviou anteriormente.
* `context.from` é o WhatsApp ID (número de telefone sem o prefixo '+') de quem enviou a mensagem interativa.
* `context.id` é o ID original da mensagem na plataforma do WhatsApp, começando com `wamid.`.
## Mensagem interativa de resposta de fluxo recebida
Após a conclusão do fluxo, uma mensagem de resposta será enviada para a conversa do WhatsApp. Você a receberá da mesma forma que recebe todas as outras mensagens do usuário — via webhook de mensagem. O campo `response_json` conterá dados específicos do fluxo.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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\": \"\", \"optional_param1\": \"\", \"optional_param2\": \"\"}"
}
},
"context": {
"from": "447901614024",
"id": "wamid.HBgNODr..."
}
}
}'
```
### Resposta
Confirme o recebimento após aceitar o evento de forma duradoura.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* `interactive.type` é sempre `nfm_reply`. `interactive.name` é sempre `flow`. `interactive.body` é sempre `Sent`.
* `interactive.response_json` são dados específicos do fluxo. A estrutura é definida no JSON do fluxo (consulte [Complete action](https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson#complete-action)) ou, se o fluxo estiver usando um endpoint, controlada pelo endpoint (consulte Final Response Payload em [Data Exchange Request](https://developers.facebook.com/docs/whatsapp/flows/guides/implementingyourflowendpoint#data_exchange_request)). Analise a string JSON `interactive.response_json` para um objeto JSON, onde o tipo de dados dos seus valores pode variar. Normalmente, os valores são texto simples, exceto:
* Quando originado de um componente [CheckboxGroup](https://developers.facebook.com/docs/whatsapp/flows/reference/components#checkbox), o valor é uma lista de strings.
* Quando se origina de um componente [OptIn](https://developers.facebook.com/docs/whatsapp/flows/reference/components#opt), o valor é um booleano, ou seja, `true` ou `false`. Atualmente, se presente, o valor deve ser `true`, já que nenhuma chave desse tipo será incluída no `response_json` se o usuário não tiver optado por participar.
* Quando se origina de um componente [DatePicker](https://developers.facebook.com/docs/whatsapp/flows/reference/components#dp), o valor é uma string que representa o timestamp Unix em milissegundos, como `"1725936737548"` (ou seja, 2024-09-10T02:52:17.548Z). A partir da [versão 5.0 do Flow JSON](https://developers.facebook.com/docs/whatsapp/flows/changelogs#august-13th--2024-release), as datas serão definidas no formato "yyyy-MM-dd", o que torna os valores independentes de fusos horários.
* Para enviar uma mensagem com um Flow, consulte [Mensagem de modelo de Flow](/pt/api-reference/guides/examples/api-examples/whatsapp-messaging-examples#flow-template-message) e [Mensagem interativa de Flow](/pt/api-reference/guides/examples/api-examples/whatsapp-messaging-examples#interactive-flow-message).
## Mensagem de sistema recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de sistema recebida:
* O `type` está definido como `system`, e o `system.type` está definido como `user_changed_number`.
* Um usuário altera seu número de telefone no WhatsApp, e `wa_id` é o novo WhatsApp ID (número de telefone sem o prefixo `+`).
* `user_id` é o novo BSUID. `parent_user_id` só é incluído quando os BSUIDs pai estão habilitados.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
Roteie o evento por `type`, deduplique-o por `id` e transfira trabalhos lentos ou propensos a falhas para um processador assíncrono.
## Mensagem de pedido recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de pedido recebida quando um cliente adiciona um ou mais produtos ao carrinho e envia um pedido:
* Contém informações sobre o produto solicitado.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
Roteie o evento por `type`, deduplique-o por `id` e transfira trabalhos lentos ou propensos a falhas para um processador assíncrono.
## Mensagem de consulta de produto recebida
Neste caso, seu endpoint de webhook recebeu uma mensagem de texto recebida quando um cliente consulta um produto:
* Contém informações sobre o produto.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* Uma mensagem de consulta de produto é recebida quando um usuário solicita mais informações sobre um produto específico. Elas podem ser recebidas em dois cenários:
* Quando um cliente responde a [Mensagens de produto único ou de múltiplos produtos](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/sell-products-and-services/share-products).
* Quando um cliente acessa o catálogo de uma empresa por outro ponto de entrada, navega até uma página de detalhes do produto e clica em Enviar mensagem à empresa sobre este produto.
## Mensagem de solicitação de boas-vindas recebida
Você pode ser notificado por webhook sempre que um usuário do WhatsApp abrir uma conversa com você pela primeira vez. Isso pode ser útil se você quiser responder a esses usuários com uma mensagem de boas-vindas especial personalizada por você.
Se você ativar esse recurso e um usuário abrir uma conversa, normalmente quando o usuário toca em um [link universal](https://faq.whatsapp.com/425247423114725) (links **wa.me** ou **api.whatsapp.com** ), o cliente do WhatsApp verifica se há um histórico de mensagens existente entre o usuário e o número de telefone da sua empresa. Se não houver, o cliente aciona um webhook `request_welcome`. Você pode então responder ao usuário com sua própria mensagem de boas-vindas.
### Requisição
```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
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"
}
}'
```
### Resposta
Confirme a entrega após aceitar o evento de forma durável.
```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```
### Explicação
* Para ativar este recurso para um número de telefone, navegue até Meta **Gerenciador do WhatsApp** > **Números de telefone** > **Configurações** > **Automações**.
* Para testar a mensagem `request_welcome`, caso já tenha uma conversa em andamento com o número de telefone da empresa, você deve primeiro excluir a conversa.
* Este recurso aciona apenas uma mensagem recebida `request_welcome` e não responde a nenhuma mensagem automaticamente. Cabe a você decidir se deseja responder com uma mensagem de boas-vindas.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.