whatsapp-docs-mcp 1.0.0

package/docs/webhooks/referencia/messages/location.md

@@ -0,0 +1,296 @@
+<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/reference/messages/location -->
+<!-- Scraped: 2025-12-20T17:37:44.483Z -->
+
+# Referência do webhook de mensagens de localização
+
+Updated: 22 de out de 2025
+
+Esta referência descreve os eventos de gatilho e o conteúdo da carga do webhook de **mensagens** da conta do WhatsApp Business para mensagens com informações de localização.
+
+## Gatilhos
+
+-   Um usuário do WhatsApp envia uma mensagem de localização para uma empresa.-   Um usuário do WhatsApp envia uma localização a uma empresa por meio de um anúncio de clique para o WhatsApp.
+
+## Sintaxe
+
+```
+{
+  "object": "whatsapp_business_account",
+  "entry": [
+    {
+      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
+      "changes": [
+        {
+          "value": {
+            "messaging_product": "whatsapp",
+            "metadata": {
+              "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
+              "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
+            },
+            "contacts": [
+              {
+                "profile": {
+                  "name": "<WHATSAPP_USER_PROFILE_NAME>"
+                },
+                "wa_id": "<WHATSAPP_USER_ID>",
+                "identity_key_hash": "<IDENTITY_KEY_HASH>" <!-- only included if identity change check enabled -->
+              }
+            ],
+            "messages": [
+              {
+                "from": "<WHATSAPP_USER_PHONE_NUMBER>",
+                "id": "<WHATSAPP_MESSAGE_ID>",
+                "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
+                "location": {
+                  "address": "<LOCATION_ADDRESS>",
+                  "latitude": <LOCATION_LATITUDE>,
+                  "longitude": <LOCATION_LONGITUDE>,
+                  "name": "<LOCATION_NAME>",
+                  "url": "<LOCATION_URL>"
+                },
+                "type": "location",
+
+                <!-- only included if message sent via a Click to WhatsApp ad -->
+                "referral": {
+                  "source_url": "<AD_URL>",
+                  "source_id": "<AD_ID>",
+                  "source_type": "ad",
+                  "body": "<AD_PRIMARY_TEXT>",
+                  "headline": "<AD_HEADLINE>",
+                  "media_type": "<AD_MEDIA_TYPE>",
+                  "image_url": "<AD_IMAGE_URL>",
+                  "video_url": "<AD_VIDEO_URL>",
+                  "thumbnail_url": "<AD_VIDEO_THUMBNAIL>",
+                  "ctwa_clid": "<AD_CLICK_ID>",
+                  "welcome_message": {
+                    "text": "<AD_GREETING_TEXT>"
+                  }
+                }
+              }
+            ]
+          },
+          "field": "messages"
+        }
+      ]
+    }
+  ]
+}
+```
+
+## Parâmetros
+
+Espaço reservado
+
+Descrição
+
+Valor de exemplo
+
+`<AD_CLICK_ID>`
+
+_String_
+
+Identificação do clique em um anúncio de clique para o WhatsApp.
+
+A propriedade `ctwa_clid` é totalmente omitida para mensagens originadas de um anúncio no Status do WhatsApp ([posicionamentos de anúncio no Status do WhatsApp](https://www.facebook.com/business/help/1074444721456755)).
+
+`Aff-n8ZTODiE79d22KtAwQKj9e_mIEOOj27vDVwFjN80dp4_0NiNhEgpGo0AHemvuSoifXaytfTzcchptiErTKCqTrJ5nW1h7IHYeYymGb5K5J5iTROpBhWAGaIAeUzHL50`
+
+`<AD_GREETING_TEXT>`
+
+_String_
+
+Texto de saudação do anúncio de clique para o WhatsApp.
+
+`Hi there! Let us know how we can help!`
+
+`<AD_HEADLINE>`
+
+_String_
+
+Título do anúncio de clique para o WhatsApp.
+
+`Chat with us`
+
+`<AD_ID>`
+
+_String_
+
+Identificação do anúncio de clique para o WhatsApp.
+
+`120226305854810726`
+
+`<AD_IMAGE_URL>`
+
+_String_
+
+URL da imagem do anúncio de clique para o WhatsApp. Incluído apenas se o anúncio for do tipo imagem.
+
+`https://scontent.xx.fbcdn.net/v/t45.1...`
+
+`<AD_MEDIA_TYPE>`
+
+_String_
+
+Tipo de mídia do anúncio de clique para o WhatsApp. Os valores podem ser os seguintes:
+
+`image` – indica um anúncio de imagem.
+
+`video` – indica um anúncio em vídeo.
+
+`image`
+
+`<AD_PRIMARY_TEXT>`
+
+_String_
+
+Texto principal do anúncio de clique para o WhatsApp.
+
+`Summer succulents are here!`
+
+`<AD_URL>`
+
+_String_
+
+URL do anúncio de clique para o WhatsApp.
+
+`https://fb.me/3cr4Wqqkv`
+
+`<AD_VIDEO_THUMBNAIL>`
+
+_String_
+
+URL da miniatura de vídeo do anúncio de clique para o WhatsApp. Incluído apenas em anúncios em vídeo.
+
+`https://scontent.xx.fbcdn.net/v/t45.3...`
+
+`<AD_VIDEO_URL>`
+
+_String_
+
+URL do vídeo de anúncio de clique para o WhatsApp. Incluído apenas em anúncios em vídeo.
+
+`https://scontent.xx.fbcdn.net/v/t45.2...`
+
+`<BUSINESS_DISPLAY_PHONE_NUMBER>`
+
+_String_
+
+Número de telefone comercial exibido.
+
+`15550783881`
+
+`<BUSINESS_PHONE_NUMBER_ID>`
+
+_String_
+
+Identificação do número de telefone comercial.
+
+`106540352242922`
+
+`<IDENTITY_KEY_HASH>`
+
+_String_
+
+Hash de chave de identidade. Esse campo só será incluído se você tiver habilitado o recurso de [verificação de alteração de identidade](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers).
+
+`DF2lS5v2W6x=`
+
+`<LOCATION_ADDRESS>`
+
+_String_
+
+Endereço da localização.
+
+`101 Forest Ave, Palo Alto, CA 94301`
+
+`<LOCATION_LATITUDE>`
+
+_Flutuante_
+
+Latitude da localização em graus decimais.
+
+`37.44221496582`
+
+`<LOCATION_LONGITUDE>`
+
+_Flutuante_
+
+Longitude da localização em graus decimais.
+
+`-122.16165924072`
+
+`<LOCATION_NAME>`
+
+_String_
+
+Nome da localização.
+
+`Philz Coffee`
+
+`<LOCATION_URL>`
+
+_String_
+
+URL da localização. Geralmente incluído apenas para pontos comerciais.
+
+`https://philzcoffee.com/`
+
+`<WEBHOOK_TRIGGER_TIMESTAMP>`
+
+_String_
+
+Registro de data e hora Unix que indica quando o webhook foi disparado.
+
+`1739321024`
+
+`<WHATSAPP_BUSINESS_ACCOUNT_ID>`
+
+_String_
+
+Identificação da conta do WhatsApp Business.
+
+`102290129340398`
+
+`<WHATSAPP_MESSAGE_ID>`
+
+_String_
+
+Identificação da mensagem do WhatsApp.
+
+`wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=`
+
+`<WHATSAPP_USER_ID>`
+
+_String_
+
+Número de identificação do usuário do WhatsApp. Vale observar que o número de identificação de um usuário do WhatsApp nem sempre coincide com seu número de telefone.
+
+`16505551234`
+
+`<WHATSAPP_USER_PHONE_NUMBER>`
+
+_String_
+
+Número de telefone do usuário do WhatsApp. É o mesmo valor retornado pela API como o valor de `input` ao enviar uma mensagem para um usuário do WhatsApp. Vale observar que a identificação de um usuário do WhatsApp nem sempre coincide com seu número de telefone.
+
+`+16505551234`
+
+`<WHATSAPP_USER_PROFILE_NAME>`
+
+_String_
+
+O nome de usuário do WhatsApp exibido no perfil do cliente na plataforma.
+
+`Sheena Nelson`
+
+## Exemplo
+
+```
+{  "object": "whatsapp_business_account",  "entry": [    {      "id": "102290129340398",      "changes": [        {          "value": {            "messaging_product": "whatsapp",            "metadata": {              "display_phone_number": "15550783881",              "phone_number_id": "106540352242922"            },            "contacts": [              {                "profile": {                  "name": "Sheena Nelson"                },                "wa_id": "16505551234"              }            ],            "messages": [              {                "from": "16505551234",                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=",                "timestamp": "1744344496",                "location": {                  "address": "101 Forest Ave, Palo Alto, CA 94301",                  "latitude": 37.44221496582,                  "longitude": -122.16165924072,                  "name": "Philz Coffee",                  "url": "https://philzcoffee.com/"                },                "type": "location"              }            ]          },          "field": "messages"        }      ]    }  ]}
+```
+
+Você achou esta página útil?
+
+![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
+
+![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)

package/docs/webhooks/referencia/messages/messages.md

@@ -0,0 +1,44 @@
+<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/reference/messages -->
+<!-- Scraped: 2025-12-20T17:36:34.105Z -->
+
+# referência de webhook de mensagens
+
+Updated: 22 de out de 2025
+
+O webhook **messages** descreve as mensagens enviadas de um usuário do WhatsApp para uma empresa, bem como o status das mensagens enviadas por uma empresa para um usuário do WhatsApp.
+
+## Estruturas de carga
+
+### Mensagens recebidas
+
+Os webhooks de mensagens que descrevem uma mensagem enviada por um usuário do WhatsApp (seja diretamente, por meio de um anúncio ou por meio de um componente da interface do usuário em uma mensagem recebida anteriormente) têm a mesma estrutura comum. Eles podem ser facilmente identificados, pois incluem uma matriz `messages`. Por exemplo, este webhook descreve um SMS enviado a uma empresa:
+
+```
+{  "object": "whatsapp_business_account",  "entry": [    {      "id": "102290129340398",      "changes": [        {          "value": {            "messaging_product": "whatsapp",            "metadata": {              "display_phone_number": "15550783881",              "phone_number_id": "106540352242922"            },            "contacts": [              {                "profile": {                  "name": "Sheena Nelson"                },                "wa_id": "16505551234"              }            ],            "messages": [              {                "from": "16505551234",                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQTRBNjU5OUFFRTAzODEwMTQ0RgA=",                "timestamp": "1749416383",                "type": "text"                "text": {                  "body": "Does it come in another color?"                }              }            ]          },          "field": "messages"        }      ]    }  ]}
+```
+
+Os objetos na matriz `messages` podem variar significativamente com base no tipo de mensagem (indicado pela propriedade `type` do objeto). Por isso, cada tipo de mensagem recebida tem uma referência dedicada, vinculada no menu à esquerda.
+
+### Mensagens de saída
+
+Os webhooks que descrevem uma mensagem enviada por uma empresa a um usuário do WhatsApp têm uma estrutura diferente. Eles podem ser identificados facilmente, pois incluem uma matriz `statuses`. Por exemplo, o webhook abaixo descreve uma mensagem que foi entregue ao dispositivo de um usuário do WhatsApp:
+
+```
+{  "object": "whatsapp_business_account",  "entry": [    {      "id": "102290129340398",      "changes": [        {          "value": {            "messaging_product": "whatsapp",            "metadata": {              "display_phone_number": "15550783881",              "phone_number_id": "106540352242922"            },            "statuses": [              {                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI3MTE5MjVBOTE3MDk5QUVFM0YA",                "status": "delivered",                "timestamp": "1750263773",                "recipient_id": "16505551234",                "conversation": {                  "id": "6ceb9d929c9bdc4f90e967a32f8639b4",                  "origin": {                    "type": "service"                  }                },                "pricing": {                  "billable": true,                  "pricing_model": "CBP",                  "category": "service"                }              }            ]          },          "field": "messages"        }      ]    }  ]}
+```
+
+Esses webhooks não descrevem o conteúdo da mensagem enviada, apenas o status dela. Além disso, cada mensagem enviada pode ter até três webhooks separados (um para o status "enviada", um para "entregue" e um para "lida").
+
+Os webhooks de status também contam com uma [referência dedicada](/documentation/business-messaging/whatsapp/webhooks/reference/messages/status).
+
+## Erros
+
+Os erros nos webhooks de mensagens podem ser exibidos em três locais:
+
+-   Os erros no nível do sistema, do app e da conta são exibidos como uma propriedade do objeto `value` (`entry.changes.value.errors`). Veja a referência sobre [erros](/documentation/business-messaging/whatsapp/webhooks/reference/messages/errors).-   Os erros de mensagem recebida aparecem na matriz `messages` (`entry.changes.value.messages.errors`). Nesses webhooks, `type` é definido como `unsupported`. Veja a referência sobre [incompatibilidade](/documentation/business-messaging/whatsapp/webhooks/reference/messages/unsupported).-   Os erros de mensagens enviadas aparecem na matriz `statuses` (`entry.changes.value.statuses.errors`). Veja a referência sobre [status](/documentation/business-messaging/whatsapp/webhooks/reference/messages/status).
+
+Você achou esta página útil?
+
+![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
+
+![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)

package/docs/webhooks/referencia/messages/order.md

@@ -0,0 +1,208 @@
+<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/reference/messages/order -->
+<!-- Scraped: 2025-12-20T17:37:51.341Z -->
+
+# Referência do webhook de mensagens de pedidos
+
+Updated: 22 de out de 2025
+
+Esta referência descreve os eventos de gatilho e o conteúdo da carga do webhook de **mensagens** da conta do WhatsApp Business para mensagens de pedidos.
+
+## Gatilhos
+
+-   Um usuário do WhatsApp pede um ou mais produtos por meio de uma mensagem de [catálogo, produto único ou vários produtos](/documentation/business-messaging/whatsapp/catalogs/sell-products-and-services).
+
+## Sintaxe
+
+```
+{
+  "object": "whatsapp_business_account",
+  "entry": [
+    {
+      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
+      "changes": [
+        {
+          "value": {
+            "messaging_product": "whatsapp",
+            "metadata": {
+              "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
+              "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
+            },
+            "contacts": [
+              {
+                "profile": {
+                  "name": "<WHATSAPP_USER_PROFILE_NAME>"
+                },
+                "wa_id": "<WHATSAPP_USER_ID>",
+                "identity_key_hash": "<IDENTITY_KEY_HASH>" <!-- only included if identity change check enabled -->
+              }
+            ],
+            "messages": [
+              {
+                "from": "<WHATSAPP_USER_PHONE_NUMBER>",
+                "id": "<WHATSAPP_MESSAGE_ID>",
+                "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
+                "type": "order",
+                "order": {
+                  "catalog_id": "<PRODUCT_CATALOG_ID>",
+                  "text": "<ORDER_TEXT>",
+                  "product_items": [
+                    {
+                      "product_retailer_id": "<PRODUCT_ID>",
+                      "quantity": <PRODUCT_QUANTITY>,
+                      "item_price": <PRODUCT_PRICE>,
+                      "currency": "<CURRENCY_CODE>"
+                    }
+                  ]
+                }
+              }
+            ]
+          },
+          "field": "messages"
+        }
+      ]
+    }
+  ]
+}
+```
+
+## Parâmetros
+
+Espaço reservado
+
+Descrição
+
+Valor de exemplo
+
+`<BUSINESS_DISPLAY_PHONE_NUMBER>`
+
+_String_
+
+Número de telefone comercial exibido.
+
+`15550783881`
+
+`<BUSINESS_PHONE_NUMBER_ID>`
+
+_String_
+
+Identificação do número de telefone comercial.
+
+`106540352242922`
+
+`<CURRENCY_CODE>`
+
+_String_
+
+Código da moeda no catálogo.
+
+`USD`
+
+`<IDENTITY_KEY_HASH>`
+
+_String_
+
+Hash de chave de identidade. Esse campo só será incluído se você tiver habilitado o recurso de [verificação de alteração de identidade](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers).
+
+`DF2lS5v2W6x=`
+
+`<ORDER_TEXT>`
+
+_String_
+
+Texto que acompanha o pedido.
+
+`Love these!`
+
+`<PRODUCT_CATALOG_ID>`
+
+_String_
+
+[Identificação do catálogo de produtos](/documentation/business-messaging/whatsapp/catalogs/sell-products-and-services).
+
+`194836987003835`
+
+`<PRODUCT_ID>`
+
+_String_
+
+[Identificação do produto](/documentation/business-messaging/whatsapp/catalogs/sell-products-and-services).
+
+`di9ozbzfi4`
+
+`<PRODUCT_PRICE>`
+
+_Número inteiro_
+
+Preço do produto individual.
+
+`7.99`
+
+`<PRODUCT_QUANTITY>`
+
+_Número inteiro_
+
+Quantidade do produto.
+
+`2`
+
+`<WEBHOOK_TRIGGER_TIMESTAMP>`
+
+_String_
+
+Registro de data e hora Unix que indica quando o webhook foi disparado.
+
+`1739321024`
+
+`<WHATSAPP_BUSINESS_ACCOUNT_ID>`
+
+_String_
+
+Identificação da conta do WhatsApp Business.
+
+`102290129340398`
+
+`<WHATSAPP_MESSAGE_ID>`
+
+_String_
+
+Identificação da mensagem do WhatsApp.
+
+`wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=`
+
+`<WHATSAPP_USER_ID>`
+
+_String_
+
+Número de identificação do usuário do WhatsApp. Vale observar que o número de identificação de um usuário do WhatsApp nem sempre coincide com seu número de telefone.
+
+`16505551234`
+
+`<WHATSAPP_USER_PHONE_NUMBER>`
+
+_String_
+
+Número de telefone do usuário do WhatsApp. É o mesmo valor retornado pela API como o valor de `input` ao enviar uma mensagem para um usuário do WhatsApp. Vale observar que a identificação de um usuário do WhatsApp nem sempre coincide com seu número de telefone.
+
+`16505551234`
+
+`<WHATSAPP_USER_PROFILE_NAME>`
+
+_String_
+
+O nome de usuário do WhatsApp exibido no perfil do cliente na plataforma.
+
+`Sheena Nelson`
+
+## Exemplo
+
+Este exemplo de webhook descreve um pedido feito por um usuário do WhatsApp de três produtos por meio de uma mensagem de catálogo interativa.
+
+```
+{  "object": "whatsapp_business_account",  "entry": [    {      "id": "102290129340398",      "changes": [        {          "value": {            "messaging_product": "whatsapp",            "metadata": {              "display_phone_number": "15550783881",              "phone_number_id": "106540352242922"            },            "contacts": [              {                "profile": {                  "name": "Sheena Nelson"                },                "wa_id": "16505551234"              }            ],            "messages": [              {                "from": "16505551234",                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=",                "timestamp": "1750096325",                "type": "order",                "order": {                  "catalog_id": "194836987003835",                  "text": "Love these!",                  "product_items": [                    {                      "product_retailer_id": "di9ozbzfi4",                      "quantity": 2,                      "item_price": 30,                      "currency": "USD"                    },                    {                      "product_retailer_id": "nqryix03ez",                      "quantity": 1,                      "item_price": 25,                      "currency": "USD"                    }                  ]                }              }            ]          },          "field": "messages"        }      ]    }  ]}
+```
+
+Você achou esta página útil?
+
+![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
+
+![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)