whatsapp-docs-mcp 1.0.0

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

@@ -0,0 +1,304 @@
+<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/reference/messages/image -->
+<!-- Scraped: 2025-12-20T17:37:24.159Z -->
+
+# Referência do webhook de mensagens de imagem
+
+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 imagem.
+
+## Gatilhos
+
+-   Um usuário do WhatsApp envia uma imagem para a empresa.-   Um usuário do WhatsApp encaminha uma mensagem de imagem para a empresa.-   Um usuário do WhatsApp encaminha uma [mensagem com botão de resposta interativa para uma empresa](/documentation/business-messaging/whatsapp/messages/interactive-reply-buttons-messages).-   Um usuário do WhatsApp envia uma imagem para a 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>",
+                "type": "image",
+                "image": {
+                  "caption": "<MEDIA_ASSET_CAPTION>",
+                  "mime_type": "<MEDIA_ASSET_MIME_TYPE>",
+                  "sha256": "<MEDIA_ASSET_SHA256_HASH>",
+                  "id": "<MEDIA_ASSET_ID>",
+                  "url": "<MEDIA_ASSET_URL>"
+                },
+
+                <!-- only included if message was forwarded to business by a user -->
+                "context": {
+                  "forwarded": true, <!-- only if forwarded 5 times or less -->
+                  "frequently_forwarded": true <!-- only if forwarded more than 5 times  -->
+                },
+
+                <!-- 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` é omitida em mensagens originadas de um anúncio no Status do WhatsApp ([posicionamentos de anúncios 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=`
+
+`<MEDIA_ASSET_CAPTION>`
+
+_String_
+
+Texto da legenda do ativo de mídia.
+
+`Taj Mahal`
+
+`<MEDIA_ASSET_ID>`
+
+_String_
+
+ID do ativo de mídia. É possível [fazer uma solicitação GET usando essa identificação](/documentation/business-messaging/whatsapp/business-phone-numbers/media) para obter o URL do ativo e depois fazer uma solicitação GET no URL retornado (usando seu token de acesso) para obter o ativo subjacente.
+
+`1003383421387256`
+
+`<MEDIA_ASSET_MIME_TYPE>`
+
+_String_
+
+Tipo MIME de ativo de mídia.
+
+`image/jpeg`
+
+`<MEDIA_ASSET_SHA256_HASH>`
+
+_String_
+
+Hash SHA-256 do ativo de mídia.
+
+`SfInY0gGKTsJlUWbwxC1k+FAD0FZHvzwfpvO0zX0GUI=`
+
+`<MEDIA_ASSET_URL>`
+
+_String_
+
+**Esta propriedade JSON será lançada para desenvolvedores de forma gradual nas próximas semanas, a partir de 12 de novembro de 2025, e talvez não esteja disponível para você imediatamente.**
+
+URL da mídia. É possível consultar esse URL diretamente com o token de acesso para [baixar o ativo de mídia](/documentation/business-messaging/whatsapp/business-phone-numbers/media#download-media).
+
+`https://lookaside.fbsbx.com/whatsapp_business/attachments/?mid=133...`
+
+`<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 o número de 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.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQTRBNjU5OUFFRTAzODEwMTQ0RgA=",                "timestamp": "1744344496",                "type": "image",                "image": {                  "caption": "Taj Mahal",                  "mime_type": "image/jpeg",                  "sha256": "SfInY0gGKTsJlUWbwxC1k+FAD0FZHvzwfpvO0zX0GUI=",                  "id": "1003383421387256",                  "url": "https://lookaside.fbsbx.com/whatsapp_business/attachments/?mid=133..."                }              }            ]          },          "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/interactive.md

@@ -0,0 +1,225 @@
+<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/reference/messages/interactive -->
+<!-- Scraped: 2025-12-20T17:37:37.231Z -->
+
+# Referência do webhook de mensagens interativas
+
+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 respostas a mensagens interativas.
+
+## Gatilhos
+
+-   Um usuário do WhatsApp toca em uma linha em uma [mensagem de lista interativa](/documentation/business-messaging/whatsapp/messages/interactive-list-messages).-   Um usuário do WhatsApp toca em um botão em uma [mensagem de botão de resposta interativa](/documentation/business-messaging/whatsapp/messages/interactive-reply-buttons-messages).
+
+## 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": [
+              {
+                "context": {
+                  "from": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
+                  "id": "<CONTEXTUAL_WHATSAPP_MESSAGE_ID>"
+                },
+                "from": "<WHATSAPP_USER_PHONE_NUMBER>",
+                "id": "<WHATSAPP_MESSAGE_ID>",
+                "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
+                "type": "interactive",
+
+                <!-- interactive list message replies only -->
+                "interactive": {
+                  "type": "list_reply",
+                  "list_reply": {
+                    "id": "<ROW_ID>",
+                    "title": "<ROW_TITLE>",
+                    "description": "<ROW_DESCRIPTION>"
+                  }
+                },
+
+                <!-- interactive reply button message replies only -->
+                "interactive": {
+                  "type": "button_reply",
+                  "button_reply": {
+                    "id": "<BUTTON_ID>",
+                    "title": "<BUTTON_LABEL_TEXT>"
+                  }
+                }
+              }
+            ]
+          },
+          "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`
+
+`<BUTTON_ID>`
+
+_String_
+
+ID do botão.
+
+`cancel-button`
+
+`<BUTTON_LABEL_TEXT>`
+
+_String_
+
+Texto do botão.
+
+`Cancel`
+
+`<CONTEXTUAL_WHATSAPP_MESSAGE_ID>`
+
+_String_
+
+ID da mensagem do WhatsApp que contém o botão em que o usuário do WhatsApp tocou.
+
+`wamid.HBgLMTQxMjU1NTA4MjkVAgASGBQzQUNCNjk5RDUwNUZGMUZEM0VBRAA=`
+
+`<IDENTITY_KEY_HASH>`
+
+_String_
+
+Hash de chave de identidade. Esse campo será incluído apenas se você tiver habilitado o recurso de [verificação de alteração de identidade](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers).
+
+`DF2lS5v2W6x=`
+
+`<ROW_DESCRIPTION>`
+
+_String_
+
+Descrição da linha.
+
+`Next Day to 2 Days`
+
+`<ROW_ID>`
+
+_String_
+
+ID da linha.
+
+`priority_express`
+
+`<ROW_TITLE>`
+
+_String_
+
+Título da linha.
+
+`Priority Mail Express`
+
+`<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 o número de 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`
+
+## Exemplos
+
+Este exemplo de webhook descreve uma seleção feita por um usuário em uma lista de linhas em uma mensagem interativa de lista.
+
+```
+{  "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": [              {                "context": {                  "from": "15550783881",                  "id": "wamid.HBgLMTQxMjU1NTA4MjkVAgASGBQzQUNCNjk5RDUwNUZGMUZEM0VBRAA="                },                "from": "16505551234",                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=",                "timestamp": "1749854575",                "type": "interactive",                "interactive": {                  "type": "list_reply",                  "list_reply": {                    "id": "priority_express",                    "title": "Priority Mail Express",                    "description": "Next Day to 2 Days"                  }                }              }            ]          },          "field": "messages"        }      ]    }  ]}
+```
+
+Este exemplo de webhook descreve um botão tocado por um usuário do WhatsApp em uma mensagem interativa com botões de resposta.
+
+```
+{  "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": [              {                "context": {                  "from": "15550783881",                  "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgARGBI3MEM2RUJFNkI0RENGQTVDRjUA"                },                "from": "16505551234",                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQTZBQzg0MzQ4QjRCM0NGNkVGOAA=",                "timestamp": "1750025136",                "type": "interactive",                "interactive": {                  "type": "button_reply",                  "button_reply": {                    "id": "cancel-button",                    "title": "Cancel"                  }                }              }            ]          },          "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)