whatsapp-docs-mcp 1.0.5 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -139
- package/docs/ativos_da_conta/outros_ativos/display_names.md +9 -9
- package/docs/ativos_da_conta/outros_ativos/official_business_accounts.md +27 -27
- package/docs/ativos_da_conta/telefones_comerciais/phone_numbers.md +151 -27
- package/docs/business_profiles.md +72 -0
- package/docs/business_scoped_user_ids.md +1533 -0
- package/docs/dados_privacidade_e_politica/encryption.md +1 -1
- package/docs/flows/changelog.md +6 -6
- package/docs/flows/gettingstarted/health_insurance.md +12 -6
- package/docs/flows/gettingstarted/personalised_offer.md +6 -6
- package/docs/flows/gettingstarted/pre_approved_loan.md +6 -6
- package/docs/flows/gettingstarted/purchase_intent.md +2 -2
- package/docs/flows/gettingstarted.md +5 -5
- package/docs/flows/guias.md +1 -1
- package/docs/flows/playground.md +1 -1
- package/docs/flows/referencia.md +1 -1
- package/docs/flows/support.md +3 -3
- package/docs/flows.md +2 -2
- package/docs/insights/analytics.md +200 -66
- package/docs/ligacoes/call_settings.md +129 -57
- package/docs/ligacoes/calling.md +33 -16
- package/docs/ligacoes/integration_examples.md +526 -0
- package/docs/ligacoes/pricing.md +11 -300
- package/docs/ligacoes/sandbox.md +160 -0
- package/docs/ligacoes/video_calling.md +8 -0
- package/docs/mensagens/interactive_media_carousel_messages.md +256 -0
- package/docs/mensagens/interactive_product_carousel_messages.md +181 -0
- package/docs/mensagens/limites_de_mensagens/messaging_limits.md +16 -12
- package/docs/mensagens/recursos_adicionais/media.md +15 -16
- package/docs/mensagens/recursos_adicionais/payload_encryption.md +1 -1
- package/docs/mensagens/tipos_de_mensagens/audio_messages.md +11 -11
- package/docs/mensagens/tipos_de_mensagens/interactive_flow_messages.md +1 -1
- package/docs/mensagens/tipos_de_mensagens/message_with_link.md +1 -1
- package/docs/mensagens_de_marketing/changelog.md +299 -0
- package/docs/mensagens_de_marketing/features.md +184 -0
- package/docs/mensagens_de_marketing/implementacao/get_started.md +17 -21
- package/docs/mensagens_de_marketing/implementacao/send_marketing_messages.md +50 -45
- package/docs/mensagens_de_marketing/measure_conversion.md +132 -0
- package/docs/mensagens_de_marketing/onboarding.md +282 -0
- package/docs/mensagens_de_marketing/recursos/automatic_creative_optimization.md +1 -1
- package/docs/mensagens_de_marketing/recursos/conversion_measurement.md +1 -1
- package/docs/mensagens_de_marketing/visao_geral/overview.md +11 -9
- package/docs/messaging_limits/upcoming_changes.md +1 -1
- package/docs/modelos/authentication_templates/bulk_management.md +145 -0
- package/docs/modelos/authentication_templates/template_preview.md +109 -0
- package/docs/modelos/gerenciamento_de_modelos/components.md +23 -23
- package/docs/modelos/gerenciamento_de_modelos/template_media.md +1 -1
- package/docs/modelos/modelos_de_marketing/marketing_templates.md +20 -20
- package/docs/modelos/modelos_de_marketing/per_user_limits.md +7 -5
- package/docs/modelos/portfolio_pacing.md +30 -0
- package/docs/modelos/visao_geral/overview.md +17 -17
- package/docs/pagamentos/payments_br/cards.md +8 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/transferring_wabas_to_customers.md +1 -1
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_business_app_users.md +364 -75
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/overview.md +34 -30
- package/docs/parceiros/migrate_existing_whatsapp_number_to_a_business_account.md +40 -0
- package/docs/parceiros/obo_model_deprecation.md +32 -0
- package/docs/parceiros/seja_um_parceiro/get_started_for_solution_partners.md +42 -42
- package/docs/parceiros/seja_um_parceiro/get_started_for_tech_providers.md +38 -142
- package/docs/recado/precos/pricing.md +82 -50
- package/docs/recado/precos/pricing_authentication_international_rates.md +16 -18
- package/docs/recado/precos/pricing_updates_to_pricing.md +1 -1
- package/docs/recado/sobre_a_plataforma/about_the_platform.md +80 -24
- package/docs/recado/sobre_a_plataforma/access_tokens.md +19 -19
- package/docs/referencia/bot_do_whatsapp_business/bot_details_api.md +4 -758
- package/docs/referencia/business/add_phone_numbers_api.md +4 -722
- package/docs/referencia/business/business_account_api.md +8 -0
- package/docs/referencia/business/client_whatsapp_business_accounts_api.md +4 -1002
- package/docs/referencia/business/owned_whatsapp_business_accounts.md +4 -798
- package/docs/referencia/business/whatsapp_business_accounts_api.md +4 -1546
- package/docs/referencia/business/whatsapp_business_partner_onboarding_to_mm_lite_api.md +4 -779
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_number_sharing_api.md +4 -786
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_numbers_api.md +4 -882
- package/docs/referencia/changelog.md +1837 -3
- package/docs/referencia/conta_do_whatsapp_business/assigned_users_management_api.md +4 -2198
- package/docs/referencia/conta_do_whatsapp_business/business_account_api.md +4 -263
- package/docs/referencia/conta_do_whatsapp_business/business_account_extended_credits_api.md +4 -271
- package/docs/referencia/conta_do_whatsapp_business/conversational_automation_api.md +4 -778
- package/docs/referencia/conta_do_whatsapp_business/flows_api.md +4 -1528
- package/docs/referencia/conta_do_whatsapp_business/in_progress_on_behalf_requests_api.md +1 -1
- package/docs/referencia/conta_do_whatsapp_business/migration_intent_api.md +4 -1577
- package/docs/referencia/conta_do_whatsapp_business/obo_mobility_intent_api.md +1 -1
- package/docs/referencia/conta_do_whatsapp_business/phone_number_management_api.md +4 -1682
- package/docs/referencia/conta_do_whatsapp_business/schedules_api.md +4 -1768
- package/docs/referencia/conta_do_whatsapp_business/set_obo_mobility_intent_api.md +1 -1
- package/docs/referencia/conta_do_whatsapp_business/set_solution_migration_intent_api.md +1 -1
- package/docs/referencia/conta_do_whatsapp_business/subscribed_apps_api.md +4 -2174
- package/docs/referencia/conta_do_whatsapp_business/template_api.md +4 -972
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_activities_api.md +4 -838
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_api.md +4 -1380
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_solutions_list_api.md +4 -850
- package/docs/referencia/groups/groups_invite_link_api.md +8 -0
- package/docs/referencia/groups/groups_join_requests_api.md +8 -0
- package/docs/referencia/groups/groups_participants_api.md +8 -0
- package/docs/referencia/groups/groups_query_api.md +8 -0
- package/docs/referencia/grupo/groups_invite_link_api.md +4 -300
- package/docs/referencia/grupo/groups_join_requests_api.md +4 -682
- package/docs/referencia/grupo/groups_participants_api.md +4 -270
- package/docs/referencia/grupo/groups_query_api.md +4 -432
- package/docs/referencia/historico_de_mensagens/whatsapp_business_message_history_events_api.md +4 -862
- package/docs/referencia/inscricao/application_connected_client_businesses.md +4 -808
- package/docs/referencia/inscricao/application_solutions_api.md +4 -870
- package/docs/referencia/inscricao/solution_creation_api.md +4 -820
- package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/migration_intent_details_api.md +4 -720
- package/docs/referencia/midias/media_api.md +4 -338
- package/docs/referencia/midias/media_download_api.md +4 -156
- package/docs/referencia/numero_da_conta_do_whatsapp/whatsapp_account_number_api.md +4 -774
- package/docs/referencia/perfil_do_whatsapp_business/whatsapp_business_profile_node_api.md +4 -1490
- package/docs/referencia/solucao_do_whatsapp_business/accept_deactivation_request_api.md +4 -758
- package/docs/referencia/solucao_do_whatsapp_business/access_token_api.md +4 -700
- package/docs/referencia/solucao_do_whatsapp_business/reject_deactivation_request_api.md +4 -808
- package/docs/referencia/solucao_do_whatsapp_business/send_deactivation_request_api.md +4 -774
- package/docs/referencia/solucao_do_whatsapp_business/solution_accept_api.md +4 -808
- package/docs/referencia/solucao_do_whatsapp_business/solution_details_api.md +4 -764
- package/docs/referencia/solucao_do_whatsapp_business/solution_reject_api.md +4 -794
- package/docs/referencia/telefone_do_whatsapp_business/block_api.md +4 -538
- package/docs/referencia/telefone_do_whatsapp_business/business_compliance_information_api.md +4 -1604
- package/docs/referencia/telefone_do_whatsapp_business/business_encryption_api.md +4 -1398
- package/docs/referencia/telefone_do_whatsapp_business/calling_api.md +4 -594
- package/docs/referencia/telefone_do_whatsapp_business/encrypted_messages_api.md +4 -478
- package/docs/referencia/telefone_do_whatsapp_business/groups_management_api.md +4 -481
- package/docs/referencia/telefone_do_whatsapp_business/marketing_messages_lite_api.md +4 -311
- package/docs/referencia/telefone_do_whatsapp_business/media_upload_api.md +4 -184
- package/docs/referencia/telefone_do_whatsapp_business/message_api.md +4 -1794
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_api.md +4 -373
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_deregister_api.md +4 -710
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_registration.md +4 -776
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_verification_request_code_api.md +4 -730
- package/docs/referencia/telefone_do_whatsapp_business/register_api.md +4 -407
- package/docs/referencia/telefone_do_whatsapp_business/settings_api.md +4 -670
- package/docs/referencia/telefone_do_whatsapp_business/verify_code_api.md +4 -742
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_message_history_api.md +4 -928
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_official_business_account_status_api.md +4 -1536
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_phone_number_api.md +4 -1596
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_profile_api.md +4 -1474
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_api.md +4 -1175
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_management_api.md +4 -1311
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/request_verification_code_api.md +4 -774
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/verify_code_api.md +4 -764
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_api.md +4 -1378
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_partners_api.md +4 -816
- package/docs/referencia/usuario/assigned_whatsapp_business_accounts_api.md +4 -860
- package/docs/referencia/webhooks/whatsapp_incoming_webhook_payload.md +4 -1651
- package/docs/referencia/whatsapp_business_account/extended_credits_api.md +8 -0
- package/docs/referencia/whatsapp_business_phone_number/commerce_settings_api.md +8 -0
- package/docs/suporte/error_codes.md +88 -89
- package/docs/suporte/migrating_from_onprem_to_cloud.md +222 -0
- package/docs/suporte/support.md +77 -186
- package/docs/suporte.md +77 -186
- package/docs/throughput.md +60 -0
- package/docs/upcoming_messaging_limits_changes.md +132 -0
- package/docs/visao_geral/overview.md +354 -306
- package/docs/webhooks/create_webhook_endpoint.md +158 -0
- package/docs/webhooks/reference/messages/group.md +182 -0
- package/docs/webhooks/referencia/account_update.md +27 -27
- package/docs/webhooks/referencia/messages/status.md +35 -35
- package/docs/webhooks/visao_geral/message_echoes.md +1 -1
- package/docs/webhooks/visao_geral/overview.md +23 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,20 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# WhatsApp Business API Docs - MCP Server
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[](https://www.npmjs.com/package/whatsapp-docs-mcp)
|
|
5
|
-
[](https://nodejs.org/)
|
|
3
|
+
Servidor MCP (Model Context Protocol) que fornece acesso completo à documentação da WhatsApp Business API para assistentes de IA como Claude e Cursor.
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
## 🚀 Como Usar
|
|
8
6
|
|
|
9
|
-
|
|
7
|
+
### Configuração MCP (Cursor e Claude Desktop)
|
|
10
8
|
|
|
11
|
-
|
|
9
|
+
Tanto o **Cursor** quanto o **Claude Desktop** usam o mesmo método de configuração MCP:
|
|
12
10
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
11
|
+
1. **Edite o arquivo de configuração MCP:**
|
|
12
|
+
- **Cursor**: `~/.cursor/mcp.json` ou via Settings > Features > MCP
|
|
13
|
+
- **Claude Desktop (macOS)**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
14
|
+
- **Claude Desktop (Windows)**: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
16
15
|
|
|
17
|
-
|
|
16
|
+
2. **Adicione a configuração do servidor MCP:**
|
|
18
17
|
|
|
19
18
|
```json
|
|
20
19
|
{
|
|
@@ -24,158 +23,67 @@ Add to Claude Desktop config (`~/Library/Application Support/Claude/claude_deskt
|
|
|
24
23
|
"args": ["whatsapp-docs-mcp"],
|
|
25
24
|
"env": {
|
|
26
25
|
"MCP_MODE": "stdio",
|
|
27
|
-
"LOG_LEVEL": "error"
|
|
28
|
-
"DISABLE_CONSOLE_OUTPUT": "true"
|
|
26
|
+
"LOG_LEVEL": "error"
|
|
29
27
|
}
|
|
30
28
|
}
|
|
31
29
|
}
|
|
32
30
|
}
|
|
33
31
|
```
|
|
34
32
|
|
|
35
|
-
**
|
|
36
|
-
|
|
37
|
-
See [MCP_SETUP.md](./MCP_SETUP.md) for detailed setup instructions.
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
# Documentação WhatsApp Business API
|
|
42
|
-
|
|
43
|
-
Esta é a documentação completa da WhatsApp Business API, organizada de forma hierárquica para facilitar o desenvolvimento e o uso por sistemas de IA.
|
|
44
|
-
|
|
45
|
-
## 📚 Estrutura da Documentação
|
|
46
|
-
|
|
47
|
-
A documentação está organizada em seções principais:
|
|
33
|
+
3. **Reinicie o Cursor ou Claude Desktop**
|
|
48
34
|
|
|
49
|
-
|
|
50
|
-
-
|
|
51
|
-
-
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
-
-
|
|
35
|
+
4. **Pronto!** Agora você pode usar as ferramentas MCP diretamente:
|
|
36
|
+
- `search_documentation` - Buscar na documentação
|
|
37
|
+
- `get_document_by_path` - Obter documento específico
|
|
38
|
+
- `get_endpoint_reference` - Referência de endpoint
|
|
39
|
+
- `get_error_code_info` - Informações sobre códigos de erro
|
|
40
|
+
- `get_quick_reference` - Referência rápida de operações comuns
|
|
55
41
|
|
|
56
|
-
|
|
42
|
+
### Método Alternativo: Usar arquivos diretamente
|
|
57
43
|
|
|
58
|
-
|
|
44
|
+
Se preferir não usar MCP, você pode adicionar os arquivos diretamente no chat:
|
|
59
45
|
|
|
60
|
-
1. **Configuração Inicial**: Veja [Começar](./docs/comecar/get_started.md)
|
|
61
|
-
2. **Primeira Mensagem**: Siga o guia em [Mensagens > Visão Geral](./docs/mensagens/visao_geral/)
|
|
62
|
-
3. **Configurar Webhooks**: [Webhooks > Visão Geral](./docs/webhooks/visao_geral/)
|
|
63
|
-
|
|
64
|
-
### Para Usar com Cursor AI 🤖
|
|
65
|
-
|
|
66
|
-
**⚡ Início Rápido**: Veja [INICIO_RAPIDO.md](./INICIO_RAPIDO.md)
|
|
67
|
-
|
|
68
|
-
**📖 Guias Completos**:
|
|
69
|
-
- [Passo a Passo Detalhado](./PASSO_A_PASSO_CURSOR.md) - Como usar no Cursor
|
|
70
|
-
- [Guia de Contexto](./CURSOR_CONTEXT_GUIDE.md) - Guia completo de uso
|
|
71
|
-
- [Integração em Projetos](./INTEGRACAO_PROJETOS.md) - Como integrar em outros projetos
|
|
72
|
-
- [Usar SEM Copiar Arquivos](./USAR_SEM_COPIAR.md) - Workspace multi-root
|
|
73
|
-
- [Usar com Feature "Docs"](./USAR_COM_DOCS_FEATURE.md) - Servir localmente via HTTP ⭐
|
|
74
|
-
- [Snippets Prontos](./CURSOR_SNIPPETS.md) - Comandos prontos para copiar
|
|
75
|
-
|
|
76
|
-
**Uso Básico no Cursor:**
|
|
77
|
-
|
|
78
|
-
**Método 1: Adicionar arquivos diretamente**
|
|
79
46
|
```
|
|
80
|
-
@AGENTS.md # Índice principal
|
|
81
|
-
@docs/QUICK_REFERENCE.md # Referência rápida
|
|
47
|
+
@AGENTS.md # Índice principal da documentação
|
|
48
|
+
@docs/QUICK_REFERENCE.md # Referência rápida de endpoints
|
|
82
49
|
```
|
|
83
50
|
|
|
84
|
-
|
|
85
|
-
```bash
|
|
86
|
-
# 1. Servir localmente
|
|
87
|
-
npm run serve
|
|
88
|
-
# ou
|
|
89
|
-
./scripts/serve_docs.sh
|
|
90
|
-
|
|
91
|
-
# 2. No Cursor > Docs > Add Doc
|
|
92
|
-
# URL: http://localhost:8000/AGENTS.md
|
|
93
|
-
```
|
|
51
|
+
## 📚 Documentação
|
|
94
52
|
|
|
95
|
-
|
|
53
|
+
A documentação está organizada em `docs/` com os seguintes arquivos principais:
|
|
96
54
|
|
|
97
|
-
|
|
98
|
-
-
|
|
99
|
-
-
|
|
100
|
-
-
|
|
55
|
+
- **`AGENTS.md`** - Índice principal com links para todas as seções
|
|
56
|
+
- **`docs/QUICK_REFERENCE.md`** - Referência rápida de endpoints e exemplos
|
|
57
|
+
- **`docs/comecar/get_started.md`** - Guia para começar
|
|
58
|
+
- **`docs/mensagens/`** - Documentação sobre mensagens
|
|
59
|
+
- **`docs/webhooks/`** - Webhooks e notificações
|
|
60
|
+
- **`docs/referencia/`** - Referência completa da API
|
|
61
|
+
- **`docs/suporte/`** - Códigos de erro e troubleshooting
|
|
101
62
|
|
|
102
|
-
|
|
63
|
+
Cada pasta contém um arquivo `AGENTS.md` com índice e links para facilitar a navegação.
|
|
103
64
|
|
|
104
|
-
|
|
65
|
+
## 🔧 Instalação Local (Desenvolvimento)
|
|
105
66
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
- Os arquivos `AGENTS.md` fornecem contexto e estrutura
|
|
112
|
-
- Documentos markdown contêm a documentação completa
|
|
113
|
-
- Links relativos facilitam a navegação programática
|
|
114
|
-
|
|
115
|
-
## 🔑 Endpoints Principais
|
|
116
|
-
|
|
117
|
-
### Enviar Mensagens
|
|
118
|
-
- **Texto**: `POST /v23.0/{phone-number-id}/messages`
|
|
119
|
-
- **Mídia**: Ver [Mensagens > Tipos de Mensagens](./docs/mensagens/tipos_de_mensagens/)
|
|
120
|
-
- **Templates**: Ver [Modelos](./docs/modelos/)
|
|
121
|
-
|
|
122
|
-
### Webhooks
|
|
123
|
-
- **Configurar**: Ver [Webhooks > Visão Geral](./docs/webhooks/visao_geral/)
|
|
124
|
-
- **Referência**: Ver [Webhooks > Referência](./docs/webhooks/referencia/)
|
|
125
|
-
|
|
126
|
-
### Gerenciamento
|
|
127
|
-
- **Contas**: Ver [Referência > Conta do WhatsApp Business](./docs/referencia/conta_do_whatsapp_business/)
|
|
128
|
-
- **Números**: Ver [Referência > Telefone do WhatsApp Business](./docs/referencia/telefone_do_whatsapp_business/)
|
|
129
|
-
|
|
130
|
-
## 📝 Casos de Uso Comuns
|
|
131
|
-
|
|
132
|
-
1. **Enviar Mensagem de Texto**: [Mensagens > Texto](./docs/mensagens/tipos_de_mensagens/text_messages.md)
|
|
133
|
-
2. **Enviar Imagem**: [Mensagens > Imagem](./docs/mensagens/tipos_de_mensagens/image_messages.md)
|
|
134
|
-
3. **Configurar Webhook**: [Webhooks > Visão Geral](./docs/webhooks/visao_geral/overview.md)
|
|
135
|
-
4. **Criar Template**: [Modelos > Gerenciamento](./docs/modelos/gerenciamento_de_modelos/)
|
|
136
|
-
5. **Tratar Erros**: [Suporte > Códigos de Erro](./docs/suporte/error_codes.md)
|
|
137
|
-
|
|
138
|
-
## 🛠️ Recursos Adicionais
|
|
67
|
+
```bash
|
|
68
|
+
# Clone o repositório
|
|
69
|
+
git clone https://github.com/yvfl/api-whatsapp-docs.git
|
|
70
|
+
cd api-whatsapp-docs
|
|
139
71
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
- **Preços**: [Recado > Preços](./docs/recado/precos/)
|
|
72
|
+
# Instale as dependências
|
|
73
|
+
npm install
|
|
143
74
|
|
|
144
|
-
|
|
75
|
+
# Compile o projeto
|
|
76
|
+
npm run build
|
|
145
77
|
|
|
78
|
+
# Execute os testes
|
|
79
|
+
npm test
|
|
146
80
|
```
|
|
147
|
-
docs/
|
|
148
|
-
├── AGENTS.md # Índice principal
|
|
149
|
-
├── visao_geral/ # Visão geral da plataforma
|
|
150
|
-
├── comecar/ # Guias de início rápido
|
|
151
|
-
├── mensagens/ # Documentação de mensagens
|
|
152
|
-
│ ├── tipos_de_mensagens/ # Tipos específicos
|
|
153
|
-
│ ├── limites_de_mensagens/ # Limites e restrições
|
|
154
|
-
│ └── recursos_adicionais/ # Recursos extras
|
|
155
|
-
├── webhooks/ # Webhooks e notificações
|
|
156
|
-
├── referencia/ # Referência completa da API
|
|
157
|
-
└── suporte/ # Suporte e troubleshooting
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
## 🤖 Para Desenvolvimento com IA
|
|
161
|
-
|
|
162
|
-
Esta documentação foi estruturada para facilitar o uso por sistemas de IA:
|
|
163
|
-
|
|
164
|
-
1. **Estrutura Hierárquica**: Organização clara por funcionalidade
|
|
165
|
-
2. **AGENTS.md**: Cada pasta tem um índice com contexto
|
|
166
|
-
3. **Links Relativos**: Facilita navegação programática
|
|
167
|
-
4. **Documentação Completa**: Todos os endpoints e recursos documentados
|
|
168
|
-
|
|
169
|
-
## 📞 Suporte
|
|
170
81
|
|
|
171
|
-
- **Códigos de Erro**: [Suporte > Códigos de Erro](./docs/suporte/error_codes.md)
|
|
172
|
-
- **Status da API**: [Suporte > API Status Page](./docs/suporte/api_status_page.md)
|
|
173
|
-
- **Testes**: [Suporte > Load Testing](./docs/suporte/load_testing.md)
|
|
174
82
|
|
|
175
|
-
##
|
|
83
|
+
## 🤝 Contribuindo
|
|
176
84
|
|
|
177
|
-
|
|
85
|
+
Contribuições são bem-vindas! Por favor, abra uma issue ou pull request.
|
|
178
86
|
|
|
179
|
-
|
|
87
|
+
## 📄 Licença
|
|
180
88
|
|
|
181
|
-
|
|
89
|
+
MIT License
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/display-names -->
|
|
2
|
-
<!-- Scraped:
|
|
2
|
+
<!-- Scraped: 2026-01-24T00:31:18.155Z -->
|
|
3
3
|
|
|
4
4
|
# Nomes de exibição
|
|
5
5
|
|
|
6
|
-
Updated:
|
|
6
|
+
Updated: 12 de dez de 2025
|
|
7
7
|
|
|
8
|
-
É preciso fornecer um nome de exibição ao [registrar](
|
|
8
|
+
É preciso fornecer um nome de exibição ao [registrar](/documentation/business-messaging/whatsapp/business-phone-numbers/registration) um número de telefone comercial. O nome de exibição aparece no perfil do WhatsApp do seu número de telefone comercial:
|
|
9
9
|
|
|
10
|
-

|
|
11
11
|
|
|
12
12
|
Esse nome também poderá aparecer no topo de **conversas individuais** e da **lista de conversas** se o número de telefone comercial for aprovado por meio da [verificação de nome de exibição](#display-name-verification). Observe que, se um usuário editar seu nome de perfil no cliente do WhatsApp, o nome definido por ele será exibido em vez do seu.
|
|
13
13
|
|
|
14
14
|
## Diretrizes para nomes de exibição
|
|
15
15
|
|
|
16
|
-
Consulte nosso artigo [Diretrizes para nomes de exibição na Plataforma do WhatsApp Business](https://www.facebook.com/business/help/757569725593362)
|
|
16
|
+
Consulte nosso artigo da Central de Ajuda [Diretrizes para nomes de exibição na Plataforma do WhatsApp Business](https://www.facebook.com/business/help/757569725593362) para saber mais sobre a nomenclatura.
|
|
17
17
|
|
|
18
18
|
## Verificação do nome de exibição
|
|
19
19
|
|
|
@@ -42,7 +42,7 @@ curl 'https://graph.facebook.com/v24.0/106540352242922?fields=verified_name%2Cna
|
|
|
42
42
|
|
|
43
43
|
### Exemplo de resposta
|
|
44
44
|
|
|
45
|
-
Caso
|
|
45
|
+
Caso o pedido seja bem-sucedido:
|
|
46
46
|
|
|
47
47
|
```
|
|
48
48
|
{ "verified_name": "Lucky Shrub", "name_status": "APPROVED", "id": "106540352242922"}
|
|
@@ -52,7 +52,7 @@ Caso a solicitação seja bem-sucedida:
|
|
|
52
52
|
|
|
53
53
|
Para atualizar seu nome de exibição via Gerenciador do WhatsApp:
|
|
54
54
|
|
|
55
|
-
- Acesse [Gerenciador do WhatsApp](https://business.facebook.com/latest/whatsapp_manager/) > **Ferramentas da conta** > **Números de telefone**.- Selecione
|
|
55
|
+
- Acesse [Gerenciador do WhatsApp](https://business.facebook.com/latest/whatsapp_manager/) > **Ferramentas da conta** > **Números de telefone**.- Selecione o número de telefone da empresa.- Clique na aba **Perfil**.- Na seção **Nome de exibição**, clique no botão **Editar** e complete o fluxo.
|
|
56
56
|
|
|
57
57
|
Após concluir o fluxo, seu nome de exibição passará pelo [processo de verificação](#display-name-verification) novamente.
|
|
58
58
|
|
|
@@ -71,7 +71,7 @@ curl -X POST 'https://graph.facebook.com/v24.0/106540352242922?new_display_name=
|
|
|
71
71
|
|
|
72
72
|
### Exemplo de resposta
|
|
73
73
|
|
|
74
|
-
Caso
|
|
74
|
+
Caso o pedido seja bem-sucedido:
|
|
75
75
|
|
|
76
76
|
```
|
|
77
77
|
{ "success": true}
|
|
@@ -87,7 +87,7 @@ curl 'https://graph.facebook.com/v23.0/106540352242922?fields=new_display_name,
|
|
|
87
87
|
|
|
88
88
|
### Exemplo de resposta
|
|
89
89
|
|
|
90
|
-
Caso
|
|
90
|
+
Caso o pedido seja bem-sucedido:
|
|
91
91
|
|
|
92
92
|
```
|
|
93
93
|
{ "new_display_name": "New Lucky Shrub", "new_name_status": "PENDING_REVIEW", "id": "106540352242922"}
|
|
@@ -1,68 +1,68 @@
|
|
|
1
1
|
<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/official-business-accounts -->
|
|
2
|
-
<!-- Scraped:
|
|
2
|
+
<!-- Scraped: 2026-01-24T00:42:27.952Z -->
|
|
3
3
|
|
|
4
4
|
# Contas comerciais oficiais
|
|
5
5
|
|
|
6
|
-
Updated:
|
|
6
|
+
Updated: 12 de dez de 2025
|
|
7
7
|
|
|
8
|
-
Uma conta comercial oficial (OBA
|
|
8
|
+
Uma conta comercial oficial (OBA) é um número de telefone comercial de propriedade de uma empresa que foi verificada como uma marca autêntica e notável, de acordo com [critérios](#eligibility) específicos. Os números de telefone comerciais de contas comerciais oficiais exibem um selo de verificação azul ao lado do nome na visualização de contatos.
|
|
9
9
|
|
|
10
|
-

|
|
11
11
|
|
|
12
|
-
Você pode solicitar o status de
|
|
12
|
+
Você pode solicitar o status de conta comercial oficial de um número de telefone comercial usando o Gerenciador do WhatsApp ou a API. Depois de analisarmos sua solicitação, você receberá uma notificação informando se o número de telefone da sua empresa recebeu o status de número de conta comercial oficial ou não. Se a sua solicitação for rejeitada, é possível enviar uma nova solicitação após 30 dias.
|
|
13
13
|
|
|
14
|
-
Não concedemos status de
|
|
14
|
+
Não concedemos status de conta comercial oficial a funcionários de empresas, contas de teste nem números de telefone do app WhatsApp Business.
|
|
15
15
|
|
|
16
16
|
## Qualificação
|
|
17
17
|
|
|
18
|
-
Para se qualificar para uma
|
|
18
|
+
Para se qualificar para uma conta comercial oficial, os seguintes critérios devem ser atendidos:
|
|
19
19
|
|
|
20
|
-
-
|
|
20
|
+
- A empresa precisa estar em conformidade com a [Política de Mensagens do WhatsApp Business](https://l.facebook.com/l.php?u=https%3A%2F%2Fbusiness.whatsapp.com%2Fpolicy&h=AT1Hvgw4c4ql22F_Jgp-y3AcPsfKWtuh_RTEZz-m1gtJgJeJnEm_MWGj2QDYg3_RJR3gQ3W9iPbabbKn7vQr5e2kRCDG501Iwkk6ymKC6dINZTqmjQMOeNiKITjQ3OyH1BqVwYZNC_YvrLGOFYVHGzG-O2o).- A empresa deve estar registrada na Plataforma do WhatsApp Business há pelo menos 30 dias.- A empresa precisa representar uma empresa, marca ou entidade [notável](#notability), bem conhecida e frequentemente pesquisada.- O portfólio empresarial proprietário do número deve ter sido verificado por meio da [verificação da empresa](https://www.facebook.com/business/help/2058515294227817).- O número de telefone comercial deve ter habilitado a [confirmação em duas etapas](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers#two-step-verification).- O nome de exibição do número de telefone comercial precisa ter sido [aprovado](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers#display-name-verification).
|
|
21
21
|
|
|
22
|
-
Se você atende aos critérios acima, mas não vê uma opção para se candidatar a uma
|
|
22
|
+
Se você atende aos critérios acima, mas não vê uma opção para se candidatar a uma conta comercial oficial no [Gerenciador do WhatsApp](http://business.facebook.com/wa/manage/), fale com o seu ponto de contato da Meta, o suporte do Provedor de Soluções ou o Suporte da Meta para verificar se você se qualifica para o processo de inscrição.
|
|
23
23
|
|
|
24
|
-
**Observação:** se o número de telefone comercial não for uma conta comercial oficial
|
|
24
|
+
**Observação:** se o número de telefone comercial não for uma conta comercial oficial, ele não aparecerá nos resultados da pesquisa quando os usuários o procurarem no app WhatsApp. No entanto, se um usuário adicionar o número aos próprios contatos, o nome de exibição aparecerá nos resultados de pesquisa. Para facilitar a descoberta, recomendamos que você solicite o status de conta comercial oficial.
|
|
25
25
|
|
|
26
26
|
## Notabilidade
|
|
27
27
|
|
|
28
|
-
A notabilidade exige que uma empresa represente uma marca ou entidade bastante conhecida ou pesquisada.
|
|
28
|
+
A notabilidade exige que uma empresa represente uma marca ou entidade bastante conhecida ou pesquisada. Isso não deve ser interpretado como um sinal de autenticidade da empresa.
|
|
29
29
|
|
|
30
|
-
Por outro lado, a notabilidade
|
|
30
|
+
Por outro lado, a notabilidade indica uma presença substancial em artigos de notícias online. Ela é avaliada com base na presença de uma conta em publicações de grandes públicos. Na análise, não são considerados os conteúdos pagos ou promocionais, incluindo listas de empresas e apps.
|
|
31
31
|
|
|
32
|
-
O status de
|
|
32
|
+
O status de número da conta comercial oficial é emitido no nível do número de telefone comercial e do nome de exibição. Avaliamos a notabilidade do nome de exibição do número de telefone comercial que solicita o status. Se o nome de exibição for alterado depois de receber o status de número de conta comercial oficial, será necessário reavaliar o novo nome de exibição em relação à notabilidade e à [conformidade com o nome de exibição](https://www.facebook.com/business/help/338047025165344).
|
|
33
33
|
|
|
34
|
-

|
|
35
35
|
|
|
36
|
-
Além disso, aprovações anteriores de status de
|
|
36
|
+
Além disso, aprovações anteriores de status de conta comercial oficial para outros números de telefone comerciais de propriedade de uma determinada conta do WhatsApp Business não garantem a aprovação de todos os números pertencentes a essa mesma conta. Se a conta do WhatsApp Business tiver uma marca principal e o número de telefone associado atender aos requisitos de notabilidade, recomendamos que você atualize os nomes de exibição das marcas secundárias da seguinte forma: {{sub-brand name}} por {{notable name}}.
|
|
37
37
|
|
|
38
38
|
## Solicitações negadas
|
|
39
39
|
|
|
40
|
-
Uma solicitação negada significa que nossa equipe analisou sua conta e determinou que ela não está qualificada para o status de número
|
|
40
|
+
Uma solicitação negada significa que nossa equipe analisou sua conta e determinou que ela não está qualificada para o status de número de conta comercial oficial. No momento, não é possível fazer uma apelação dessa decisão. Você pode continuar expandindo a presença empresarial e aguardar 30 dias antes de enviar outra solicitação.
|
|
41
41
|
|
|
42
|
-

|
|
43
43
|
|
|
44
44
|
Entretanto, essa decisão não limita a capacidade de compartilhar as informações da empresa. Cada número de telefone comercial também tem um perfil empresarial com foto, email, site e descrição da empresa. Esses campos podem ser editados a qualquer momento.
|
|
45
45
|
|
|
46
|
-
## Como solicitar status de
|
|
46
|
+
## Como solicitar status de conta comercial oficial por meio do Gerenciador do WhatsApp
|
|
47
47
|
|
|
48
|
-

|
|
49
49
|
|
|
50
50
|
- Acesse [**Gerenciador do WhatsApp**](https://business.facebook.com/latest/whatsapp_manager/) > **Visão geral** e clique no número de telefone comercial:
|
|
51
51
|
|
|
52
|
-

|
|
53
53
|
|
|
54
54
|
- Habilite a confirmação em duas etapas caso o recurso ainda não tenha sido ativado.
|
|
55
55
|
|
|
56
|
-

|
|
57
57
|
|
|
58
58
|
- Clique no botão **Enviar solicitação** e preencha o formulário.
|
|
59
|
-
- Para comprovar que sua empresa é notável, é possível enviar até 5 links de publicações renomadas (por exemplo, India Today, Economic Times, Wall Street Journal, Reuters, Wikipedia, Business Insider).- Campos como país de operação, empresa ou marca principal (em especial para marcas conhecidas) e idioma contribuem ao nosso entendimento sobre sua marca e a elegibilidade para
|
|
59
|
+
- Para comprovar que sua empresa é notável, é possível enviar até 5 links de publicações renomadas (por exemplo, India Today, Economic Times, Wall Street Journal, Reuters, Wikipedia, Business Insider).- Campos como país de operação, empresa ou marca principal (em especial para marcas conhecidas) e idioma principal contribuem ao nosso entendimento sobre sua marca e a elegibilidade para conta comercial oficial.
|
|
60
60
|
|
|
61
|
-

|
|
62
62
|
|
|
63
|
-
## Como solicitar status de
|
|
63
|
+
## Como solicitar status de conta comercial oficial via API
|
|
64
64
|
|
|
65
|
-
Use o ponto de extremidade [POST /<WHATSAPP\_BUSINESS\_PHONE\_NUMBER\_ID>/official\_business\_account](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/whatsapp-business-account-official-business-account-status-api#Creating) para enviar uma solicitação de status de
|
|
65
|
+
Use o ponto de extremidade [POST /<WHATSAPP\_BUSINESS\_PHONE\_NUMBER\_ID>/official\_business\_account](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/whatsapp-business-account-official-business-account-status-api#Creating) para enviar uma solicitação de status de conta comercial oficial para seu número de telefone comercial.
|
|
66
66
|
|
|
67
67
|
### Exemplo de solicitação
|
|
68
68
|
|
|
@@ -97,9 +97,9 @@ Caso a solicitação seja bem-sucedida:
|
|
|
97
97
|
|
|
98
98
|
Observe que `true` não indica aprovação, apenas envio bem-sucedido.
|
|
99
99
|
|
|
100
|
-
## Como receber o status de
|
|
100
|
+
## Como receber o status de conta comercial oficial via API
|
|
101
101
|
|
|
102
|
-
Use o ponto de extremidade [GET /<WHATSAPP\_BUSINESS\_PHONE\_NUMBER\_ID>](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/whatsapp-business-account-official-business-account-status-api#Reading) para solicitar o campo `official_business_account` no seu número de telefone comercial para receber o status de uma solicitação de
|
|
102
|
+
Use o ponto de extremidade [GET /<WHATSAPP\_BUSINESS\_PHONE\_NUMBER\_ID>](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/whatsapp-business-account-official-business-account-status-api#Reading) para solicitar o campo `official_business_account` no seu número de telefone comercial para receber o status de uma solicitação de conta comercial oficial.
|
|
103
103
|
|
|
104
104
|
### Exemplo de solicitação
|
|
105
105
|
|