whatsapp-docs-mcp 1.0.0

package/docs/webhooks/referencia/message_template_status_update.md

@@ -0,0 +1,253 @@
+<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/reference/message_template_status_update -->
+<!-- Scraped: 2025-12-20T17:36:28.187Z -->
+
+# Referência do webhook message\_template\_status\_update
+
+Updated: 14 de nov de 2025
+
+Esta referência descreve os eventos de gatilho e o conteúdo da carga do webhook `message_template_status_update` da conta do WhatsApp Business.
+
+O webhook **message\_template\_status\_update** notifica você sobre as alterações no status de um modelo existente.
+
+## Gatilhos
+
+-   Um modelo é aprovado.-   Um modelo é rejeitado.-   Um modelo é desabilitado.
+
+## Sintaxe
+
+```
+{
+  "entry": [
+    {
+      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
+      "time": <WEBHOOK_TRIGGER_TIMESTAMP>,
+      "changes": [
+        {
+          "value": {
+            "event": "<EVENT>",
+            "message_template_id": <TEMPLATE_ID>,
+            "message_template_name": "<TEMPLATE_NAME>",
+            "message_template_language": "<TEMPLATE_LANGUAGE_AND_LOCALE_CODE>",
+            "reason": "<REASON>",
+            "message_template_category": <TEMPLATE_CATEGORY>,
+
+            <!-- only included if template disabled -->
+            "disable_info": {
+              "disable_date": "<DISABLE_TIMESTAMP>"
+            },
+
+            <!-- only included if template locked or unlocked -->
+            "other_info": {
+              "title": "<TITLE>",
+              "description": "<DESCRIPTION>"
+            }
+          },
+
+            <!-- only included if template rejected with INVALID_FORMAT reason -->
+            "rejection_info": {
+              "reason": "<REASON_INFO>",
+              "recommendation": "<RECOMMENDATION_INFO>"
+            }
+          },
+          "field": "message_template_status_update"
+        }
+      ]
+    }
+  ],
+  "object": "whatsapp_business_account"
+}
+```
+
+## Parâmetros
+
+Espaço reservado
+
+Descrição
+
+Valor de exemplo
+
+`<DESCRIPTION>`
+
+_String_
+
+A string que descreve o motivo do bloqueio ou desbloqueio do modelo.
+
+Seu modelo de mensagem do WhatsApp foi retomado.
+
+`<DISABLE_TIMESTAMP>`
+
+_Número inteiro_
+
+Registro de data e hora UNIX que indica quando o modelo foi desabilitado.
+
+`1751234563`
+
+`<EVENT>`
+
+_String_
+
+Evento de status do modelo. Os valores podem ser os seguintes:
+
+`APPROVED` – indica que o modelo foi aprovado e pode ser enviado em mensagens de modelo.
+
+`ARCHIVED`: indica que o modelo foi arquivado para manter a lista de modelos no Gerenciador do WhatsApp limpa. `DELETED`: indica que o modelo foi excluído.
+
+`DISABLED`: indica que o modelo foi desabilitado devido ao [feedback](/documentation/business-messaging/whatsapp/templates/template-quality) do usuário.
+
+`FLAGGED`: indica que o modelo recebeu feedback negativo e está em risco de ser desabilitado.
+
+`IN_APPEAL`: indica que o modelo está em processo de [apelação](/documentation/business-messaging/whatsapp/templates/template-review#appeals).
+
+`LIMIT_EXCEEDED`: indica que o modelo de conta do WhatsApp Business está no [limite](/documentation/business-messaging/whatsapp/templates/overview).
+
+`LOCKED`: indica que o modelo foi bloqueado e não pode ser editado.
+
+`PAUSED`: indica que o modelo foi [pausado](/documentation/business-messaging/whatsapp/templates/template-pausing).
+
+`PENDING`: indica que o modelo está em análise.
+
+`REINSTATED` – indica que o modelo não está mais sinalizado ou desabilitado e pode ser enviado em mensagens de modelo novamente.
+
+`PENDING_DELETION` – indica que o modelo foi excluído por meio do Gerenciador do WhatsApp.
+
+`REJECTED`: indica que o modelo foi rejeitado. Você pode [editar o modelo](/documentation/business-messaging/whatsapp/templates/overview) para que ele passe pelo processo de análise novamente ou [fazer uma apelação](/documentation/business-messaging/whatsapp/templates/template-review#appeals) da rejeição.
+
+`APPROVED`
+
+`<TEMPLATE_ID>`
+
+_Número inteiro_
+
+ID do modelo.
+
+`1689556908129832`
+
+`<TEMPLATE_NAME>`
+
+_String_
+
+O nome do modelo.
+
+`order_confirmation`
+
+`<TEMPLATE_LANGUAGE_AND_LOCALE_CODE>`
+
+_String_
+
+O [código de localidade e idioma](/documentation/business-messaging/whatsapp/templates/supported-languages) do modelo.
+
+`en-US`
+
+`<REASON>`
+
+_String_
+
+O motivo da rejeição, caso o modelo tenha sido recusado.
+
+Se o modelo estiver programado para exclusão, o valor será `null` em vez de uma string. Caso contrário, estes podem ser os valores:
+
+`ABUSIVE_CONTENT`: indica que o modelo inclui conteúdo que viola nossas políticas.
+
+`CATEGORY_NOT_AVAILABLE` – (Obsoleto) indica um modelo de autenticação para uma região incompatível.
+
+`INCORRECT_CATEGORY` – indica que o conteúdo do modelo não corresponde à categoria atribuída no momento da criação.
+
+`INVALID_FORMAT` – indica que o modelo tem um formato inválido.
+
+`NONE` – indica que o modelo foi pausado.
+
+`PROMOTIONAL` – indica que o modelo inclui conteúdo que viola nossas políticas.
+
+`SCAM` – indica que o modelo inclui conteúdo que viola nossas políticas.
+
+`TAG_CONTENT_MISMATCH` – indica que o conteúdo do modelo não corresponde à categoria atribuída no momento da criação.
+
+`INVALID_FORMAT`
+
+`<TITLE>`
+
+_String_
+
+Título do evento de pausa ou retomada do modelo.
+
+Os valores podem ser os seguintes:
+
+`FIRST_PAUSE` – indica que o modelo foi pausado pela primeira vez.
+
+`SECOND_PAUSE` – indica que o modelo foi pausado pela segunda vez.
+
+`RATE_LIMITING_PAUSE` – indica que o modelo foi pausado devido à limitação de volume.
+
+`UNPAUSE` – indica que o modelo foi retomado.
+
+`DISABLED` – indica que o modelo foi desabilitado.
+
+`FIRST_PAUSE`
+
+`<WEBHOOK_TRIGGER_TIMESTAMP>`
+
+_Número inteiro_
+
+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`
+
+`<MESSAGE_TEMPLATE_CATEGORY>`
+
+_String_
+
+A categoria do modelo.
+
+Os valores podem ser os seguintes:
+
+`MARKETING`: indica que o modelo é categorizado como MARKETING.
+
+`UTILITY`: indica que o modelo é categorizado como UTILITÁRIO.
+
+`AUTHENTICATION`: indica que o modelo é categorizado como AUTENTICAÇÃO.
+
+`MARKETING`
+
+`<REASON_INFO>`
+
+_String_
+
+Fornece uma explicação detalhada sobre o motivo da rejeição do modelo. Esse campo descreve o problema específico detectado no conteúdo do modelo.
+
+`Your template has parameters placed next to each other (like {{1}}{{2}}) without text or punctuation between them.`
+
+`<RECOMMENDATION_INFO>`
+
+_String_
+
+Oferece orientações úteis sobre como modificar o modelo para resolver o motivo da rejeição. Esse campo sugere boas práticas para editar o conteúdo do modelo.
+
+`Separate parameters with descriptive text and ensure each parameter is clearly contextualized.`
+
+## Exemplo
+
+O exemplo de webhook descreve um modelo que foi aprovado.
+
+```
+{  "entry": [    {      "id": "102290129340398",      "time": 1751247548,      "changes": [        {          "value": {            "event": "APPROVED",            "message_template_id": 1689556908129832,            "message_template_name": "order_confirmation",            "message_template_language": "en-US",            "reason": "NONE",            "message_template_category": "UTILITY"          },          "field": "message_template_status_update"        }      ]    }  ],  "object": "whatsapp_business_account"}
+```
+
+O exemplo de webhook descreve um modelo que foi rejeitado com INVALID\_FORMAT.
+
+```
+{  "entry": [    {      "id": "102290129340398",      "time": 1751247548,      "changes": [        {          "value": {            "event": "REJECTED",            "message_template_id": 1689556908129835,            "message_template_name": "abandoned_cart",            "message_template_language": "en",            "reason": "INVALID_FORMAT"            "message_template_category": "MARKETING",            "rejection_info": {              "reason": "Your template has parameters placed next to each other (like {{1}}{{2}}) without text or punctuation between them.",              "recommendation": "Separate parameters with descriptive text and ensure each parameter is clearly contextualized."            }          },          "field": "message_template_status_update"        }      ]    }  ],  "object": "whatsapp_business_account"}
+```
+
+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/AGENTS.md

@@ -0,0 +1,24 @@
+# Mensagens
+
+Webhooks relacionados a mensagens
+
+## Documentos Disponíveis
+
+- [Audio](./audio.md)
+- [Button](./button.md)
+- [Contacts](./contacts.md)
+- [Document](./document.md)
+- [Errors](./errors.md)
+- [Image](./image.md)
+- [Interactive](./interactive.md)
+- [Location](./location.md)
+- [Messages](./messages.md)
+- [Order](./order.md)
+- [Reaction](./reaction.md)
+- [Status](./status.md)
+- [Sticker](./sticker.md)
+- [System](./system.md)
+- [Text](./text.md)
+- [Unsupported](./unsupported.md)
+- [Video](./video.md)
+

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

@@ -0,0 +1,298 @@
+<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/webhooks/reference/messages/audio -->
+<!-- Scraped: 2025-12-20T17:36:41.885Z -->
+
+# Referência do webhook de mensagens de áudio
+
+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 uma gravação de áudio.
+
+## Gatilhos
+
+-   Um usuário envia uma gravação ou um arquivo de áudio do WhatsApp para uma empresa.-   Um usuário do WhatsApp envia um arquivo ou uma gravação de áudio do WhatsApp 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>",
+                "type": "audio",
+                "audio": {
+                  "mime_type": "<MEDIA_ASSET_MIME_TYPE>",
+                  "sha256": "<MEDIA_ASSET_SHA256_HASH>",
+                  "id": "<MEDIA_ASSET_ID>",
+                  "url": "<MEDIA_ASSET_URL>",
+                  "voice": <IS_VOICE_RECORDING?>
+                },
+
+                <!-- 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 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=`
+
+`<IS_VOICE_RECORDING?>`
+
+_Booliano_
+
+Valor booliano que indica se o áudio é uma gravação feita com o recurso de gravação de voz do cliente do WhatsApp (`true`) ou não (`false`).
+
+`true`
+
+`<MEDIA_ASSET_ID>`
+
+_String_
+
+ID do ativo de mídia. É possível [fazer uma solicitação GET usando esse ID](/documentation/business-messaging/whatsapp/business-phone-numbers/media) para obter a URL do ativo e depois fazer uma solicitação GET na URL retornada (usando seu token de acesso) para acessar o ativo subjacente.
+
+`1003383421387256`
+
+`<MEDIA_ASSET_MIME_TYPE>`
+
+_String_
+
+Tipo MIME de ativo de mídia.
+
+`audio/ogg; codecs=opus`
+
+`<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. Talvez ela não esteja disponível para você imediatamente.**
+
+URL da mídia. É possível consultar essa 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": "audio",                "audio": {                  "mime_type": "audio/ogg; codecs=opus",                  "sha256": "wvqXMe6n7n1W0zphvLPoLj+s/NtKqmr3zZ7YzTP7xFI=",                  "id": "1908647269898587",                  "url": "https://lookaside.fbsbx.com/whatsapp_business/attachments/?mid=133...",                  "voice": true                }              }            ]          },          "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)