whatsapp-docs-mcp 1.0.7 → 1.0.8
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 +1 -1
- package/docs/ativos_da_conta/telefones_comerciais/phone_numbers.md +40 -42
- package/docs/business_scoped_user_ids.md +855 -244
- package/docs/dados_privacidade_e_politica/encryption.md +1 -1
- package/docs/dados_privacidade_e_politica/local_storage.md +33 -33
- package/docs/flows/changelog.md +7 -7
- package/docs/flows/gettingstarted/health_insurance.md +8 -14
- package/docs/flows/gettingstarted/personalised_offer.md +8 -8
- package/docs/flows/gettingstarted/pre_approved_loan.md +8 -8
- package/docs/flows/gettingstarted/purchase_intent.md +3 -3
- package/docs/flows/gettingstarted.md +6 -6
- package/docs/flows/guias.md +2 -2
- package/docs/flows/playground.md +2 -2
- package/docs/flows/referencia.md +2 -2
- package/docs/flows/support.md +4 -4
- package/docs/flows.md +7 -7
- package/docs/insights/analytics.md +130 -28
- package/docs/ligacoes/sip.md +53 -97
- package/docs/ligacoes/video_calling.md +1 -1
- package/docs/mensagens/interactive_product_carousel_messages.md +9 -11
- package/docs/mensagens/recursos_adicionais/payload_encryption.md +1 -1
- 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/features.md +4 -4
- package/docs/mensagens_de_marketing/implementacao/get_started.md +7 -6
- package/docs/mensagens_de_marketing/implementacao/onboard_business_customers.md +160 -58
- package/docs/mensagens_de_marketing/implementacao/send_marketing_messages.md +83 -39
- package/docs/mensagens_de_marketing/onboarding.md +11 -11
- 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 +2 -2
- package/docs/messaging_limits/upcoming_changes.md +1 -1
- package/docs/modelos/gerenciamento_de_modelos/template_media.md +1 -1
- package/docs/modelos/modelos_de_autenticacao/authentication_best_practices.md +78 -17
- package/docs/modelos/modelos_de_marketing/per_user_limits.md +4 -2
- package/docs/pagamentos/pagamentos_na_india/overview.md +21 -21
- package/docs/pagamentos/payments_br/cards.md +1 -1
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_webhooks.md +23 -39
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/share_and_revoke_credit_lines.md +16 -16
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_programmatically.md +33 -33
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/transferring_wabas_to_customers.md +1 -1
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/implementation.md +35 -33
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_business_app_users.md +98 -24
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3.md +9 -9
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solutions.md +55 -57
- package/docs/recado/precos/ai_providers.md +80 -0
- package/docs/recado/precos/pricing.md +208 -78
- package/docs/recado/precos/pricing_updates_to_pricing.md +1 -1
- package/docs/recado/sobre_a_plataforma/access_tokens.md +22 -22
- package/docs/referencia/bot_do_whatsapp_business/bot_details_api.md +758 -4
- package/docs/referencia/business/add_phone_numbers_api.md +722 -4
- package/docs/referencia/business/business_account_api.md +164 -4
- package/docs/referencia/business/client_whatsapp_business_accounts_api.md +1002 -4
- package/docs/referencia/business/owned_whatsapp_business_accounts.md +798 -4
- package/docs/referencia/business/whatsapp_business_accounts_api.md +1546 -4
- package/docs/referencia/business/whatsapp_business_partner_onboarding_to_mm_lite_api.md +779 -4
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_number_sharing_api.md +786 -4
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_numbers_api.md +882 -4
- package/docs/referencia/changelog.md +89 -23
- package/docs/referencia/conta_do_whatsapp_business/assigned_users_management_api.md +2194 -4
- package/docs/referencia/conta_do_whatsapp_business/business_account_api.md +263 -4
- package/docs/referencia/conta_do_whatsapp_business/business_account_extended_credits_api.md +271 -4
- package/docs/referencia/conta_do_whatsapp_business/conversational_automation_api.md +778 -4
- package/docs/referencia/conta_do_whatsapp_business/flows_api.md +1518 -4
- 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 +1577 -4
- 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 +1682 -4
- package/docs/referencia/conta_do_whatsapp_business/schedules_api.md +1768 -4
- 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 +2174 -4
- package/docs/referencia/conta_do_whatsapp_business/template_api.md +972 -4
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_activities_api.md +838 -4
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_api.md +1380 -4
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_solutions_list_api.md +850 -4
- package/docs/referencia/groups/groups_invite_link_api.md +300 -4
- package/docs/referencia/groups/groups_join_requests_api.md +682 -4
- package/docs/referencia/groups/groups_participants_api.md +270 -4
- package/docs/referencia/groups/groups_query_api.md +432 -4
- package/docs/referencia/grupo/groups_invite_link_api.md +300 -4
- package/docs/referencia/grupo/groups_join_requests_api.md +682 -4
- package/docs/referencia/grupo/groups_participants_api.md +270 -4
- package/docs/referencia/grupo/groups_query_api.md +432 -4
- package/docs/referencia/historico_de_mensagens/whatsapp_business_message_history_events_api.md +862 -4
- package/docs/referencia/inscricao/application_connected_client_businesses.md +808 -4
- package/docs/referencia/inscricao/application_solutions_api.md +870 -4
- package/docs/referencia/inscricao/solution_creation_api.md +820 -4
- package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/migration_intent_details_api.md +720 -4
- package/docs/referencia/midias/media_api.md +338 -4
- package/docs/referencia/midias/media_download_api.md +156 -4
- package/docs/referencia/numero_da_conta_do_whatsapp/whatsapp_account_number_api.md +774 -4
- package/docs/referencia/perfil_do_whatsapp_business/whatsapp_business_profile_node_api.md +1490 -4
- package/docs/referencia/solucao_do_whatsapp_business/accept_deactivation_request_api.md +758 -4
- package/docs/referencia/solucao_do_whatsapp_business/access_token_api.md +700 -4
- package/docs/referencia/solucao_do_whatsapp_business/reject_deactivation_request_api.md +808 -4
- package/docs/referencia/solucao_do_whatsapp_business/send_deactivation_request_api.md +774 -4
- package/docs/referencia/solucao_do_whatsapp_business/solution_accept_api.md +808 -4
- package/docs/referencia/solucao_do_whatsapp_business/solution_details_api.md +764 -4
- package/docs/referencia/solucao_do_whatsapp_business/solution_reject_api.md +794 -4
- package/docs/referencia/telefone_do_whatsapp_business/block_api.md +538 -4
- package/docs/referencia/telefone_do_whatsapp_business/business_compliance_information_api.md +1604 -4
- package/docs/referencia/telefone_do_whatsapp_business/business_encryption_api.md +1396 -4
- package/docs/referencia/telefone_do_whatsapp_business/calling_api.md +594 -4
- package/docs/referencia/telefone_do_whatsapp_business/encrypted_messages_api.md +1 -1
- package/docs/referencia/telefone_do_whatsapp_business/groups_management_api.md +481 -4
- package/docs/referencia/telefone_do_whatsapp_business/marketing_messages_lite_api.md +311 -4
- package/docs/referencia/telefone_do_whatsapp_business/media_upload_api.md +184 -4
- package/docs/referencia/telefone_do_whatsapp_business/message_api.md +1794 -4
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_api.md +373 -4
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_deregister_api.md +710 -4
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_registration.md +776 -4
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_verification_request_code_api.md +730 -4
- package/docs/referencia/telefone_do_whatsapp_business/register_api.md +405 -4
- package/docs/referencia/telefone_do_whatsapp_business/settings_api.md +670 -4
- package/docs/referencia/telefone_do_whatsapp_business/verify_code_api.md +742 -4
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_message_history_api.md +1 -1
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_official_business_account_status_api.md +1536 -4
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_phone_number_api.md +1596 -4
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_profile_api.md +1474 -4
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_api.md +1175 -4
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_management_api.md +1311 -4
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/request_verification_code_api.md +774 -4
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/verify_code_api.md +764 -4
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_api.md +1378 -4
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_partners_api.md +816 -4
- package/docs/referencia/usuario/assigned_whatsapp_business_accounts_api.md +860 -4
- package/docs/referencia/webhooks/whatsapp_incoming_webhook_payload.md +1651 -4
- package/docs/referencia/whatsapp_business_account/extended_credits_api.md +166 -4
- package/docs/referencia/whatsapp_business_phone_number/commerce_settings_api.md +292 -4
- package/docs/suporte/migrating_from_onprem_to_cloud.md +4 -218
- package/docs/throughput.md +12 -12
- package/docs/visao_geral/overview.md +91 -127
- package/docs/webhooks/reference/messages/edit.md +126 -0
- package/docs/webhooks/reference/messages/revoke.md +90 -0
- package/docs/webhooks/visao_geral/message_echoes.md +1 -1
- package/package.json +1 -1
|
@@ -1,15 +1,19 @@
|
|
|
1
1
|
<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/business-scoped-user-ids -->
|
|
2
|
-
<!-- Scraped: 2026-
|
|
2
|
+
<!-- Scraped: 2026-03-10T21:37:22.213Z -->
|
|
3
3
|
|
|
4
|
-
# IDs
|
|
4
|
+
# IDs do usuário no escopo da empresa
|
|
5
5
|
|
|
6
|
-
Updated:
|
|
6
|
+
Updated: 6 de fev de 2026
|
|
7
|
+
|
|
8
|
+
**Atualização de 6 de fevereiro de 2026**
|
|
9
|
+
|
|
10
|
+
- Foram adicionadas diversas alterações. Elas estão listadas no [Registro de alterações do documento](#document-changelog).- Recomendamos que você comece a capturar os IDs de usuário no escopo da empresa (BSUIDs) e os mapeie para os números de telefone dos usuários do WhatsApp assim que possível.- Para ajudar você com os testes, a partir de 16 de fevereiro de 2026, os BSUIDs de teste aparecerão em webhooks de mensagens de teste disparados por meio do Painel de Apps.- A partir de 31 de março de 2026, os webhooks de mensagens começarão a incluir os BSUIDs reais dos usuários.
|
|
7
11
|
|
|
8
12
|
O WhatsApp vai lançar os nomes de usuário em 2026.
|
|
9
13
|
|
|
10
14
|
Os nomes de usuário são um recurso opcional para pessoas e empresas. Quando um usuário do WhatsApp adotar um nome de usuário, esse nome será exibido no app em vez do número de telefone. Entretanto, os nomes de usuário comerciais não têm o objetivo de garantir a privacidade. A adoção de um nome de usuário comercial não fará com que o número de telefone da empresa seja ocultado no app.
|
|
11
15
|
|
|
12
|
-
Para possibilitar os nomes de usuário,
|
|
16
|
+
Para possibilitar os nomes de usuário, a Meta vai compartilhar um novo identificador de usuário de back-end chamado ID do usuário no escopo da empresa (BSUID). O BSUID identifica um usuário do WhatsApp de forma exclusiva e está vinculado a uma empresa específica.
|
|
13
17
|
|
|
14
18
|
Este documento descreve como a adição de nomes de usuário afetará solicitações de API, respostas de API e cargas de webhook. As alterações adicionais para aceitar nomes de usuário antes que o recurso seja disponibilizado serão registradas aqui.
|
|
15
19
|
|
|
@@ -25,29 +29,137 @@ Os nomes de usuário são atribuídos à propriedade `username` em respostas de
|
|
|
25
29
|
|
|
26
30
|
## ID de usuário no escopo da empresa
|
|
27
31
|
|
|
28
|
-
|
|
32
|
+
Os BSUIDs começarão a aparecer nos webhooks a partir de 31 de março de 2026.
|
|
33
|
+
|
|
34
|
+
O BSUID é um identificador único que pode ser usado para enviar mensagem a um usuário do WhatsApp quando você não sabe o número de telefone dele. O BSUID será atribuído ao parâmetro `user_id` e aparecerá em todos os [webhooks de mensagens](#messages-webhooks), independentemente de o usuário ter habilitado ou não o recurso de nome de usuário.
|
|
35
|
+
|
|
36
|
+
Os BSUIDs são associados a portfólios empresariais individuais. Isso significa que qualquer número de telefone comercial de um determinado portfólio pode ser usado para enviar mensagens a um BSUID no mesmo portfólio. As tentativas de enviar mensagens ao BSUID usando um número de telefone de um portfólio diferente não terão sucesso.
|
|
29
37
|
|
|
30
38
|
Os BSUIDs serão:
|
|
31
39
|
|
|
32
|
-
- gerados automaticamente-
|
|
40
|
+
- gerados automaticamente- prefixados com o código do país [ISO 3166 alfa-2](https://l.facebook.com/l.php?u=https%3A%2F%2Fwww.iso.org%2Fiso-3166-country-codes.html&h=AT6YMuGiXXpq0BTzHMUw-UtTvOeBzfXSfEpoxQ53DXVnMryFpJ6NK0iAtQQR9_saZnunUEyHeFF_A6iFs-T8hUTd6uxXGVQMOicu7JxpnXucNr0zmylzJ3zP4nMCTJ06ArFJ4PviX23AFMDJXGh_whggxMA) de duas letras do usuário e um ponto, seguido de até 128 caracteres alfanuméricos (por exemplo, `US.13491208655302741918`)- únicos para cada par de usuário e [portfólio empresarial](https://www.facebook.com/business/help/486932075688253)(antes chamados de Gerenciadores de Negócios)- gerados novamente se um usuário mudar o número de telefone (o que dispara um [webhook de mensagens de status do sistema](#system-status-messages-webhooks))
|
|
33
41
|
|
|
34
42
|
Os BSUIDs podem ser usados para enviar qualquer tipo de mensagem, exceto [modelos de autenticação](/documentation/business-messaging/whatsapp/templates/authentication-templates/authentication-templates) de um toque, sem toque e de copiar código, que exigem o número de telefone do usuário.
|
|
35
43
|
|
|
36
|
-
|
|
44
|
+
Ao fazer solicitações à API com BSUIDs, use o valor inteiro do BSUID: código do país, ponto e todos os caracteres alfanuméricos. Se você omitir ou alterar o código do país, o ponto ou os caracteres alfanuméricos, a solicitação falhará.
|
|
45
|
+
|
|
46
|
+
Caso você seja uma empresa gerenciada com vários portfólios empresariais e queira usar BSUIDs que funcionem em todos eles, consulte [IDs de usuário no escopo da empresa principal](#parent-business-scoped-user-ids).
|
|
47
|
+
|
|
48
|
+
## IDs de usuário principal no escopo da empresa
|
|
49
|
+
|
|
50
|
+
Caso seja uma empresa gerenciada e queira vincular portfólios empresariais, você pode pedir ao seu ponto de contato da Meta para verificar se a sua organização se qualifica. Se você se qualificar e os portfólios empresariais forem vinculados, os BSUIDs principais serão incluídos em todos os webhooks de mensagens, atribuídos a uma nova propriedade `parent_user_id`.
|
|
51
|
+
|
|
52
|
+
Os BSUIDs principais podem ser usados em vez dos regulares para enviar mensagens aos usuários. Em termos de funcionalidade, os BSUIDs principais têm as mesmas propriedades que os regulares, mas podem ser usados por qualquer número de telefone comercial do conjunto de portfólios vinculados.
|
|
53
|
+
|
|
54
|
+
Você ainda pode enviar mensagens aos usuários usando o respectivo BSUID no escopo do seu portfólio empresarial.
|
|
37
55
|
|
|
38
56
|
## Números de telefone
|
|
39
57
|
|
|
40
|
-
|
|
58
|
+
Se um usuário do WhatsApp habilitar o recurso de nome de usuário, o número de telefone dele não será incluído nos webhooks, a menos que você tenha interagido com o usuário antes, conforme explicado abaixo. Portanto, independentemente de o usuário ter ou não habilitado o recurso, o BSUID do usuário será incluído em qualquer webhook que normalmente incluiria o número de telefone, atribuído a uma nova propriedade user\_id.
|
|
41
59
|
|
|
42
|
-
|
|
60
|
+
Para reduzir o risco de perda do contexto de conversas com usuários existentes que habilitarem o recurso de nomes de usuário, os números de telefone dos usuários serão incluídos em webhooks se alguma das seguintes condições for atendida:
|
|
43
61
|
|
|
44
|
-
|
|
62
|
+
- Você enviou mensagem ou ligou para o número de telefone do usuário em até 30 dias após o disparo do webhook- Você recebeu uma mensagem ou ligação do número de telefone do usuário em até 30 dias após o disparo do webhook- Você está na lista de contatos do WhatsApp do usuário- O usuário está na sua [lista de contatos](#contact-book)
|
|
45
63
|
|
|
46
|
-
|
|
64
|
+
Os BSUIDs começarão a aparecer nos webhooks a partir de 31 de março de 2026. Entretanto, nossas APIs não aceitarão o envio de mensagens direcionadas aos BSUIDs até maio de 2026 (o dia exato será definido em breve). Assim que nossas APIs passarem a ser compatíveis com BSUIDs em maio, você poderá enviar mensagens para os usuários usando o BSUID, o número de telefone ou ambos.
|
|
65
|
+
|
|
66
|
+
Caso você seja um provedor de soluções e forneça serviços de mensagens do WhatsApp aos clientes da sua empresa, eles poderão usar seu app para enviar mensagens a usuários, usando os respectivos números de telefone comercial do portfólio e os BSUIDs associados. Porém, se você tentar usar um dos BSUIDs de cliente de negócios com seu próprio número de telefone comercial, a ação falhará, já que os BSUIDs pertencem aos portfólios (e, em essência, aos ativos do portfólio).
|
|
67
|
+
|
|
68
|
+
Se não tiver certeza sobre a propriedade do ativo:
|
|
69
|
+
|
|
70
|
+
- Envie uma solicitação GET à [API de Contas do WhatsApp Business do Cliente](/docs/marketing-api/reference/business/client_whatsapp_business_accounts/#Reading) para obter uma lista de contas do WhatsApp Business que não sejam suas, mas que sejam compartilhadas com você.- Envie uma solicitação GET à [API de Contas do WhatsApp Business](/docs/marketing-api/reference/business/owned_whatsapp_business_accounts/#Reading) para obter uma lista das suas contas do WhatsApp Business.- Envie uma solicitação GET à [API de Números de Telefone](/docs/graph-api/reference/whats-app-business-account/phone_numbers/#Reading) para obter a lista de números de telefone pertencentes a uma determinada conta do WhatsApp Business.
|
|
71
|
+
|
|
72
|
+
## Como solicitar o número de telefone dos usuários
|
|
73
|
+
|
|
74
|
+
Para facilitar a solicitação de números de telefone de usuários do WhatsApp, está disponível um novo tipo de botão `REQUEST_CONTACT_INFO` que pode ser incluído nos modelos `utility` e `marketing`.
|
|
75
|
+
|
|
76
|
+
Se um usuário tocar nesse botão, o cartão de contato virtual e o número de telefone do WhatsApp dele serão compartilhados no tópico da mensagem. Além disso, um [webhook de contatos](/documentation/business-messaging/whatsapp/webhooks/reference/messages/contacts) será disparado, contendo o número de telefone e o [vCard](https://l.facebook.com/l.php?u=https%3A%2F%2Fdatatracker.ietf.org%2Fdoc%2Fhtml%2Frfc6350&h=AT6YMuGiXXpq0BTzHMUw-UtTvOeBzfXSfEpoxQ53DXVnMryFpJ6NK0iAtQQR9_saZnunUEyHeFF_A6iFs-T8hUTd6uxXGVQMOicu7JxpnXucNr0zmylzJ3zP4nMCTJ06ArFJ4PviX23AFMDJXGh_whggxMA) do usuário.
|
|
77
|
+
|
|
78
|
+
Ao usar o recurso de lista de contatos, o número de telefone do cliente também será adicionado automaticamente à sua lista, a menos que o armazenamento local esteja habilitado. Se o armazenamento local estiver habilitado, envie uma mensagem para o número de telefone do usuário. Essa ação adicionará o número de telefone e o BSUID à sua lista de contatos.
|
|
79
|
+
|
|
80
|
+
Para adicionar um botão de pedido de informações de contato a um modelo de utilidade ou marketing, use a seguinte estrutura de carga ao criar ou editar um modelo desse tipo:
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
{
|
|
84
|
+
"type": "buttons",
|
|
85
|
+
"buttons": [
|
|
86
|
+
{
|
|
87
|
+
"type": "REQUEST_CONTACT_INFO"
|
|
88
|
+
},
|
|
89
|
+
<!-- Additional button objects would go here, if using -->
|
|
90
|
+
]
|
|
91
|
+
}
|
|
92
|
+
```
|
|
47
93
|
|
|
48
|
-
|
|
94
|
+
Os botões de pedido de informações de contato não podem ser personalizados. Portanto, não é preciso incluir valores de parâmetro ao enviar o modelo.
|
|
49
95
|
|
|
50
|
-
|
|
96
|
+
Exemplo de carga do webhook de contatos com um vCard:
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
{
|
|
100
|
+
"object": "whatsapp_business_account",
|
|
101
|
+
"entry": [
|
|
102
|
+
{
|
|
103
|
+
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
|
|
104
|
+
"changes": [
|
|
105
|
+
{
|
|
106
|
+
"value": {
|
|
107
|
+
"messaging_product": "whatsapp",
|
|
108
|
+
"metadata": {
|
|
109
|
+
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
|
|
110
|
+
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
|
|
111
|
+
},
|
|
112
|
+
"contacts": [
|
|
113
|
+
{
|
|
114
|
+
"profile": {
|
|
115
|
+
"name": "<USER_DISPLAY_NAME>",
|
|
116
|
+
"username": "<USERNAME>",
|
|
117
|
+
},
|
|
118
|
+
"user_id": "<BSUID>"
|
|
119
|
+
}
|
|
120
|
+
],
|
|
121
|
+
"messages": [
|
|
122
|
+
{
|
|
123
|
+
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
124
|
+
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
125
|
+
"type": "contacts",
|
|
126
|
+
"origin": "contact_request/other", <!-- ADDED -->
|
|
127
|
+
"contacts": [
|
|
128
|
+
{
|
|
129
|
+
"vcard": "<VCARD>", <!-- ADDED -->
|
|
130
|
+
"phones": [
|
|
131
|
+
{
|
|
132
|
+
"phone": "<USER_PHONE_NUMBER>"
|
|
133
|
+
}
|
|
134
|
+
]
|
|
135
|
+
}
|
|
136
|
+
]
|
|
137
|
+
}
|
|
138
|
+
]
|
|
139
|
+
},
|
|
140
|
+
"field": "messages"
|
|
141
|
+
}
|
|
142
|
+
]
|
|
143
|
+
}
|
|
144
|
+
]
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Lista de contatos
|
|
149
|
+
|
|
150
|
+
No início de abril de 2026, para auxiliar na continuidade das conversas, lançaremos um recurso de lista de contatos que armazena informações de contato de usuários do WhatsApp.
|
|
151
|
+
|
|
152
|
+
Quando o recurso estiver disponível, se você enviar uma mensagem/ligar para o número de telefone de um usuário ou receber uma mensagem/ligar do número de telefone de um usuário, o número de telefone e o BSUID do usuário serão adicionados à sua lista de contatos. Depois de registrados, esses dados serão usados para preencher as cargas de webhooks e respostas de API que incluem o número de telefone ou o BSUID do usuário, independentemente de o recurso de nomes de usuário ter sido habilitado ou não.
|
|
153
|
+
|
|
154
|
+
Os dados da lista de contatos serão mantidos até você desabilitar o recurso ou desativar a conta. Se desejar, você poderá desabilitar esse recurso a qualquer momento após 16 de março de 2026 no painel **Meta Business Suite** > **Configurações da empresa** > [**Informações da empresa**](https://business.facebook.com/latest/settings/business_info). Ao desativar a lista de contatos, o armazenamento de novas informações de usuários será interrompido e os dados que já tiverem sido salvos serão apagados. Se você ativar novamente a lista de contatos, o WhatsApp voltará a armazenar as informações dos usuários, mas não será possível restaurar os dados armazenados anteriormente.
|
|
155
|
+
|
|
156
|
+
Limitações:
|
|
157
|
+
|
|
158
|
+
- Se você estiver usando o [armazenamento local](/documentation/business-messaging/whatsapp/local-storage) e um usuário compartilhar o número de telefone com você tocando em um [botão de pedido de informações de contato](#requesting-phone-numbers-from-users), as informações de contato desse usuário não serão adicionadas à sua lista de contatos. Em vez disso, envie uma mensagem para o número de telefone do usuário assim que ele for compartilhado com você. Isso fará com que o número de telefone e o BSUID sejam capturados pela sua lista de contatos.- As listas de contatos são associadas aos portfólios empresariais. Isso significa que, se você tiver portfólios associados, o número de telefone e o BSUID de um usuário terão que ser registrados no livro de contatos de cada portfólio de forma independente, já que as informações de contato do usuário não são compartilhadas ou sincronizadas entre portfólios associados.
|
|
159
|
+
|
|
160
|
+
## Códigos de país
|
|
161
|
+
|
|
162
|
+
Se um usuário do WhatsApp tiver habilitado o recurso de nome de usuário, o número de telefone dele (e, consequentemente, o código de discagem do país) poderá não aparecer nos webhooks. Nesses casos, o BSUID do usuário será exibido, prefixado com o código do país [ISO 3166 alpha-2](https://l.facebook.com/l.php?u=https%3A%2F%2Fwww.iso.org%2Fiso-3166-country-codes.html&h=AT6YMuGiXXpq0BTzHMUw-UtTvOeBzfXSfEpoxQ53DXVnMryFpJ6NK0iAtQQR9_saZnunUEyHeFF_A6iFs-T8hUTd6uxXGVQMOicu7JxpnXucNr0zmylzJ3zP4nMCTJ06ArFJ4PviX23AFMDJXGh_whggxMA) de duas letras (por exemplo, `US.13491208655302741918`).
|
|
51
163
|
|
|
52
164
|
## Nomes de usuário comerciais
|
|
53
165
|
|
|
@@ -57,29 +169,31 @@ Cada nome de usuário comercial é mapeado para um único número de telefone co
|
|
|
57
169
|
|
|
58
170
|
Os nomes de usuário comerciais devem ter o seguinte formato:
|
|
59
171
|
|
|
60
|
-
- podem conter apenas letras (a-z), números (0-9), ponto (.) e sublinhado (\_)- devem ter entre 3 e 35 caracteres- devem conter pelo menos uma letra do alfabeto inglês (a-z, A-Z)- não podem começar nem terminar com ponto nem ter dois pontos consecutivos- não podem começar com www- não podem terminar com um domínio (por exemplo, .com, .org, .net, .int, .edu, .gov, .mil, .us, .in, .html
|
|
172
|
+
- podem conter apenas letras (a-z), números (0-9), ponto (.) e sublinhado (\_)- devem ter entre 3 e 35 caracteres- devem conter pelo menos uma letra do alfabeto inglês (a-z, A-Z)- não podem começar nem terminar com ponto nem ter dois pontos consecutivos- não podem começar com www- não podem terminar com um domínio (por exemplo, .com, .org, .net, .int, .edu, .gov, .mil, .us, .in, .html e assim por diante);- a diferença entre maiúsculas e minúsculas é ignorada ao comparar nomes de usuário, mas os caracteres de ponto e sublinhado não. Por exemplo, "meuID" e "meuid" são o mesmo \*nome de usuário, mas "meuid", "meu.id" e "meu\_id" são nomes diferentes
|
|
61
173
|
|
|
62
174
|
### Nomes de usuário reservados
|
|
63
175
|
|
|
64
176
|
Antes da disponibilização desse recurso, você terá a opção de reivindicar o nome que o WhatsApp reservou para você. Também pode adotar um nome de usuário diferente que esteja alinhado aos requisitos da sua marca. É possível reivindicar um nome de usuário reservado por meio do Gerenciador do WhatsApp, do Meta Business Suite ou [via API](#get-reserved-usernames). Os nomes de usuário reivindicados e aprovados ficarão ativos assim que o recurso for disponibilizado.
|
|
65
177
|
|
|
66
|
-
Se o nome de usuário reservado já estiver sendo usado na sua Página do Facebook ou conta do Instagram, será necessário
|
|
178
|
+
Se o nome de usuário reservado já estiver sendo usado na sua Página do Facebook ou conta do Instagram, será necessário vincular o número de telefone comercial à Página do Facebook ou conta do Instagram para reivindicar o nome de usuário.
|
|
179
|
+
|
|
180
|
+
É possível vincular o número de telefone quando você reivindicar o nome de usuário no Meta Business Suite ou no Gerenciador do WhatsApp. Outra opção é acessar sua Página do Facebook ou conta do Instagram e [adicionar o número de telefone diretamente](https://www.facebook.com/business/help/4631406400243963).
|
|
67
181
|
|
|
68
|
-
Consulte [Sobre o portfólio empresarial e as permissões de ativos de negócios](https://www.facebook.com/business/help/442345745885606) para saber mais sobre controle/acesso e permissões.
|
|
182
|
+
Para vincular um número de telefone, você deve ter controle total da Página ou conta, ou acesso parcial básico com a permissão manage\_phone. Consulte [Sobre o portfólio empresarial e as permissões de ativos de negócios](https://www.facebook.com/business/help/442345745885606) para saber mais sobre controle/acesso e permissões.
|
|
69
183
|
|
|
70
184
|
### Prioridade de exibição da janela de conversa
|
|
71
185
|
|
|
72
186
|
A prioridade a seguir será observada (em ordem decrescente de prioridade) para a exibição de informações do perfil comercial nas janelas de conversa no app. Os números de telefone comerciais sempre aparecerão no seu perfil empresarial.
|
|
73
187
|
|
|
74
|
-
- Nome salvo do contato- Nome comercial verificado ou nome da [conta comercial oficial](/documentation/business-messaging/whatsapp/official-business-accounts)- Nome de usuário-
|
|
188
|
+
- Nome salvo do contato- Nome comercial verificado ou nome da [conta comercial oficial](/documentation/business-messaging/whatsapp/official-business-accounts)- Nome de usuário- Número de telefone
|
|
75
189
|
|
|
76
190
|
### Suporte
|
|
77
191
|
|
|
78
|
-
- Se tiver alguma dúvida, fale com seu gerente de parceiros.- Você pode entrar em contato com qualquer um dos [canais de suporte padrão](/documentation/business-messaging/whatsapp/support). Para integrações de API, abra um tíquete no Suporte Direto com o tipo de pergunta **Integração da API de Nome de Usuário do WA**.- Use o canal **Denunciar abuso**via [Suporte Direto](https://business.facebook.com/direct-support/) para denunciar um caso de falsificação de identidade.- Use nosso [formulário de contato sobre propriedade intelectual do WhatsApp](https://l.facebook.com/l.php?u=https%3A%2F%2Fwww.whatsapp.com%2Fcontact%2Fforms%2F5071674689613749&h=
|
|
192
|
+
- Se tiver alguma dúvida, fale com seu gerente de parceiros.- Você pode entrar em contato com qualquer um dos [canais de suporte padrão](/documentation/business-messaging/whatsapp/support). Para integrações de API, abra um tíquete no Suporte Direto com o tipo de pergunta **Integração da API de Nome de Usuário do WA**.- Use o canal **Denunciar abuso**via [Suporte Direto](https://business.facebook.com/direct-support/) para denunciar um caso de falsificação de identidade.- Use nosso [formulário de contato sobre propriedade intelectual do WhatsApp](https://l.facebook.com/l.php?u=https%3A%2F%2Fwww.whatsapp.com%2Fcontact%2Fforms%2F5071674689613749&h=AT6YMuGiXXpq0BTzHMUw-UtTvOeBzfXSfEpoxQ53DXVnMryFpJ6NK0iAtQQR9_saZnunUEyHeFF_A6iFs-T8hUTd6uxXGVQMOicu7JxpnXucNr0zmylzJ3zP4nMCTJ06ArFJ4PviX23AFMDJXGh_whggxMA) para denunciar violações.
|
|
79
193
|
|
|
80
194
|
### Como adotar ou alterar um nome de usuário comercial
|
|
81
195
|
|
|
82
|
-
Você poderá adotar ou alterar um nome de usuário comercial usando o Meta Business Suite, o Gerenciador do WhatsApp, o app WhatsApp Business ou a API.
|
|
196
|
+
Você poderá adotar ou alterar um nome de usuário comercial usando o Meta Business Suite, o Gerenciador do WhatsApp, o app WhatsApp Business ou a API, ainda este ano (data a ser definida).
|
|
83
197
|
|
|
84
198
|
Sintaxe da solicitação:
|
|
85
199
|
|
|
@@ -97,19 +211,84 @@ Sintaxe da resposta, em caso de sucesso:
|
|
|
97
211
|
|
|
98
212
|
```
|
|
99
213
|
{
|
|
100
|
-
"status": "<STATUS>"
|
|
101
|
-
|
|
102
|
-
<!-- Only included for REJECTED status -->
|
|
103
|
-
"rejection_reasons": [
|
|
104
|
-
"<REJECTION_REASON>",
|
|
105
|
-
<!--Additional rejection reasons would follow, if any -->
|
|
106
|
-
]
|
|
214
|
+
"status": "<STATUS>"
|
|
107
215
|
}
|
|
108
216
|
```
|
|
109
217
|
|
|
110
218
|
- `status`: o status do nome de usuário mais recente solicitado. Os valores podem ser os seguintes:
|
|
111
|
-
- `
|
|
112
|
-
|
|
219
|
+
- `approved`: o nome de usuário solicitado foi aprovado e ficará visível para os usuários do WhatsApp assim que o recurso de nomes de usuário for disponibilizado.- `reserved`: o nome de usuário solicitado foi reservado e aprovado, mas ainda não está visível para usuários do WhatsApp. Ele será exibido para os usuários do WhatsApp assim que o recurso estiver disponível para todos.
|
|
220
|
+
|
|
221
|
+
Sintaxe da resposta, em caso de falha:
|
|
222
|
+
|
|
223
|
+
```
|
|
224
|
+
{
|
|
225
|
+
"error": {
|
|
226
|
+
"message": "<MESSAGE>",
|
|
227
|
+
"type": "<TYPE>",
|
|
228
|
+
"code": <CODE>,
|
|
229
|
+
"error_data": {
|
|
230
|
+
"messaging_product": "whatsapp",
|
|
231
|
+
"details": "<DETAILS>"
|
|
232
|
+
},
|
|
233
|
+
"error_subcode": <ERROR_SUBCODE>,
|
|
234
|
+
"fbtrace_id": "<FBTRACE_ID>"
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
Código
|
|
240
|
+
|
|
241
|
+
Detalhes
|
|
242
|
+
|
|
243
|
+
Possíveis motivos e soluções
|
|
244
|
+
|
|
245
|
+
`10`
|
|
246
|
+
|
|
247
|
+
O app não tem permissão para essa ação
|
|
248
|
+
|
|
249
|
+
Confirme que o usuário do sistema que possui o token usado na solicitação tem [acesso a ativos de negócios](/documentation/business-messaging/whatsapp/access-tokens#business-asset-access) apropriado na conta do WhatsApp Business: **controle total** ou **acesso parcial** a **números de telefone**.
|
|
250
|
+
|
|
251
|
+
`33`
|
|
252
|
+
|
|
253
|
+
ID inválido
|
|
254
|
+
|
|
255
|
+
(1) o ID do número de telefone comercial é inválido; (2) a conta do WhatsApp Business associada ao número de telefone comercial foi excluída; ou (3) o usuário cujo token foi usado na solicitação não concedeu ao app a permissão **whatsapp\_business\_management** (que exige Advanced Access se você for um [provedor de soluções](/documentation/business-messaging/whatsapp/solution-providers/overview))
|
|
256
|
+
|
|
257
|
+
`100`
|
|
258
|
+
|
|
259
|
+
Parâmetro inválido
|
|
260
|
+
|
|
261
|
+
O [formato do nome de usuário](#business-usernames) é inválido.
|
|
262
|
+
|
|
263
|
+
`147001`
|
|
264
|
+
|
|
265
|
+
Nome de usuário indisponível
|
|
266
|
+
|
|
267
|
+
O nome de usuário já foi reivindicado, não passou em nossas verificações internas ou não está disponível na plataforma. Tente solicitar outro nome de usuário.
|
|
268
|
+
|
|
269
|
+
`147002`
|
|
270
|
+
|
|
271
|
+
Conta não qualificada para solicitar um nome de usuário
|
|
272
|
+
|
|
273
|
+
O portfólio empresarial que é proprietário da conta do WhatsApp Business e do número de telefone comercial deve ter um [limite de mensagens](/documentation/business-messaging/whatsapp/messaging-limits) maior.
|
|
274
|
+
|
|
275
|
+
`147003`
|
|
276
|
+
|
|
277
|
+
Conta do Facebook não vinculada
|
|
278
|
+
|
|
279
|
+
É preciso [vincular](https://www.facebook.com/business/help/4631406400243963) o número de telefone à Página do Facebook que já usa o nome de usuário solicitado.
|
|
280
|
+
|
|
281
|
+
`147004`
|
|
282
|
+
|
|
283
|
+
Conta do Instagram não vinculada
|
|
284
|
+
|
|
285
|
+
É preciso [vincular](https://www.facebook.com/business/help/4631406400243963) o número de telefone à conta do Instagram que já usa o nome de usuário solicitado
|
|
286
|
+
|
|
287
|
+
`133010`
|
|
288
|
+
|
|
289
|
+
Conta não registrada
|
|
290
|
+
|
|
291
|
+
Primeiro, o número de telefone comercial precisa estar [registrado para uso com a API](/documentation/business-messaging/whatsapp/business-phone-numbers/registration).
|
|
113
292
|
|
|
114
293
|
### Como obter o nome de usuário atual
|
|
115
294
|
|
|
@@ -127,15 +306,12 @@ Sintaxe da resposta:
|
|
|
127
306
|
```
|
|
128
307
|
{
|
|
129
308
|
"username": "<USERNAME>",
|
|
130
|
-
"status": "<STATUS>"
|
|
131
|
-
|
|
132
|
-
<!-- Only included for phone number's with a pending username request -->
|
|
133
|
-
"requested_username": "<REQUESTED_USERNAME>"
|
|
309
|
+
"status": "<STATUS>"
|
|
134
310
|
}
|
|
135
311
|
```
|
|
136
312
|
|
|
137
|
-
- `username`: nome de usuário atual. Será
|
|
138
|
-
- `
|
|
313
|
+
- `username`: nome de usuário atual. Será omitido se o número de telefone comercial não tiver um nome de usuário.- `status`: status do nome de usuário. Os valores podem ser os seguintes:
|
|
314
|
+
- `approved`: o nome de usuário foi aprovado e está visível para os usuários do WhatsApp.- `reserved`: o nome de usuário está reservado para o número de telefone comercial, mas não está visível para os usuários do WhatsApp. Ele ficará visível assim que o recurso de nomes de usuário for disponibilizado para todos.
|
|
139
315
|
|
|
140
316
|
### Como obter nomes de usuário reservados
|
|
141
317
|
|
|
@@ -178,7 +354,7 @@ curl -X DELETE 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_
|
|
|
178
354
|
-H 'Authorization: Bearer <ACCESS_TOKEN>'
|
|
179
355
|
```
|
|
180
356
|
|
|
181
|
-
|
|
357
|
+
Sintaxe da resposta:
|
|
182
358
|
|
|
183
359
|
```
|
|
184
360
|
{ "success": <SUCCESS?>}
|
|
@@ -186,28 +362,11 @@ curl -X DELETE 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_
|
|
|
186
362
|
|
|
187
363
|
- `success`: booleano. O valor será definido como `true` se o nome de usuário for excluído com sucesso. Caso contrário, será definido como `false`.
|
|
188
364
|
|
|
189
|
-
###
|
|
365
|
+
### Webhook business\_username\_updates
|
|
190
366
|
|
|
191
|
-
|
|
367
|
+
Um novo webhook **business\_username\_update** será adicionado. Esse webhook será disparado quando o status do nome de usuário de uma empresa for alterado.
|
|
192
368
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
```
|
|
196
|
-
curl -X DELETE 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/requested_username' \
|
|
197
|
-
-H 'Authorization: Bearer <ACCESS_TOKEN>'
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
### Sintaxe da resposta:
|
|
201
|
-
|
|
202
|
-
```
|
|
203
|
-
{ "success": <SUCCESS?>}
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
- `success`: booleano. O valor será definido como `true` se o nome de usuário for excluído com sucesso. Caso contrário, será definido como `false`.
|
|
207
|
-
|
|
208
|
-
### Webhook phone\_number\_username\_update
|
|
209
|
-
|
|
210
|
-
Um novo webhook **phone\_number\_username\_update** será adicionado. Esse webhook será disparado quando o status do nome de usuário de um número de telefone comercial for alterado. Inscreva seus apps no campo do webhook para receber notificações sobre alterações de nome de usuário.
|
|
369
|
+
Inscreva seus apps no campo do webhook para receber notificações sobre alterações de nome de usuário.
|
|
211
370
|
|
|
212
371
|
```
|
|
213
372
|
{
|
|
@@ -218,15 +377,11 @@ Um novo webhook **phone\_number\_username\_update** será adicionado. Esse webho
|
|
|
218
377
|
"time": <WEBHOOK_TRIGGER_TIMESTAMP>,
|
|
219
378
|
"changes": [
|
|
220
379
|
{
|
|
221
|
-
"field": "
|
|
380
|
+
"field": "business_username_update",
|
|
222
381
|
"value": {
|
|
223
382
|
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
|
|
224
|
-
"
|
|
225
|
-
"
|
|
226
|
-
"rejection_reasons": [
|
|
227
|
-
"<REJECTION_REASON>",
|
|
228
|
-
<!-- Additional rejection reasons would follow, if any -->
|
|
229
|
-
]
|
|
383
|
+
"username": "<USERNAME>",
|
|
384
|
+
"status": "<STATUS>"
|
|
230
385
|
}
|
|
231
386
|
}
|
|
232
387
|
]
|
|
@@ -235,9 +390,8 @@ Um novo webhook **phone\_number\_username\_update** será adicionado. Esse webho
|
|
|
235
390
|
}
|
|
236
391
|
```
|
|
237
392
|
|
|
238
|
-
- `id`: identificação da conta do WhatsApp Business.- `time`: indica o registro de data e hora UNIX de quando o webhook foi disparado.- `display_phone_number`: o número exibido do telefone comercial (o número mostrado no seu perfil no app).- `
|
|
239
|
-
- `
|
|
240
|
-
- `REQUIRE_FB_ACCOUNT_LINKING`: o nome de usuário solicitado está associado a uma Página do Facebook existente. Para reivindicar o nome de usuário, primeiro [adicione seu número de telefone comercial à Página](https://www.facebook.com/business/help/4631406400243963).- `REQUIRE_IG_ACCOUNT_LINKING`: o nome de usuário solicitado já está associado a um nome de usuário do Instagram. Para reivindicar o nome de usuário, primeiro adicione seu número de telefone comercial à conta do Instagram.- `NOT_AVAILABLE`: o nome de usuário não está disponível porque está associado a outra conta ou não passou em nossas verificações internas.- `ACCOUNT_INELIGIBLE`: a conta não está qualificada para solicitar um nome de usuário. O [nome de exibição](/documentation/business-messaging/whatsapp/display-names) do número de telefone comercial deve ser aprovado e a empresa proprietária deve ser [verificada](https://www.facebook.com/business/help/2058515294227817).- `UNKNOWN`: rejeitado por motivo desconhecido. Entre em contato com o suporte para obter ajuda.
|
|
393
|
+
- `id`: identificação da conta do WhatsApp Business.- `time`: indica o registro de data e hora UNIX de quando o webhook foi disparado.- `display_phone_number`: o número exibido do telefone comercial (o número mostrado no seu perfil no app).- `username`: o nome de usuário cujo status foi alterado. Omitido se `status` for definido como `deleted`.- `status`: os valores podem ser:
|
|
394
|
+
- `approved`: indica que o nome de usuário foi aprovado e está visível para os usuários do WhatsApp. Disparado quando o status do nome de usuário muda de `reserved` para `approved` ou quando o nome de usuário é alterado por meio do app WhatsApp Business.- `deleted`: indica que o nome de usuário foi excluído por meio do app WhatsApp Business.- `reserved`: indica que o nome de usuário está reservado para o número de telefone comercial, mas não está visível para os usuários do WhatsApp. Ele ficará visível assim que o recurso de nomes de usuário for disponibilizado para todos.
|
|
241
395
|
|
|
242
396
|
## Mensagens
|
|
243
397
|
|
|
@@ -245,7 +399,7 @@ Um novo webhook **phone\_number\_username\_update** será adicionado. Esse webho
|
|
|
245
399
|
|
|
246
400
|
As alterações se aplicam a solicitações do ponto de extremidade [POST /<BUSINESS\_PHONE\_NUMBER\_ID>/messages](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/message-api#Creating).
|
|
247
401
|
|
|
248
|
-
|
|
402
|
+
Essa sintaxe de exemplo envia uma mensagem `text`, mas as alterações se aplicam a todos os tipos de mensagens.
|
|
249
403
|
|
|
250
404
|
```
|
|
251
405
|
'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/messages' \
|
|
@@ -255,7 +409,8 @@ Esta sintaxe de exemplo envia uma mensagem de texto, mas as alterações se apli
|
|
|
255
409
|
{
|
|
256
410
|
"messaging_product": "whatsapp",
|
|
257
411
|
"recipient_type": "individual",
|
|
258
|
-
"to": "<USER_PHONE_NUMBER>",
|
|
412
|
+
"to": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
413
|
+
"recipient": "<BSUID>", <!-- ADDED -->
|
|
259
414
|
"type": "text",
|
|
260
415
|
"text": {
|
|
261
416
|
"body": "<BODY_TEXT>"
|
|
@@ -263,7 +418,15 @@ Esta sintaxe de exemplo envia uma mensagem de texto, mas as alterações se apli
|
|
|
263
418
|
}'
|
|
264
419
|
```
|
|
265
420
|
|
|
266
|
-
|
|
421
|
+
É possível incluir `to` (número de telefone) e `recipient` (BSUID ou BSUID principal) na solicitação. Se fizer isso, `to` (número de telefone) terá precedência. Se preferir, você também poderá usar uma das seguintes opções:
|
|
422
|
+
|
|
423
|
+
Para enviar uma mensagem usando apenas o número de telefone do usuário:
|
|
424
|
+
|
|
425
|
+
- defina `to` como o número de telefone do usuário- omita a propriedade `recipient`
|
|
426
|
+
|
|
427
|
+
Para enviar uma mensagem usando apenas o BSUID do usuário ou o BSUID principal:
|
|
428
|
+
|
|
429
|
+
- defina `recipient` como o BSUID do usuário ou o BSUID principal- omita a propriedade `to`
|
|
267
430
|
|
|
268
431
|
### Como enviar resposta às mensagens
|
|
269
432
|
|
|
@@ -274,9 +437,9 @@ As alterações se aplicam às respostas do ponto de extremidade [POST /<BUSINES
|
|
|
274
437
|
"messaging_product": "whatsapp",
|
|
275
438
|
"contacts": [
|
|
276
439
|
{
|
|
277
|
-
"input": "<
|
|
278
|
-
"wa_id": "<USER_PHONE_NUMBER>",
|
|
279
|
-
"user_id": "<BSUID>"
|
|
440
|
+
"input": "<USER_PHONE_NUMBER_OR_BSUID>", <!-- CHANGED -->
|
|
441
|
+
"wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
442
|
+
"user_id": "<BSUID>" <!-- ADDED -->
|
|
280
443
|
}
|
|
281
444
|
],
|
|
282
445
|
"messages": [
|
|
@@ -287,31 +450,39 @@ As alterações se aplicam às respostas do ponto de extremidade [POST /<BUSINES
|
|
|
287
450
|
}
|
|
288
451
|
```
|
|
289
452
|
|
|
290
|
-
- `input`:
|
|
453
|
+
- `input`: novo valor (BSUID ou BSUID principal).
|
|
454
|
+
- Retornará o número de telefone do usuário, caso a mensagem tenho sido enviada para o número de telefone do usuário.- Retornará o BSUID do usuário ou o BSUID principal, caso a mensagem tenha sido enviada para o BSUID do usuário ou para o BSUID principal.- Retornará a identificação do grupo, caso a mensagem tenha sido enviada a um grupo.- `wa_id`: novo comportamento (pode ser omitido). Retornará o número de telefone do usuário, caso a mensagem tenho sido enviada para o número de telefone do usuário. Caso contrário, o campo será omitido.- `user_id`: nova propriedade.
|
|
455
|
+
- Retornará o BSUID do usuário ou o BSUID principal, caso a mensagem tenha sido enviada para o BSUID do usuário ou o BSUID principal, ou caso você tenha incluído o número de telefone e o BSUID do usuário ou o BSUID principal ao enviar a mensagem (fazendo com que a mensagem seja enviada para o número de telefone do usuário, que tem precedência).- Será omitido se a mensagem tiver sido enviada para o número de telefone do usuário.
|
|
291
456
|
|
|
292
|
-
Exemplo de resposta a uma solicitação de envio de mensagem
|
|
457
|
+
Exemplo de resposta a uma solicitação de envio de mensagem enviada ao número de telefone de um usuário (o BSUID do usuário ou o BSUID principal não foi usado na solicitação):
|
|
293
458
|
|
|
294
459
|
```
|
|
295
|
-
{ "messaging_product": "whatsapp", "contacts": [ { "input": "+16505551234" "wa_id": "16505551234" } ], "messages": [ { "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA" } ]}
|
|
460
|
+
{ "messaging_product": "whatsapp", "contacts": [ { "input": "+16505551234", "wa_id": "16505551234" } ], "messages": [ { "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA" } ]}
|
|
296
461
|
```
|
|
297
462
|
|
|
298
|
-
Exemplo de resposta a uma solicitação de envio de mensagem enviada ao BSUID de um usuário:
|
|
463
|
+
Exemplo de resposta a uma solicitação de envio de mensagem enviada ao BSUID de um usuário (o número de telefone do usuário não é usado na solicitação):
|
|
299
464
|
|
|
300
465
|
```
|
|
301
|
-
{ "messaging_product": "whatsapp", "contacts": [ { "input": "
|
|
466
|
+
{ "messaging_product": "whatsapp", "contacts": [ { "input": "US.13491208655302741918", "user_id": "US.13491208655302741918" } ], "messages": [ { "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA" } ]}
|
|
467
|
+
```
|
|
468
|
+
|
|
469
|
+
Exemplo de resposta a uma solicitação de envio de mensagem enviada ao número de telefone e ao BSUID de um usuário (o número de telefone do usuário tem precedência):
|
|
470
|
+
|
|
471
|
+
```
|
|
472
|
+
{ "messaging_product": "whatsapp", "contacts": [ { "input": "+16505551234", "wa_id": "16505551234", "user_id": "US.13491208655302741918" } ], "messages": [ { "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA" } ]}
|
|
302
473
|
```
|
|
303
474
|
|
|
304
475
|
### Códigos de erro
|
|
305
476
|
|
|
306
477
|
Inclusão de uma nova resposta de código de erro para o ponto de extremidade [POST /<BUSINESS\_PHONE\_NUMBER\_ID>/messages](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/message-api#Creating).
|
|
307
478
|
|
|
308
|
-
- Código de erro: `131062`- Detalhes: `
|
|
479
|
+
- Código de erro: `131062`- Detalhes: `Business-scoped User ID (BSUID) recipients are not supported for this message.`
|
|
309
480
|
|
|
310
481
|
## API de Mensagens de Marketing para o WhatsApp
|
|
311
482
|
|
|
312
483
|
### Como enviar solicitações de mensagem de marketing
|
|
313
484
|
|
|
314
|
-
A API de Mensagens de Marketing para o WhatsApp aceitará números de telefone e BSUIDs.
|
|
485
|
+
A API de Mensagens de Marketing para o WhatsApp aceitará números de telefone, BSUIDs e BSUIDs principais. Recomendamos enviar mensagens para números de telefone, principalmente para continuar recebendo números de telefone em webhooks.
|
|
315
486
|
|
|
316
487
|
As alterações serão aplicadas às solicitações do ponto de extremidade [POST /<BUSINESS\_PHONE\_NUMBER\_ID>/marketing\_messages](/documentation/business-messaging/whatsapp/marketing-messages/send-marketing-messages#send-marketing-template-messages).
|
|
317
488
|
|
|
@@ -323,7 +494,8 @@ As alterações serão aplicadas às solicitações do ponto de extremidade [POS
|
|
|
323
494
|
{
|
|
324
495
|
"messaging_product": "whatsapp",
|
|
325
496
|
"recipient_type": "individual",
|
|
326
|
-
"to": "<USER_PHONE_NUMBER>",
|
|
497
|
+
"to": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
498
|
+
"recipient": "<BSUID>", <!-- ADDED -->
|
|
327
499
|
"type": "template",
|
|
328
500
|
"template": {
|
|
329
501
|
<EXPECTED_TEMPLATE_PARAMETERS>
|
|
@@ -331,7 +503,15 @@ As alterações serão aplicadas às solicitações do ponto de extremidade [POS
|
|
|
331
503
|
}'
|
|
332
504
|
```
|
|
333
505
|
|
|
334
|
-
|
|
506
|
+
É possível incluir `to` (número de telefone) e `recipient` (BSUID ou BSUID principal) na solicitação. Se fizer isso, `to` (número de telefone) terá precedência. Se preferir, você também poderá usar uma das seguintes opções:
|
|
507
|
+
|
|
508
|
+
Para enviar uma mensagem usando apenas o número de telefone do usuário:
|
|
509
|
+
|
|
510
|
+
- defina `to` como o número de telefone do usuário- omita a propriedade `recipient`
|
|
511
|
+
|
|
512
|
+
Para enviar uma mensagem usando apenas o BSUID do usuário ou o BSUID principal:
|
|
513
|
+
|
|
514
|
+
- defina `recipient` como o BSUID do usuário ou o BSUID principal- omita a propriedade `to`
|
|
335
515
|
|
|
336
516
|
### Como enviar resposta a uma mensagem de marketing
|
|
337
517
|
|
|
@@ -356,28 +536,30 @@ Essas alterações se aplicam às respostas do ponto de extremidade [POST /<BUSI
|
|
|
356
536
|
}
|
|
357
537
|
```
|
|
358
538
|
|
|
359
|
-
- `input`:
|
|
539
|
+
- `input`: novo valor (BSUID ou BSUID principal).
|
|
540
|
+
- Retornará o número de telefone do usuário, caso a mensagem tenho sido enviada para o número de telefone do usuário.- Retornará o BSUID do usuário ou o BSUID principal, caso a mensagem tenha sido enviada para o BSUID do usuário ou para o BSUID principal.- Retornará a identificação do grupo, caso a mensagem tenha sido enviada a um grupo.- `wa_id`: retornará o número de telefone do usuário, caso a mensagem tenha sido enviada para o número de telefone dele. Caso contrário, o campo será omitido.- `user_id`: nova propriedade.
|
|
541
|
+
- Retornará o BSUID do usuário ou o BSUID principal, caso a mensagem tenha sido enviada para o BSUID do usuário ou o BSUID principal, ou caso você tenha incluído o número de telefone e o BSUID do usuário/BSUID principal ao enviar a mensagem (fazendo com que a mensagem seja enviada para o número de telefone do usuário, que tem precedência).- Será omitido se a mensagem tiver sido enviada para o número de telefone do usuário.
|
|
360
542
|
|
|
361
543
|
Exemplo de resposta ao envio de uma mensagem de modelo para o número de telefone de um usuário:
|
|
362
544
|
|
|
363
545
|
```
|
|
364
|
-
{ "messaging_product": "whatsapp", "contacts": [ { "input": "+16505551234" "wa_id": "16505551234" } ], "messages": [ { "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA", "message_status": "accepted" } ]}
|
|
546
|
+
{ "messaging_product": "whatsapp", "contacts": [ { "input": "+16505551234", "wa_id": "16505551234" } ], "messages": [ { "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA", "message_status": "accepted" } ]}
|
|
365
547
|
```
|
|
366
548
|
|
|
367
549
|
Exemplo de resposta ao envio de uma mensagem de modelo para o BSUID de um usuário:
|
|
368
550
|
|
|
369
551
|
```
|
|
370
|
-
{ "messaging_product": "whatsapp", "contacts": [ { "input": "
|
|
552
|
+
{ "messaging_product": "whatsapp", "contacts": [ { "input": "US.13491208655302741918", "user_id": "US.13491208655302741918" } ], "messages": [ { "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA", "message_status": "accepted" } ]}
|
|
371
553
|
```
|
|
372
554
|
|
|
373
555
|
## Webhooks de mensagens
|
|
374
556
|
|
|
557
|
+
A partir de 16 de fevereiro de 2026, os webhooks de mensagens de teste disparados por meio do **Painel de Apps** (**Casos de uso** > **Conecte-se com clientes pelo WhatsApp** > **Personalizar** > **Configuração**, ou **WhatsApp** > **Configuração**, para apps criados antes de dezembro de 2026), incluirão BSUIDs de teste.
|
|
558
|
+
|
|
375
559
|
### Webhooks de mensagens de status
|
|
376
560
|
|
|
377
561
|
As alterações serão aplicadas aos webhooks de [status de mensagem](/documentation/business-messaging/whatsapp/webhooks/reference/messages/status) enviada, entregue, lida e com falha.
|
|
378
562
|
|
|
379
|
-
Exceção: os webhooks de mensagens de status enviada ou com falha da API de Grupos não serão afetados.
|
|
380
|
-
|
|
381
563
|
```
|
|
382
564
|
{
|
|
383
565
|
"object": "whatsapp_business_account",
|
|
@@ -394,15 +576,16 @@ Exceção: os webhooks de mensagens de status enviada ou com falha da API de Gru
|
|
|
394
576
|
},
|
|
395
577
|
|
|
396
578
|
<!-- Contacts will be included for sent, delivered, and read status -->
|
|
397
|
-
"contacts": [
|
|
579
|
+
"contacts": [ <!-- ADDED -->
|
|
398
580
|
{
|
|
399
581
|
"profile": {
|
|
400
|
-
"name": "<USER_DISPLAY_NAME>",
|
|
401
|
-
"username": "<USERNAME>"
|
|
402
|
-
|
|
582
|
+
"name": "<USER_DISPLAY_NAME>", <!-- ADDED --><!-- Only included if user has enabled the username feature -->
|
|
583
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
584
|
+
|
|
403
585
|
},
|
|
404
|
-
"wa_id": "<USER_PHONE_NUMBER>",
|
|
405
|
-
"user_id": "<BSUID>"
|
|
586
|
+
"wa_id": "<USER_PHONE_NUMBER>", <!-- ADDED -->
|
|
587
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
588
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
406
589
|
}
|
|
407
590
|
],
|
|
408
591
|
|
|
@@ -411,19 +594,9 @@ Exceção: os webhooks de mensagens de status enviada ou com falha da API de Gru
|
|
|
411
594
|
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
412
595
|
"status": "<STATUS>",
|
|
413
596
|
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
414
|
-
"recipient_id": "<USER_PHONE_NUMBER>",
|
|
415
|
-
"recipient_user_id": "<BSUID>",
|
|
416
|
-
"
|
|
417
|
-
{
|
|
418
|
-
"code": <ERROR_CODE>,
|
|
419
|
-
"title": "<ERROR_TITLE>",
|
|
420
|
-
"message": "<ERROR_MESSAGE>",
|
|
421
|
-
"error_data": {
|
|
422
|
-
"details": "<ERROR_DETAILS>"
|
|
423
|
-
},
|
|
424
|
-
"href": "<ERROR_CODES_URL>"
|
|
425
|
-
}
|
|
426
|
-
]
|
|
597
|
+
"recipient_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
598
|
+
"recipient_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
599
|
+
"parent_recipient_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
427
600
|
}
|
|
428
601
|
]
|
|
429
602
|
},
|
|
@@ -435,20 +608,23 @@ Exceção: os webhooks de mensagens de status enviada ou com falha da API de Gru
|
|
|
435
608
|
}
|
|
436
609
|
```
|
|
437
610
|
|
|
438
|
-
- `contacts`: nova matriz.
|
|
439
|
-
- `name`: nova propriedade. O valor será definido como o nome de exibição do usuário do WhatsApp.- `username`: nova propriedade.
|
|
440
|
-
|
|
611
|
+
- `contacts`: nova matriz. Incluída apenas em mensagens com status enviada, entregue ou lida. Será omitida por completo para webhooks de mensagens de status `failed`.
|
|
612
|
+
- `name`: nova propriedade. O valor será definido como o nome de exibição do usuário do WhatsApp.- `username`: nova propriedade.
|
|
613
|
+
- Será definida como o nome de usuário do WhatsApp se o usuário tiver habilitado o recurso de nome de usuário.- Será omitida para webhooks de mensagens de status `sent` ou se o usuário não tiver habilitado o recurso de nomes de usuário.- `wa_id`: nova propriedade.
|
|
614
|
+
- Será omitido se o usuário tiver habilitado o recurso de nome de usuário e não for possível incluir o número de telefone de acordo com as condições descritas na seção [Números de telefone](#phone-numbers).- Será definida como o número de telefone do usuário se a mensagem for enviada para o número de telefone dele.- `user_id`: nova propriedade. Será definida como o BSUID do usuário do WhatsApp.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, a propriedade será totalmente omitida.- `statuses`
|
|
615
|
+
- `recipient_id`: novo comportamento (pode ser omitido).
|
|
616
|
+
- Será definido como o número de telefone do usuário se a mensagem foi enviada para o número de telefone dele.- Será definido como a identificação do grupo se a mensagem foi enviada para um grupo.- Será omitido se a mensagem foi enviada ao BSUID do usuário ou ao BSUID principal e não conseguirmos incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- `recipient_user_id`: nova propriedade. Será definida como o BSUID do usuário ou o BSUID principal se a mensagem for enviada para o BSUID do usuário ou o BSUID principal. Caso contrário, o campo será omitido.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, ele será totalmente omitido.
|
|
441
617
|
|
|
442
|
-
Exemplo de webhook de mensagens com status "entregue" descrevendo uma mensagem enviada para o número de telefone de um usuário do WhatsApp que habilitou o recurso de nomes de usuário:
|
|
618
|
+
Exemplo de webhook de mensagens com status "entregue" descrevendo uma mensagem enviada por uma empresa que habilitou os BSUIDs principais para o número de telefone de um usuário do WhatsApp que habilitou o recurso de nomes de usuário:
|
|
443
619
|
|
|
444
620
|
```
|
|
445
|
-
{ "object": "whatsapp_business_account", "entry": [ { "id": "102290129340398", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "15550783881", "phone_number_id": "106540352242922" }, "contacts": [ { "profile": { "name": "Pablo M.", "username": "@pablomorales",
|
|
621
|
+
{ "object": "whatsapp_business_account", "entry": [ { "id": "102290129340398", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "15550783881", "phone_number_id": "106540352242922" }, "contacts": [ { "profile": { "name": "Pablo M.", "username": "@pablomorales" }, "wa_id": "16505551234", "user_id": "US.13491208655302741918", "parent_user_id": "US.11815799212886844830" } ], "statuses": [ { "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=", "status": "delivered", "timestamp": "1750030073", "recipient_id": "16505551234", "recipient_user_id": "US.13491208655302741918", "parent_recipient_user_id": "US.11815799212886844830", "pricing": { "billable": true, "pricing_model": "PMP", "type": "regular", "category": "marketing" } } ] }, "field": "messages" } ] } ]}
|
|
446
622
|
```
|
|
447
623
|
|
|
448
|
-
Exemplo de webhook de mensagens com status "entregue" descrevendo uma mensagem enviada para o
|
|
624
|
+
Exemplo de webhook de mensagens com status "entregue" descrevendo uma mensagem enviada por uma empresa que habilitou BSUIDs principais para o BSUID de um usuário do WhatsApp que habilitou o recurso de nomes de usuário. Neste exemplo, não foi possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers) (portanto, `wa_id` e `recipient_id` foram omitidos).
|
|
449
625
|
|
|
450
626
|
```
|
|
451
|
-
{ "object": "whatsapp_business_account", "entry": [ { "id": "102290129340398", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "15550783881", "phone_number_id": "106540352242922" }, "contacts": [ { "profile": { "name": "Pablo M.", "username": "@pablomorales"
|
|
627
|
+
{ "object": "whatsapp_business_account", "entry": [ { "id": "102290129340398", "changes": [ { "value": { "messaging_product": "whatsapp", "metadata": { "display_phone_number": "15550783881", "phone_number_id": "106540352242922" }, "contacts": [ { "profile": { "name": "Pablo M.", "username": "@pablomorales" }, "user_id": "US.13491208655302741918", "parent_user_id": "US.11815799212886844830" } ], "statuses": [ { "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=", "status": "delivered", "timestamp": "1750030073", "recipient_user_id": "US.13491208655302741918", "parent_user_id": "US.11815799212886844830", "pricing": { "billable": true, "pricing_model": "PMP", "type": "regular", "category": "marketing" } } ] }, "field": "messages" } ] } ]}
|
|
452
628
|
```
|
|
453
629
|
|
|
454
630
|
### Webhooks de mensagens recebidas
|
|
@@ -475,17 +651,22 @@ O exemplo de sintaxe abaixo é para uma mensagem de **texto** recebida, mas as a
|
|
|
475
651
|
{
|
|
476
652
|
"profile": {
|
|
477
653
|
"name": "<WHATSAPP_USER_PROFILE_NAME>",
|
|
478
|
-
|
|
479
|
-
|
|
654
|
+
|
|
655
|
+
<!-- Only included if user has enabled the username feature -->
|
|
656
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
480
657
|
},
|
|
481
658
|
"wa_id": "<WHATSAPP_USER_ID>", <!-- CHANGED -->
|
|
482
|
-
"user_id": "<BSUID>"
|
|
659
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
660
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
483
661
|
}
|
|
484
662
|
],
|
|
485
663
|
"messages": [
|
|
486
664
|
{
|
|
487
665
|
"from": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
488
|
-
"from_user_id": "<BSUID>", <!-- ADDED -->
|
|
666
|
+
"from_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
667
|
+
"from_parent_user_id": "<PARENT_BSUID>", <!-- ADDED --><!-- Only included if incoming message sent in a group -->
|
|
668
|
+
"group_id": "<GROUP_ID>",
|
|
669
|
+
|
|
489
670
|
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
490
671
|
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
491
672
|
"type": "text",
|
|
@@ -503,12 +684,18 @@ O exemplo de sintaxe abaixo é para uma mensagem de **texto** recebida, mas as a
|
|
|
503
684
|
}
|
|
504
685
|
```
|
|
505
686
|
|
|
506
|
-
- `
|
|
687
|
+
- `contacts`
|
|
688
|
+
- `profile`
|
|
689
|
+
- `username`: nova propriedade.
|
|
690
|
+
- Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário.- Se o usuário não tiver um nome de usuário, o campo será omitido.- `wa_id`: novo comportamento (pode ser omitido).
|
|
691
|
+
- Será omitido se o usuário tiver habilitado o recurso de nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- Será definido como o número de telefone do usuário, se ele não tiver habilitado o recurso de nomes de usuário.- `user_id`: nova propriedade, definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o BSUID principal do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `messages`
|
|
692
|
+
- `from`: novo comportamento (pode ser omitido).
|
|
693
|
+
- Será omitido se o usuário tiver habilitado o recurso de nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- Será definido como o número de telefone do usuário, se ele não tiver habilitado o recurso de nomes de usuário.- `from_user_id`: nova propriedade, definida como o BSUID do usuário.- `from_parent_user_id`: nova propriedade, definida como o BSUID principal do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
507
694
|
|
|
508
|
-
Exemplo de mensagem de texto recebida de um usuário que habilitou o recurso de nome de usuário
|
|
695
|
+
Exemplo de mensagem de texto recebida de um usuário que habilitou o recurso de nome de usuário para uma empresa que habilitou [BSUIDs](#parent-business-scoped-user-ids) principais. Nesse cenário, não foi possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).
|
|
509
696
|
|
|
510
697
|
```
|
|
511
|
-
{ "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", "username": "@realsheenanelson"
|
|
698
|
+
{ "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", "username": "@realsheenanelson" }, "user_id": "uUS.13491208655302741918", "parent_user_id": "US.11815799212886844830" } ], "messages": [ { "from_user_id": "US.13491208655302741918", "from_parent_user_id": "US.11815799212886844830", "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQTRBNjU5OUFFRTAzODEwMTQ0RgA=", "timestamp": "1749416383", "type": "text", "text": { "body": "Does it come in another color?" } } ] }, "field": "messages" } ] } ]}
|
|
512
699
|
```
|
|
513
700
|
|
|
514
701
|
### Webhooks de mensagens de status do sistema
|
|
@@ -538,7 +725,8 @@ As alterações se aplicam a webhooks de mensagens com [status do sistema](/docu
|
|
|
538
725
|
"system": {
|
|
539
726
|
"body": "User...", <!-- CHANGED -->
|
|
540
727
|
"wa_id": "<NEW_WHATSAPP_USER_ID>", <!-- CHANGED -->
|
|
541
|
-
"user_id": "<NEW_BSUID>", <!-- ADDED -->
|
|
728
|
+
"user_id": "<NEW_BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
729
|
+
"parent_user_id": "<NEW_PARENT_BSUID>", <!-- ADDED -->
|
|
542
730
|
"type": "<SYSTEM_CHANGE_TYPE>" <!-- CHANGED -->
|
|
543
731
|
}
|
|
544
732
|
}
|
|
@@ -552,7 +740,9 @@ As alterações se aplicam a webhooks de mensagens com [status do sistema](/docu
|
|
|
552
740
|
}
|
|
553
741
|
```
|
|
554
742
|
|
|
555
|
-
- `
|
|
743
|
+
- `system`
|
|
744
|
+
- `body`: nova string. Será definida como `User <WHATSAPP_USER_PROFILE_NAME> changed from <OLD_BSUID> to <NEW_BSUID>` se o usuário tiver alterado o número de telefone comercial.- `wa_id`: novo comportamento (pode ser omitido).
|
|
745
|
+
- Será omitido se o usuário tiver habilitado o recurso de nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- Será definido como o número de telefone do usuário, se ele não tiver habilitado o recurso de nomes de usuário.- `user_id`: nova propriedade. Será definido como o novo BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o novo [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, ela será omitida. `type`: novo valor (`user_changed_user_id`). Será definido como `user_changed_user_id` se o usuário do WhatsApp tiver alterado o número de telefone.
|
|
556
746
|
|
|
557
747
|
### Webhooks user\_preferences
|
|
558
748
|
|
|
@@ -576,17 +766,21 @@ As alterações serão aplicadas aos webhooks [user\_preferences](/documentation
|
|
|
576
766
|
{
|
|
577
767
|
"profile": {
|
|
578
768
|
"name": "<WHATSAPP_USER_NAME>",
|
|
579
|
-
|
|
580
|
-
|
|
769
|
+
|
|
770
|
+
<!-- Only included if user has enabled the usernames feature -->
|
|
771
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
581
772
|
},
|
|
582
773
|
"wa_id": "<WHATSAPP_USER_ID>", <!-- CHANGED -->
|
|
583
|
-
"user_id": "<BSUID>"
|
|
774
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if you have enabled parent BSUIDs -->
|
|
775
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
584
776
|
}
|
|
585
777
|
],
|
|
586
778
|
"user_preferences": [
|
|
587
779
|
{
|
|
588
780
|
"wa_id": "<WHATSAPP_USER_ID>", <!-- CHANGED -->
|
|
589
|
-
"user_id": "<BSUID>", <!-- ADDED -->
|
|
781
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if you have enabled parent BSUIDs -->
|
|
782
|
+
"parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
783
|
+
|
|
590
784
|
"detail": "<PREFERENCE_DESCRIPTION>",
|
|
591
785
|
"category": "marketing_messages",
|
|
592
786
|
"value": "<PREFERENCE>",
|
|
@@ -602,7 +796,11 @@ As alterações serão aplicadas aos webhooks [user\_preferences](/documentation
|
|
|
602
796
|
}
|
|
603
797
|
```
|
|
604
798
|
|
|
605
|
-
- `
|
|
799
|
+
- `contacts`
|
|
800
|
+
- `profile`
|
|
801
|
+
- `username`: nova propriedade. Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário. A propriedade será omitida se o usuário tiver desabilitado o recurso de nome de usuário.- `wa_id`: novo comportamento (pode ser omitido).
|
|
802
|
+
- Será omitido se o usuário tiver habilitado o recurso de nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- Será definido como o número de telefone do usuário, se ele não tiver habilitado o recurso de nomes de usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `user_preferences`
|
|
803
|
+
- `wa_id`: novo comportamento (pode ser omitido). Será omitido se o usuário tiver habilitado o recurso de nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
606
804
|
|
|
607
805
|
## API de Grupos
|
|
608
806
|
|
|
@@ -614,10 +812,11 @@ As alterações se aplicam a respostas do ponto de extremidade [GET /<GROUP\_ID>
|
|
|
614
812
|
{
|
|
615
813
|
"participants": [
|
|
616
814
|
{
|
|
617
|
-
"wa_id": "<USER_PHONE_NUMBER>"
|
|
618
|
-
"user_id": "<BSUID>",
|
|
619
|
-
"
|
|
620
|
-
"
|
|
815
|
+
"wa_id": "<USER_PHONE_NUMBER>" <!-- CHANGED -->
|
|
816
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only returned if the you have enabled parent BSUIDs -->
|
|
817
|
+
"parent_user_id": "<PARENT_BSUID>", <!-- ADDED --><!-- Only returned if the user has enabled the usernames feature -->
|
|
818
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
819
|
+
|
|
621
820
|
}
|
|
622
821
|
],
|
|
623
822
|
"subject": "<GROUP_SUBJECT>",
|
|
@@ -626,7 +825,9 @@ As alterações se aplicam a respostas do ponto de extremidade [GET /<GROUP\_ID>
|
|
|
626
825
|
}
|
|
627
826
|
```
|
|
628
827
|
|
|
629
|
-
- `wa_id`: novo
|
|
828
|
+
- `wa_id`: novo comportamento (pode ser omitido).
|
|
829
|
+
- Será omitido se o usuário tiver habilitado o recurso de nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- Será definido como o número de telefone do usuário, se ele não tiver habilitado o recurso de nomes de usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `username`: nova propriedade.
|
|
830
|
+
- Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário.- Será omitida se o usuário não estiver usando ou tiver desabilitado o recurso de nome de usuário.
|
|
630
831
|
|
|
631
832
|
### Como obter as solicitações para participar de grupos
|
|
632
833
|
|
|
@@ -639,9 +840,9 @@ As alterações se aplicam a respostas do ponto de extremidade [GET /<GROUP\_ID>
|
|
|
639
840
|
"join_request_id": "<JOIN_REQUEST_ID>",
|
|
640
841
|
"creation_timestamp": "<JOIN_REQUEST_TIMESTAMP>",
|
|
641
842
|
"wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
642
|
-
"user_id": "<BSUID>", <!-- ADDED -->
|
|
643
|
-
"
|
|
644
|
-
"
|
|
843
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
844
|
+
"parent_user_id": "<PARENT_BSUID>", <!-- ADDED --><!-- Only included if user has enabled usernames feature -->
|
|
845
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
645
846
|
}
|
|
646
847
|
],
|
|
647
848
|
"paging": {
|
|
@@ -653,7 +854,8 @@ As alterações se aplicam a respostas do ponto de extremidade [GET /<GROUP\_ID>
|
|
|
653
854
|
}
|
|
654
855
|
```
|
|
655
856
|
|
|
656
|
-
- `wa_id`: novo
|
|
857
|
+
- `wa_id`: novo comportamento (pode ser omitido).
|
|
858
|
+
- Será omitido se o usuário tiver habilitado o recurso de nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- Será definido como o número de telefone do usuário, se ele não tiver habilitado o recurso de nomes de usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `username`: nova propriedade. Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário. Será omitida se o usuário não tiver habilitado o recurso de nome de usuário.
|
|
657
859
|
|
|
658
860
|
### Como remover participantes do grupo
|
|
659
861
|
|
|
@@ -678,6 +880,91 @@ curl -g -X DELETE 'https://graph.facebook.com/<API_VERSION>/<GROUP_ID>/participa
|
|
|
678
880
|
|
|
679
881
|
## Webhooks da API de Grupos
|
|
680
882
|
|
|
883
|
+
### Webhooks de mensagens de status para grupos
|
|
884
|
+
|
|
885
|
+
Essas alterações serão aplicadas a webhooks de mensagens de status `delivered`, `read` e [](/documentation/business-messaging/whatsapp/webhooks/reference/messages/status)para mensagens enviadas a um grupo.
|
|
886
|
+
|
|
887
|
+
```
|
|
888
|
+
{
|
|
889
|
+
"object": "whatsapp_business_account",
|
|
890
|
+
"entry": [
|
|
891
|
+
{
|
|
892
|
+
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
|
|
893
|
+
"changes": [
|
|
894
|
+
{
|
|
895
|
+
"value": {
|
|
896
|
+
"messaging_product": "whatsapp",
|
|
897
|
+
"metadata": {
|
|
898
|
+
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
|
|
899
|
+
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
|
|
900
|
+
},
|
|
901
|
+
|
|
902
|
+
<!-- Contacts will be included for delivered and read status -->
|
|
903
|
+
"contacts": [ <!-- ADDED -->
|
|
904
|
+
{
|
|
905
|
+
"profile": {
|
|
906
|
+
"name": "<USER_DISPLAY_NAME>", <!-- ADDED --><!-- Only included if user has enabled usernames feature -->
|
|
907
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
908
|
+
},
|
|
909
|
+
"wa_id": "<USER_PHONE_NUMBER>", <!-- ADDED -->
|
|
910
|
+
"user_id": "<BSUID>", <!-- ADDED -->
|
|
911
|
+
|
|
912
|
+
<-- Only included if parent BSUIDs enabled -->
|
|
913
|
+
"parent_user_id": "<PARENT_BSUID>"
|
|
914
|
+
},
|
|
915
|
+
# Additional contact objects would follow, if aggregated
|
|
916
|
+
{
|
|
917
|
+
...
|
|
918
|
+
}
|
|
919
|
+
],
|
|
920
|
+
|
|
921
|
+
"statuses": [
|
|
922
|
+
{
|
|
923
|
+
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
924
|
+
"status": "<STATUS>",
|
|
925
|
+
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
926
|
+
"recipient_id": "<GROUP_ID>",
|
|
927
|
+
"recipient_type": "group",
|
|
928
|
+
"recipient_participant_id": "<GROUP_PARTICIPANT_USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
929
|
+
"recipient_participant_user_id": "<BSUID>", <-- ADDED -->
|
|
930
|
+
|
|
931
|
+
<!-- Only included if parent BSUIDs enabled -->
|
|
932
|
+
"recipient_participant_parent_user_id": "<PARENT_BSUID>", <-- ADDED -->
|
|
933
|
+
|
|
934
|
+
<!-- Omitted for v24.0+ unless webhook is for a free entry point conversation -->
|
|
935
|
+
"conversation": {
|
|
936
|
+
"id": "<CONVERSATION_ID>",
|
|
937
|
+
"expiration_timestamp": "<CONVERSATION_EXPIRATION_TIMESTAMP>",
|
|
938
|
+
"origin": {
|
|
939
|
+
"type": "<CONVERSATION_CATEGORY>"
|
|
940
|
+
}
|
|
941
|
+
},
|
|
942
|
+
|
|
943
|
+
"pricing": {
|
|
944
|
+
"billable": <IS_BILLABLE?>,
|
|
945
|
+
"pricing_model": "<PRICING_MODEL>",
|
|
946
|
+
"type": "<PRICING_TYPE>",
|
|
947
|
+
"category": "<PRICING_CATEGORY>"
|
|
948
|
+
}
|
|
949
|
+
},
|
|
950
|
+
# Additional status objects would follow, if aggregated
|
|
951
|
+
{
|
|
952
|
+
...
|
|
953
|
+
}
|
|
954
|
+
]
|
|
955
|
+
},
|
|
956
|
+
"field": "messages"
|
|
957
|
+
}
|
|
958
|
+
]
|
|
959
|
+
}
|
|
960
|
+
]
|
|
961
|
+
}
|
|
962
|
+
```
|
|
963
|
+
|
|
964
|
+
- `contacts`: nova matriz. Incluído apenas em mensagens com status entregue ou lida. Será omitida por completo para webhooks de mensagens de status com falha.
|
|
965
|
+
- `name`: nova propriedade. O valor será definido como o nome de exibição do usuário do WhatsApp.- `username`: nova propriedade. Será definida como o nome de usuário do WhatsApp se o usuário tiver adotado um nome de usuário. Será omitida para webhooks de mensagens de status enviadas ou se o usuário não tiver habilitado o recurso de nomes de usuário.- `wa_id`: nova propriedade.
|
|
966
|
+
- Será omitida se o usuário tiver adotado um nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- Será definido como o número de telefone do usuário se a mensagem foi enviada para o número de telefone dele.- `user_id`: nova propriedade. Será definida como o BSUID do usuário do WhatsApp.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `recipient_participant_id`: alterada. Será definida como o número de telefone do usuário se a mensagem tiver sido enviada para o respectivo número. Caso contrário, o campo será omitido.- `recipient_participant_user_id`: se você tiver enviado a mensagem para o BSUID do usuário ou para o BSUID principal, esse campo será definido como o BSUID do usuário ou o BSUID principal. Caso contrário, o campo será omitido.- `recipient_participant_parent_user_id`: nova propriedade. Será definida como o BSUID principal do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
967
|
+
|
|
681
968
|
### Webhooks group\_participants\_update
|
|
682
969
|
|
|
683
970
|
Essas alterações se aplicam ao webhook [group\_participants\_update](/documentation/business-messaging/whatsapp/groups/webhooks#group-participants-update-webhooks).
|
|
@@ -709,6 +996,7 @@ Essas alterações se aplicam ao webhook [group\_participants\_update](/document
|
|
|
709
996
|
"input": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
710
997
|
}
|
|
711
998
|
],
|
|
999
|
+
|
|
712
1000
|
"initiated_by": "business"
|
|
713
1001
|
|
|
714
1002
|
<!-- Only if user removes themself from group -->
|
|
@@ -717,11 +1005,12 @@ Essas alterações se aplicam ao webhook [group\_participants\_update](/document
|
|
|
717
1005
|
"removed_participants": [
|
|
718
1006
|
{
|
|
719
1007
|
"wa_id": "<USER_PHONE_NUMBER>" <!-- CHANGED -->
|
|
720
|
-
"user_id": "<BSUID>",
|
|
721
|
-
"
|
|
722
|
-
"
|
|
1008
|
+
"user_id": "<BSUID>", <!-- ADDED -->
|
|
1009
|
+
"parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1010
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
723
1011
|
}
|
|
724
1012
|
],
|
|
1013
|
+
|
|
725
1014
|
"initiated_by": "participant"
|
|
726
1015
|
|
|
727
1016
|
<!-- Only if user joins group via invite link -->
|
|
@@ -731,8 +1020,8 @@ Essas alterações se aplicam ao webhook [group\_participants\_update](/document
|
|
|
731
1020
|
{
|
|
732
1021
|
"wa_id": "<USER_PHONE_NUMBER>" <!-- CHANGED -->
|
|
733
1022
|
"user_id": "<BSUID>", <!-- ADDED -->
|
|
734
|
-
"
|
|
735
|
-
"
|
|
1023
|
+
"parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1024
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
736
1025
|
}
|
|
737
1026
|
]
|
|
738
1027
|
|
|
@@ -741,15 +1030,14 @@ Essas alterações se aplicam ao webhook [group\_participants\_update](/document
|
|
|
741
1030
|
"join_request_id": "<JOIN_REQUEST_ID>",
|
|
742
1031
|
"wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
743
1032
|
"user_id": "<BSUID>", <!-- ADDED -->
|
|
744
|
-
"
|
|
745
|
-
"
|
|
1033
|
+
"parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1034
|
+
"username": "<USERNAME>" <!-- ADDED --><!-- Only if join request revoked -->
|
|
746
1035
|
"type": "group_join_request_revoked",
|
|
747
1036
|
"join_request_id": "<JOIN_REQUEST_ID>",
|
|
748
1037
|
"wa_id": "<USER_PHONE_NUMBER>" <!-- CHANGED -->
|
|
749
1038
|
"user_id": "<BSUID>", <!-- ADDED -->
|
|
750
|
-
"
|
|
751
|
-
"
|
|
752
|
-
|
|
1039
|
+
"parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1040
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
753
1041
|
}
|
|
754
1042
|
]
|
|
755
1043
|
},
|
|
@@ -761,7 +1049,9 @@ Essas alterações se aplicam ao webhook [group\_participants\_update](/document
|
|
|
761
1049
|
}
|
|
762
1050
|
```
|
|
763
1051
|
|
|
764
|
-
- `
|
|
1052
|
+
- `input`: novo valor (BSUID ou BSUID principal).
|
|
1053
|
+
- Será definido como o número de telefone do usuário se você tiver removido o usuário do grupo usando o número de telefone dele.- Será definido como o BSUID do usuário ou o BSUID principal se você tiver removido o usuário do grupo usando o BSUID do usuário ou o BSUID principal.- `wa_id`: novo comportamento (pode ser omitido).
|
|
1054
|
+
- Será omitido se o usuário tiver habilitado o recurso de nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `username`: nova propriedade. Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.
|
|
765
1055
|
|
|
766
1056
|
## API de Bloqueio de Usuários
|
|
767
1057
|
|
|
@@ -769,6 +1059,38 @@ Essas alterações se aplicam ao webhook [group\_participants\_update](/document
|
|
|
769
1059
|
|
|
770
1060
|
As alterações se aplicam às solicitações POST e DELETE para [bloquear usuários](/documentation/business-messaging/whatsapp/block-users). Este exemplo mostra a sintaxe de uma solicitação para bloquear um usuário, mas as alterações também se aplicam a solicitações de desbloqueio.
|
|
771
1061
|
|
|
1062
|
+
```
|
|
1063
|
+
curl 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/block_users' \
|
|
1064
|
+
-H 'Content-Type: application/json' \
|
|
1065
|
+
-H 'Authorization: Bearer <ACCESS_TOKENS>' \
|
|
1066
|
+
-d '
|
|
1067
|
+
{
|
|
1068
|
+
"messaging_product": "whatsapp",
|
|
1069
|
+
"block_users": [
|
|
1070
|
+
{
|
|
1071
|
+
"user": "<USER_PHONE_NUMBER>"
|
|
1072
|
+
},
|
|
1073
|
+
{
|
|
1074
|
+
"user_id": "<BSUID>" <!-- ADDED -->
|
|
1075
|
+
}
|
|
1076
|
+
]
|
|
1077
|
+
}'
|
|
1078
|
+
```
|
|
1079
|
+
|
|
1080
|
+
É possível incluir `user` (número de telefone) e `user_id` (BSUID ou BSUID principal) na solicitação. Se fizer isso, `user` (número de telefone) terá precedência. Se preferir, você também poderá usar uma das seguintes opções:
|
|
1081
|
+
|
|
1082
|
+
Para bloquear ou desbloquear um usuário usando o número de telefone:
|
|
1083
|
+
|
|
1084
|
+
- Defina `user` como o número de telefone do usuário- Omita o objeto `user_id`
|
|
1085
|
+
|
|
1086
|
+
Para bloquear ou desbloquear um usuário usando o BSUID do usuário ou o BSUID principal:
|
|
1087
|
+
|
|
1088
|
+
- Defina `user_id` como o BSUID do usuário ou o BSUID principal- Omita o objeto `user`
|
|
1089
|
+
|
|
1090
|
+
### Como bloquear ou desbloquear respostas a solicitações
|
|
1091
|
+
|
|
1092
|
+
As alterações serão aplicadas às respostas de solicitações POST e DELETE para [bloquear usuários](/documentation/business-messaging/whatsapp/block-users).
|
|
1093
|
+
|
|
772
1094
|
```
|
|
773
1095
|
{
|
|
774
1096
|
"messaging_product": "whatsapp",
|
|
@@ -784,7 +1106,10 @@ As alterações se aplicam às solicitações POST e DELETE para [bloquear usuá
|
|
|
784
1106
|
}
|
|
785
1107
|
```
|
|
786
1108
|
|
|
787
|
-
- `input`:
|
|
1109
|
+
- `input`: novo valor (BSUID ou BSUID principal).
|
|
1110
|
+
- Será definida como o BSUID do usuário ou o BSUID principal se você tiver usado o BSUID do usuário ou o BSUID principal para bloquear ou desbloquear o usuário.- Será definido como o número de telefone do usuário se você tiver usado o número de telefone dele ao bloqueá-lo ou desbloqueá-lo.- `wa_id`: novo comportamento (pode ser omitido).
|
|
1111
|
+
- Será omitido se você tiver usado o BSUID do usuário ou o BSUID principal ao bloquear ou desbloquear o usuário.- Será definido como o número de telefone do usuário se você tiver usado o número de telefone dele para bloqueá-lo ou desbloqueá-lo.- `user_id`: nova propriedade.
|
|
1112
|
+
- Será definida como o BSUID do usuário ou o BSUID principal se você tiver usado o BSUID do usuário ou o BSUID principal para bloqueá-lo ou desbloqueá-lo.- Será omitida se você tiver usado o número de telefone do usuário para bloqueá-lo ou desbloqueá-lo.
|
|
788
1113
|
|
|
789
1114
|
## API de Ligações
|
|
790
1115
|
|
|
@@ -800,6 +1125,7 @@ As alterações se aplicam a solicitações da API de Ligações iniciadas pela
|
|
|
800
1125
|
{
|
|
801
1126
|
"messaging_product": "whatsapp",
|
|
802
1127
|
"to": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1128
|
+
"recipient": "<BSUID>", <!-- ADDED -->
|
|
803
1129
|
"action": "connect",
|
|
804
1130
|
"session": {
|
|
805
1131
|
"sdp_type": "offer",
|
|
@@ -808,18 +1134,37 @@ As alterações se aplicam a solicitações da API de Ligações iniciadas pela
|
|
|
808
1134
|
}'
|
|
809
1135
|
```
|
|
810
1136
|
|
|
811
|
-
|
|
1137
|
+
É possível incluir `to` (número de telefone) e `recipient` (BSUID ou BSUID principal) na solicitação. Se fizer isso, `to` (número de telefone) terá precedência. Se preferir, você também poderá usar uma das seguintes opções:
|
|
1138
|
+
|
|
1139
|
+
Para fazer uma ligação usando apenas o número de telefone do usuário:
|
|
1140
|
+
|
|
1141
|
+
- defina `to` como o número de telefone do usuário- omita a propriedade `recipient`
|
|
1142
|
+
|
|
1143
|
+
Para chamar um usuário usando apenas o BSUID dele ou o BSUID principal:
|
|
1144
|
+
|
|
1145
|
+
- defina `recipient` como o BSUID do usuário ou o BSUID principal- omita a propriedade `to`
|
|
812
1146
|
|
|
813
1147
|
### Como obter permissões de ligação
|
|
814
1148
|
|
|
815
1149
|
As alterações se aplicam a solicitações para [obter permissões para ligações](/documentation/business-messaging/whatsapp/calling/user-call-permissions#call-permission-request-basics). Não há alterações nas respostas.
|
|
816
1150
|
|
|
1151
|
+
Obter permissões de ligação usando o número de telefone do usuário:
|
|
1152
|
+
|
|
1153
|
+
```
|
|
1154
|
+
curl 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/call_permissions?user_wa_id=<USER_PHONE_NUMBER>' \
|
|
1155
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
1156
|
+
```
|
|
1157
|
+
|
|
1158
|
+
- `user_wa_id`: definido como o número de telefone do usuário.
|
|
1159
|
+
|
|
1160
|
+
Obter permissões de ligação usando o BSUID do usuário ou o BSUID principal:
|
|
1161
|
+
|
|
817
1162
|
```
|
|
818
|
-
curl 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/call_permissions?
|
|
1163
|
+
curl 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/call_permissions?recipient=<BSUID>' \
|
|
819
1164
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
820
1165
|
```
|
|
821
1166
|
|
|
822
|
-
- `
|
|
1167
|
+
- `recipient`: defina como o BSUID do usuário ou o BSUID principal.
|
|
823
1168
|
|
|
824
1169
|
### Como enviar uma solicitação de permissão para ligação
|
|
825
1170
|
|
|
@@ -827,7 +1172,75 @@ Confira como [enviar pedidos de contato](#send-message-requests).
|
|
|
827
1172
|
|
|
828
1173
|
### Webhooks de solicitação de permissão para ligação
|
|
829
1174
|
|
|
830
|
-
|
|
1175
|
+
As alterações serão aplicadas aos webhooks de resposta de permissão de ligação recebida [interactive messages](/documentation/business-messaging/whatsapp/webhooks/reference/messages/interactive).
|
|
1176
|
+
|
|
1177
|
+
```
|
|
1178
|
+
{
|
|
1179
|
+
"object": "whatsapp_business_account",
|
|
1180
|
+
"entry": [
|
|
1181
|
+
{
|
|
1182
|
+
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
|
|
1183
|
+
"changes": [
|
|
1184
|
+
{
|
|
1185
|
+
"value": {
|
|
1186
|
+
"messaging_product": "whatsapp",
|
|
1187
|
+
"metadata": {
|
|
1188
|
+
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
|
|
1189
|
+
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
|
|
1190
|
+
},
|
|
1191
|
+
"contacts": [
|
|
1192
|
+
{
|
|
1193
|
+
"profile": {
|
|
1194
|
+
"name": "<WHATSAPP_USER_PROFILE_NAME>",
|
|
1195
|
+
|
|
1196
|
+
<!-- Only included if user has enabled the usernames feature -->
|
|
1197
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
1198
|
+
|
|
1199
|
+
},
|
|
1200
|
+
"wa_id": "<WHATSAPP_USER_ID>", <!-- CHANGED -->
|
|
1201
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1202
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
1203
|
+
|
|
1204
|
+
}
|
|
1205
|
+
],
|
|
1206
|
+
"messages": [
|
|
1207
|
+
{
|
|
1208
|
+
"context": {
|
|
1209
|
+
"from": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
|
|
1210
|
+
"id": "<CONTEXTUAL_WHATSAPP_MESSAGE_ID>"
|
|
1211
|
+
},
|
|
1212
|
+
"from": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1213
|
+
"from_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1214
|
+
"from_parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
1215
|
+
|
|
1216
|
+
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
1217
|
+
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
1218
|
+
"type": "interactive",
|
|
1219
|
+
"interactive": {
|
|
1220
|
+
"type": "call_permission_reply",
|
|
1221
|
+
"call_permission_reply": {
|
|
1222
|
+
"response": accept,
|
|
1223
|
+
"expiration_timestamp": "<EXPIRATION_TIMTESTAMP>",
|
|
1224
|
+
"response_source": "<RESPONSE_SOURCE>"
|
|
1225
|
+
}
|
|
1226
|
+
}
|
|
1227
|
+
}
|
|
1228
|
+
]
|
|
1229
|
+
},
|
|
1230
|
+
"field": "messages"
|
|
1231
|
+
}
|
|
1232
|
+
]
|
|
1233
|
+
}
|
|
1234
|
+
]
|
|
1235
|
+
}
|
|
1236
|
+
```
|
|
1237
|
+
|
|
1238
|
+
- `contacts`
|
|
1239
|
+
- `profile`
|
|
1240
|
+
- `username`: nova propriedade. Será definida como o nome de usuário do WhatsApp se o usuário tiver adotado um nome de usuário. Se o usuário não tiver um nome de usuário, o campo será omitido.- `wa_id`: nova propriedade.
|
|
1241
|
+
- Será omitida se o usuário tiver adotado um nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- Será definida como o número de telefone do usuário se o usuário não tiver adotado um nome de usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `messages`
|
|
1242
|
+
- `from`: novo comportamento (pode ser omitido).
|
|
1243
|
+
- Será definida como o número de telefone do usuário caso ele não tenha habilitado o recurso de nome de usuário.- Será omitido se o usuário tiver habilitado o recurso de nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- `from_user_id`: nova propriedade. Será definida como o BSUID do usuário.
|
|
831
1244
|
|
|
832
1245
|
### Webhooks de ligações conectadas iniciadas pela empresa
|
|
833
1246
|
|
|
@@ -844,15 +1257,17 @@ As alterações se aplicam a webhooks de [ligações conectadas](/documentation/
|
|
|
844
1257
|
"contacts": [ <!-- ADDED -->
|
|
845
1258
|
{
|
|
846
1259
|
"profile": {
|
|
847
|
-
|
|
848
|
-
"
|
|
1260
|
+
<!-- Only included if user has enabled the usernames feature -->
|
|
1261
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
849
1262
|
},
|
|
850
|
-
"
|
|
1263
|
+
"wa_id": "<USER_PHONE_NUMBER>", <!-- ADDED -->
|
|
1264
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1265
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
851
1266
|
}
|
|
852
1267
|
],
|
|
853
1268
|
"calls": [
|
|
854
1269
|
{
|
|
855
|
-
"biz_opaque_callback_data": "<
|
|
1270
|
+
"biz_opaque_callback_data": "<DATA>",
|
|
856
1271
|
"session": {
|
|
857
1272
|
"sdp_type": "answer",
|
|
858
1273
|
"sdp": "<SDP>"
|
|
@@ -860,7 +1275,9 @@ As alterações se aplicam a webhooks de [ligações conectadas](/documentation/
|
|
|
860
1275
|
"from": "<BUSINESS_PHONE_NUMBER>",
|
|
861
1276
|
"id": "<WHATSAPP_CALL_ID>",
|
|
862
1277
|
"to": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
863
|
-
"to_user_id": "<BSUID>", <!-- ADDED -->
|
|
1278
|
+
"to_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1279
|
+
"to_parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1280
|
+
|
|
864
1281
|
"event": "connect",
|
|
865
1282
|
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
866
1283
|
"direction": "BUSINESS_INITIATED"
|
|
@@ -881,7 +1298,12 @@ As alterações se aplicam a webhooks de [ligações conectadas](/documentation/
|
|
|
881
1298
|
}
|
|
882
1299
|
```
|
|
883
1300
|
|
|
884
|
-
- `contacts`:
|
|
1301
|
+
- `contacts`: nova matriz.
|
|
1302
|
+
- `profile`
|
|
1303
|
+
- `username`: nova propriedade.
|
|
1304
|
+
- Será definida como o nome de usuário do WhatsApp se o usuário tiver adotado um nome de usuário.- Será omitida para webhooks de mensagens de status enviadas ou se o usuário não estiver usando um nome de usuário.- `wa_id`: nova propriedade.
|
|
1305
|
+
- Será omitida se o usuário tiver adotado um nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers).- Será definido como o número de telefone do usuário se a mensagem foi enviada para o número de telefone dele.- `user_id`: nova propriedade. Será definida como o BSUID do usuário do WhatsApp.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `calls`
|
|
1306
|
+
- `to`: novo comportamento (pode ser omitido). Será definido como o número de telefone do usuário se ele tiver adotado um nome de usuário e for possível incluir o número de telefone dele com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o campo será omitido.- `to_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `to_parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, a propriedade será totalmente omitida.
|
|
885
1307
|
|
|
886
1308
|
### Webhooks de ligações conectadas iniciadas pelo usuário
|
|
887
1309
|
|
|
@@ -906,7 +1328,9 @@ As alterações serão aplicadas a webhooks de [ligações conectadas](/document
|
|
|
906
1328
|
"sdp": "<SDP>"
|
|
907
1329
|
},
|
|
908
1330
|
"from": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
909
|
-
"from_user_id": "<BSUID>", <!-- ADDED -->
|
|
1331
|
+
"from_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1332
|
+
"from_parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1333
|
+
|
|
910
1334
|
"id": "<WHATSAPP_CALL_ID>",
|
|
911
1335
|
"to": "<BUSINESS_PHONE_NUMBER>",
|
|
912
1336
|
"event": "connect",
|
|
@@ -918,11 +1342,14 @@ As alterações serão aplicadas a webhooks de [ligações conectadas](/document
|
|
|
918
1342
|
{
|
|
919
1343
|
"wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
920
1344
|
"profile": {
|
|
921
|
-
"name": "<USER_DISPLAY_NAME>", <!-- ADDED -->
|
|
922
|
-
"username": "<USERNAME>"
|
|
923
|
-
|
|
1345
|
+
"name": "<USER_DISPLAY_NAME>", <!-- ADDED --><!-- Only included if user has enabled usernames feature -->
|
|
1346
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
1347
|
+
|
|
924
1348
|
},
|
|
925
|
-
"user_id": "<BSUID>" <!-- ADDED
|
|
1349
|
+
"user_id": "<BSUID>" <!-- ADDED -->,
|
|
1350
|
+
|
|
1351
|
+
<!-- Only included if parent BSUIDs enabled -->
|
|
1352
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
926
1353
|
}
|
|
927
1354
|
],
|
|
928
1355
|
"messaging_product": "whatsapp"
|
|
@@ -936,7 +1363,10 @@ As alterações serão aplicadas a webhooks de [ligações conectadas](/document
|
|
|
936
1363
|
}
|
|
937
1364
|
```
|
|
938
1365
|
|
|
939
|
-
- `
|
|
1366
|
+
- `calls`
|
|
1367
|
+
- `from`: novo comportamento (pode ser omitido). Será omitido se o nome de usuário tiver habilitado o recurso de nomes de usuário e não for possível incluir o número de telefone dele com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `from_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `from_parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `contacts`
|
|
1368
|
+
- `wa_id`: novo comportamento (pode ser omitido).
|
|
1369
|
+
- Será omitida se o usuário tiver adotado um nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `name`: nova propriedade. Será definida como o nome do perfil do usuário.- `username`: nova propriedade. Se o usuário tiver definido um nome de usuário, ele será usado para esse campo. Caso contrário, o campo será omitido.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
940
1370
|
|
|
941
1371
|
### Webhooks de ligações iniciadas pela empresa que foram encerradas
|
|
942
1372
|
|
|
@@ -956,7 +1386,9 @@ As alterações se aplicam a webhooks de ligações iniciadas pela empresa que f
|
|
|
956
1386
|
"from": "<BUSINESS_PHONE_NUMBER>",
|
|
957
1387
|
"id": "<WHATSAPP_CALL_ID>",
|
|
958
1388
|
"to": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
959
|
-
"to_user_id": "<BSUID>", <!-- ADDED -->
|
|
1389
|
+
"to_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1390
|
+
"to_parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1391
|
+
|
|
960
1392
|
"event": "terminate",
|
|
961
1393
|
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
962
1394
|
"direction": "BUSINESS_INITIATED",
|
|
@@ -967,14 +1399,15 @@ As alterações se aplicam a webhooks de ligações iniciadas pela empresa que f
|
|
|
967
1399
|
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>",
|
|
968
1400
|
"display_phone_number": "<BUSINESS_PHONE_NUMBER>"
|
|
969
1401
|
},
|
|
970
|
-
"contacts": [
|
|
1402
|
+
"contacts": [ <!-- ADDED -->
|
|
971
1403
|
{
|
|
972
1404
|
"profile": {
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
1405
|
+
<!-- Only included if user has enabled the usernames feature -->
|
|
1406
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
976
1407
|
},
|
|
977
|
-
"
|
|
1408
|
+
"wa_id": "<USER_PHONE_NUMBER>", <!-- ADDED -->
|
|
1409
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1410
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
978
1411
|
}
|
|
979
1412
|
],
|
|
980
1413
|
"messaging_product": "whatsapp"
|
|
@@ -988,7 +1421,10 @@ As alterações se aplicam a webhooks de ligações iniciadas pela empresa que f
|
|
|
988
1421
|
}
|
|
989
1422
|
```
|
|
990
1423
|
|
|
991
|
-
- `
|
|
1424
|
+
- `calls`
|
|
1425
|
+
- `to`: novo comportamento (pode ser omitido). Será definido como o número de telefone do usuário se ele tiver adotado um nome de usuário e for possível incluir o número de telefone dele com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o campo será omitido.- `to_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `to_parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `contacts`: nova matriz.
|
|
1426
|
+
- `profile`
|
|
1427
|
+
- `username`: nova propriedade. Se o usuário tiver definido um nome de usuário, ele será usado para esse campo. Caso contrário, o campo será omitido.- `wa_id`: nova propriedade. Será definida como o número de telefone do usuário se a ligação encerrada tiver sido feita para o número do usuário. Caso contrário, o campo será omitido.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
992
1428
|
|
|
993
1429
|
### Webhooks de ligações encerradas iniciadas pelo usuário
|
|
994
1430
|
|
|
@@ -1013,7 +1449,9 @@ As alterações serão aplicadas aos webhooks de ligações iniciadas pelo usuá
|
|
|
1013
1449
|
"biz_opaque_callback_data": "<BUSINESS_OPAQUE_DATA>",
|
|
1014
1450
|
"end_time": "<CALL_END_TIMESTAMP>",
|
|
1015
1451
|
"from": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1016
|
-
"from_user_id": "<BSUID>", <!-- ADDED -->
|
|
1452
|
+
"from_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if you have enabled parent BSUIDs -->
|
|
1453
|
+
"from_parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1454
|
+
|
|
1017
1455
|
"id": "<WHATSAPP_CALL_ID>",
|
|
1018
1456
|
"to": "<BUSINESS_PHONE_NUMBER>",
|
|
1019
1457
|
"event": "terminate",
|
|
@@ -1024,12 +1462,13 @@ As alterações serão aplicadas aos webhooks de ligações iniciadas pelo usuá
|
|
|
1024
1462
|
],
|
|
1025
1463
|
"contacts": [
|
|
1026
1464
|
{
|
|
1027
|
-
"wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1028
1465
|
"profile": {
|
|
1029
|
-
"name": "<USER_PROFILE_NAME>"
|
|
1030
|
-
"
|
|
1466
|
+
"name": "<USER_PROFILE_NAME>" <!-- ADDED --><!-- Only included if user has enabled the usernames feature -->
|
|
1467
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
1031
1468
|
},
|
|
1032
|
-
"
|
|
1469
|
+
"wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1470
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if you have enabled parent BSUIDs -->
|
|
1471
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
1033
1472
|
}
|
|
1034
1473
|
],
|
|
1035
1474
|
"messaging_product": "whatsapp"
|
|
@@ -1043,7 +1482,10 @@ As alterações serão aplicadas aos webhooks de ligações iniciadas pelo usuá
|
|
|
1043
1482
|
}
|
|
1044
1483
|
```
|
|
1045
1484
|
|
|
1046
|
-
- `
|
|
1485
|
+
- `calls`
|
|
1486
|
+
- `from`: novo comportamento (pode ser omitido). Será omitida se o usuário tiver habilitado o recurso de nomes de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `from_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `from_parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `contacts`
|
|
1487
|
+
- `profile`
|
|
1488
|
+
- `name`: nova propriedade. Será definida como o nome do perfil do usuário- `username`: nova propriedade. Se o usuário tiver definido um nome de usuário, ele será usado para esse campo. Caso contrário, o campo será omitido.- `wa_id`: será omitida se o usuário tiver habilitado o recurso de nomes de usuário e não for possível incluir o número de telefone dele com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
1047
1489
|
|
|
1048
1490
|
### Webhooks de status de ligações iniciadas pela empresa
|
|
1049
1491
|
|
|
@@ -1064,21 +1506,24 @@ As alterações serão aplicadas a webhooks de [status de ligações](/documenta
|
|
|
1064
1506
|
"type": "call",
|
|
1065
1507
|
"status": "<STATUS>",
|
|
1066
1508
|
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
1067
|
-
"recipient_id": "<USER_PHONE_NUMBER>",
|
|
1068
|
-
"recipient_user_id": "<BSUID>"
|
|
1509
|
+
"recipient_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1510
|
+
"recipient_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if you have enabled parent BSUIDs -->
|
|
1511
|
+
"recipient_parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
1069
1512
|
}
|
|
1070
1513
|
],
|
|
1071
1514
|
"metadata": {
|
|
1072
1515
|
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>",
|
|
1073
1516
|
"display_phone_number": "<BUSINESS_PHONE_NUMBER>"
|
|
1074
1517
|
},
|
|
1075
|
-
"contacts": [
|
|
1518
|
+
"contacts": [ <!-- ADDED -->
|
|
1076
1519
|
{
|
|
1077
1520
|
"profile": {
|
|
1078
|
-
|
|
1079
|
-
"
|
|
1521
|
+
<!-- Only included if user has enabled the usernames feature -->
|
|
1522
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
1080
1523
|
},
|
|
1081
|
-
"
|
|
1524
|
+
"wa_id": "<USER_PHONE_NUMBER>", <!-- ADDED -->
|
|
1525
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if you have enabled parent BSUIDs -->
|
|
1526
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
1082
1527
|
}
|
|
1083
1528
|
],
|
|
1084
1529
|
"messaging_product": "whatsapp"
|
|
@@ -1092,7 +1537,11 @@ As alterações serão aplicadas a webhooks de [status de ligações](/documenta
|
|
|
1092
1537
|
}
|
|
1093
1538
|
```
|
|
1094
1539
|
|
|
1095
|
-
- `
|
|
1540
|
+
- `statuses`
|
|
1541
|
+
- `recipient_id`: novo comportamento (pode ser omitido).
|
|
1542
|
+
- Será omitida se o usuário tiver adotado um nome de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `recipient_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `recipient_parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `contacts`: nova matriz.
|
|
1543
|
+
- `profile`
|
|
1544
|
+
- `username`: nova propriedade. Será definida como o nome de usuário caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.- `wa_id`: nova propriedade. Será definida como o número de telefone do usuário se a ligação tiver sido feita para o número do usuário. Caso contrário, o campo será omitido.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: nova propriedade. Será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
1096
1545
|
|
|
1097
1546
|
### Convites de SIP para ligações iniciadas pela empresa
|
|
1098
1547
|
|
|
@@ -1100,7 +1549,7 @@ As alterações se aplicam a ligações iniciadas pela empresa usando [SIP](/doc
|
|
|
1100
1549
|
|
|
1101
1550
|
```
|
|
1102
1551
|
<!-- BEGIN CHANGE -->
|
|
1103
|
-
INVITE sip:<
|
|
1552
|
+
INVITE sip:<BSUID_OR_PHONE_NUMBER>@wa.meta.vc;transport=tls SIP/2.0
|
|
1104
1553
|
<!-- END CHANGE -->
|
|
1105
1554
|
|
|
1106
1555
|
Record-Route: <sip:+159.65.244.171:5061;transport=tls;lr;ftag=Kc9QZg4496maQ;nat=yes>
|
|
@@ -1110,7 +1559,7 @@ Max-Forwards: 69
|
|
|
1110
1559
|
From: <sip:+17125550259@meta-voip.example.com>;tag=Kc9QZg4496maQ
|
|
1111
1560
|
|
|
1112
1561
|
<!-- BEGIN CHANGE -->
|
|
1113
|
-
To: <sip:<
|
|
1562
|
+
To: <sip:<BSUID_OR_PHONE_NUMBER>@wa.meta.vc>
|
|
1114
1563
|
<!-- END CHANGE -->
|
|
1115
1564
|
|
|
1116
1565
|
Call-ID: dc2c5b33-1b81-43ee-9213-afb56f4e56ba
|
|
@@ -1133,7 +1582,7 @@ Content-Length: 2427
|
|
|
1133
1582
|
<!-- SDP omitted for brevity -->
|
|
1134
1583
|
```
|
|
1135
1584
|
|
|
1136
|
-
-
|
|
1585
|
+
- <BSUID\_OR\_PHONE\_NUMBER>: será o BSUID do usuário ou o BSUID principal se a ligação tiver sido feita para o BSUID do usuário ou o BSUID principal, ou o número de telefone do usuário se a mensagem tiver sido enviada para o número de telefone dele.
|
|
1137
1586
|
|
|
1138
1587
|
### Convites de SIP para ligações iniciadas pelo usuário
|
|
1139
1588
|
|
|
@@ -1145,13 +1594,13 @@ Via: SIP/2.0/TLS [2803:6080:e888:51aa:d4a4:c5e0:300:0]:33819;rport=33819;receive
|
|
|
1145
1594
|
Max-Forwards: 70
|
|
1146
1595
|
|
|
1147
1596
|
<!-- BEGIN CHANGE -->
|
|
1148
|
-
From: "<
|
|
1597
|
+
From: "<BSUID_OR_PHONE_NUMBER>" <sip:<BSUID_OR_PHONE_NUMBER>@wa.meta.vc>;tag=bbf1ad6e-79bb-4d9c-8a2c-094168a10bea
|
|
1149
1598
|
<!-- END CHANGE -->
|
|
1150
1599
|
|
|
1151
1600
|
To: <sip:+17015558857@meta-voip.example.com>
|
|
1152
1601
|
|
|
1153
1602
|
<!-- BEGIN CHANGE -->
|
|
1154
|
-
Contact: <sip:<
|
|
1603
|
+
Contact: <sip:<BSUID_OR_PHONE_NUMBER>@wa.meta.vc;transport=tls;ob>;isfocus
|
|
1155
1604
|
<!-- END CHANGE -->
|
|
1156
1605
|
|
|
1157
1606
|
Call-ID: outgoing:wacid.HBgLMTIxOTU1NTA3MTQVAgASGCAzODg1NTE5NEU1NTBEMTc1RTFFQUY5NjNCQ0FCRkEzRhwYCzE3MDE1NTU4ODU3FQIAAA==
|
|
@@ -1161,8 +1610,8 @@ X-FB-External-Domain: wa.meta.vc
|
|
|
1161
1610
|
|
|
1162
1611
|
<!-- BEGIN ADDITION -->
|
|
1163
1612
|
x-wa-meta-user-id: <BSUID>
|
|
1164
|
-
x-
|
|
1165
|
-
x-wa-meta-user-
|
|
1613
|
+
x-wa_meta-parent-user-id: <PARENT_BSUID>
|
|
1614
|
+
x-wa-meta-user-name: <USERNAME><!-- END ADDITION -->
|
|
1166
1615
|
|
|
1167
1616
|
Allow: INVITE, ACK, BYE, CANCEL, NOTIFY, OPTIONS
|
|
1168
1617
|
User-Agent: Facebook SipGateway
|
|
@@ -1172,7 +1621,7 @@ Content-Length: 1028
|
|
|
1172
1621
|
<!-- SDP omitted for brevity -->
|
|
1173
1622
|
```
|
|
1174
1623
|
|
|
1175
|
-
-
|
|
1624
|
+
- `<BSUID>`: será definido como o BSUID do usuário.- `<BSUID_OR_PHONE_NUMBER>`: será o BSUID do usuário ou o BSUID principal se a ligação tiver sido feita para o BSUID do usuário ou para o BSUID principal, ou se o usuário tiver adotado um nome de usuário e não conseguirmos incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, será o número de telefone do usuário.- `<PARENT_BSUID>`: será definido como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `<USERNAME>`: será o nome de usuário caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.
|
|
1176
1625
|
|
|
1177
1626
|
### Respostas OK do SIP para ligações iniciadas pela empresa
|
|
1178
1627
|
|
|
@@ -1187,7 +1636,7 @@ Record-Route: <sip:54.172.60.1;lr;r2=on>
|
|
|
1187
1636
|
Call-ID: f304a1d2cafb8139c1f9ff93a7733586@0.0.0.0
|
|
1188
1637
|
|
|
1189
1638
|
<!-- BEGIN CHANGE -->
|
|
1190
|
-
From: "<
|
|
1639
|
+
From: "<BSUID_OR_PHONE_NUMBER>" <sip:<BSUID_OR_PHONE_NUMBER>@meta-voip.example.com>;tag=28460006_c3356d0b_5cdada8c-cbf0-4369-b02d-cc97d3c36f2b
|
|
1191
1640
|
<!-- END CHANGE -->
|
|
1192
1641
|
|
|
1193
1642
|
To: <sip:12195550714@wa.meta.vc>;tag=0d185053-2615-46c7-8ff2-250bda494cf1
|
|
@@ -1197,11 +1646,11 @@ Supported: timer
|
|
|
1197
1646
|
X-FB-External-Domain: wa.meta.vc
|
|
1198
1647
|
|
|
1199
1648
|
<!-- BEGIN CHANGE -->
|
|
1200
|
-
|
|
1649
|
+
<sip:<BSUID_OR_PHONE_NUMBER>@wa.meta.vc;transport=tls;ob;X-FB-Sip-Smc-Tier=collaboration.sip_gateway.sip.prod>;isfocus
|
|
1201
1650
|
<!-- END CHANGE --><!-- BEGIN ADDITION -->
|
|
1202
1651
|
x-wa-meta-user-id: <BSUID>
|
|
1203
|
-
x-
|
|
1204
|
-
x-wa-meta-user-
|
|
1652
|
+
x-wa_meta-parent-user-id: <PARENT_BSUID>
|
|
1653
|
+
x-wa-meta-user-name: <USERNAME><!-- END ADDITION -->
|
|
1205
1654
|
|
|
1206
1655
|
Content-Type: application/sdp
|
|
1207
1656
|
Content-Length: 645
|
|
@@ -1209,7 +1658,7 @@ Content-Length: 645
|
|
|
1209
1658
|
<!-- SDP omitted for brevity -->
|
|
1210
1659
|
```
|
|
1211
1660
|
|
|
1212
|
-
-
|
|
1661
|
+
- `<BSUID>`: será definido como o BSUID do usuário.- `<BSUID_OR_PHONE_NUMBER>`: será o BSUID do usuário ou o BSUID principal se a ligação tiver sido feita para o BSUID do usuário ou para o BSUID principal, ou se o usuário tiver adotado um nome de usuário e não conseguirmos incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, será o número de telefone do usuário.- `<PARENT_BSUID>`: será definido como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `<USERNAME>`: será definida como o nome de usuário caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.
|
|
1213
1662
|
|
|
1214
1663
|
### Respostas BYE do SIP para ligações iniciadas pela empresa e pelo usuário
|
|
1215
1664
|
|
|
@@ -1223,7 +1672,7 @@ Via: SIP/2.0/TLS [2803:6080:e934:3f82:b543:8a4d:1414:a00]:52767;rport=52767;rece
|
|
|
1223
1672
|
Max-Forwards: 69
|
|
1224
1673
|
|
|
1225
1674
|
<!-- BEGIN CHANGE -->
|
|
1226
|
-
From: <sip:<
|
|
1675
|
+
From: <sip:<BSUID_OR_PHONE_NUMBER>@wa.meta.vc>;tag=0fb8b5f1-2703-49f4-a454-46b1bcb9bfac
|
|
1227
1676
|
<!-- END CHANGE -->
|
|
1228
1677
|
|
|
1229
1678
|
To: <sip:+12195550714@dev.moxcal.com>;tag=2c21fad0-c581-4e54-a707-3bd52abfcc3f
|
|
@@ -1232,8 +1681,8 @@ CSeq: 31641 BYE
|
|
|
1232
1681
|
|
|
1233
1682
|
<!-- BEGIN ADDITION -->
|
|
1234
1683
|
x-wa-meta-user-id: <BSUID>
|
|
1235
|
-
x-
|
|
1236
|
-
x-wa-meta-user-
|
|
1684
|
+
x-wa_meta-parent-user-id: <PARENT_BSUID>
|
|
1685
|
+
x-wa-meta-user-name: <USERNAME><!-- END ADDITION -->
|
|
1237
1686
|
|
|
1238
1687
|
X-FB-External-Domain: wa.meta.vc
|
|
1239
1688
|
Allow: INVITE, ACK, BYE, CANCEL, NOTIFY, OPTIONS
|
|
@@ -1241,7 +1690,7 @@ User-Agent: Facebook SipGateway
|
|
|
1241
1690
|
Content-Length: 0
|
|
1242
1691
|
```
|
|
1243
1692
|
|
|
1244
|
-
-
|
|
1693
|
+
- `<BSUID>`: será definido como o BSUID do usuário.- `<BSUID_OR_PHONE_NUMBER>`: será o BSUID do usuário ou o BSUID principal se a ligação tiver sido feita para o BSUID do usuário ou para o BSUID principal, ou se o usuário tiver adotado um nome de usuário e não conseguirmos incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, será o número de telefone do usuário.- `<PARENT_BSUID>`: será definido como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `<USERNAME>`: será definida como o nome de usuário caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.
|
|
1245
1694
|
|
|
1246
1695
|
## Coexistência
|
|
1247
1696
|
|
|
@@ -1271,20 +1720,23 @@ As alterações serão aplicadas aos webhooks de [histórico](/documentation/bus
|
|
|
1271
1720
|
"progress": <PROGRESS>
|
|
1272
1721
|
},
|
|
1273
1722
|
"threads": [
|
|
1274
|
-
|
|
1723
|
+
/* First chat history thread object */
|
|
1275
1724
|
{
|
|
1276
|
-
"id": "<WHATSAPP_USER_PHONE_NUMBER>",
|
|
1277
|
-
"context": {
|
|
1278
|
-
"wa_id": "<WHATSAPP_USER_PHONE_NUMBER>",
|
|
1279
|
-
"user_id": "<BSUID>",
|
|
1280
|
-
"
|
|
1281
|
-
"
|
|
1725
|
+
"id": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1726
|
+
"context": { <!-- ADDED -->
|
|
1727
|
+
"wa_id": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- ADDED -->
|
|
1728
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled before sync request -->
|
|
1729
|
+
"parent_user_id": "<PARENT_BSUID>", <!-- ADDED --><!-- Only included if user has enabled usernames feature before sync request -->
|
|
1730
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
1731
|
+
|
|
1282
1732
|
},
|
|
1283
1733
|
"messages": [
|
|
1284
|
-
|
|
1734
|
+
/* First message object in thread */
|
|
1285
1735
|
{
|
|
1286
1736
|
"from": "<BUSINESS_OR_WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1287
|
-
"from_user_id" : "<BSUID>",
|
|
1737
|
+
"from_user_id" : "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled before sync request -->
|
|
1738
|
+
"from_parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1739
|
+
|
|
1288
1740
|
"to": "<WHATSAPP_USER_PHONE_NUMBER>",
|
|
1289
1741
|
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
1290
1742
|
"timestamp": "<DEVICE_TIMESTAMP>,
|
|
@@ -1296,10 +1748,10 @@ As alterações serão aplicadas aos webhooks de [histórico](/documentation/bus
|
|
|
1296
1748
|
"status": "<MESSAGE_STATUS>"
|
|
1297
1749
|
}
|
|
1298
1750
|
},
|
|
1299
|
-
|
|
1751
|
+
/* Additional message objects in thread would follow, if any */
|
|
1300
1752
|
]
|
|
1301
1753
|
},
|
|
1302
|
-
|
|
1754
|
+
/* Additional chat history thread objects would follow, if any */
|
|
1303
1755
|
]
|
|
1304
1756
|
}
|
|
1305
1757
|
]
|
|
@@ -1312,7 +1764,12 @@ As alterações serão aplicadas aos webhooks de [histórico](/documentation/bus
|
|
|
1312
1764
|
}
|
|
1313
1765
|
```
|
|
1314
1766
|
|
|
1315
|
-
- `id`: novo
|
|
1767
|
+
- `id`: novo comportamento (pode ser omitido). Será omitido se, no momento da solicitação de sincronização do histórico, o usuário já tiver habilitado nomes de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `context`: novo objeto de contexto.
|
|
1768
|
+
- `wa_id`: nova propriedade.
|
|
1769
|
+
- Será omitida se, no momento da solicitação de sincronização, o usuário já tiver habilitado o recurso de nomes de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#parent-business-scoped-user-ids). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `username`: nova propriedade.
|
|
1770
|
+
- Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.- `messages`
|
|
1771
|
+
- `from`: novo comportamento (pode ser omitido).
|
|
1772
|
+
- Será omitido se, no momento da solicitação de sincronização, o usuário já tiver habilitado o recurso de nomes de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `from_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `from_parent_user_id`: será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
1316
1773
|
|
|
1317
1774
|
As alterações serão aplicadas a webhooks de [histórico](/documentation/business-messaging/whatsapp/webhooks/reference/history) que descrevem um ativo de mídia enviado de um usuário do WhatsApp para um cliente comercial ou vice-versa.
|
|
1318
1775
|
|
|
@@ -1330,22 +1787,26 @@ As alterações serão aplicadas a webhooks de [histórico](/documentation/busin
|
|
|
1330
1787
|
"display_phone_number": "<CUSTOMER_DISPLAY_PHONE_NUMBER>",
|
|
1331
1788
|
"phone_number_id": "<CUSTOMER_PHONE_NUMBER_ID>"
|
|
1332
1789
|
},
|
|
1333
|
-
"contacts": [
|
|
1790
|
+
"contacts": [ <!-- ADDED -->
|
|
1334
1791
|
{
|
|
1792
|
+
|
|
1793
|
+
<!-- Profile only included if user has enabled the usernames feature -->
|
|
1335
1794
|
"profile": {
|
|
1336
|
-
"username": "<USERNAME>",
|
|
1337
|
-
"country_code": "<COUNTRY_CODE>" <!-- ADDED -->
|
|
1795
|
+
"username": "<USERNAME>", <!-- ADDED -->
|
|
1338
1796
|
},
|
|
1339
|
-
"wa_id": "<WHATSAPP_USER_PHONE_NUMBER>",
|
|
1340
|
-
"user_id": "<BSUID>"
|
|
1797
|
+
"wa_id": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- ADDED -->
|
|
1798
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1799
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
1341
1800
|
},
|
|
1342
1801
|
],
|
|
1343
1802
|
|
|
1344
1803
|
<!-- Only for messages sent from a user to a business -->
|
|
1345
1804
|
"messages": [
|
|
1346
1805
|
{
|
|
1347
|
-
"from": "<WHATSAPP_USER_PHONE_NUMBER>",
|
|
1348
|
-
"from_user_id": "<BSUID>",
|
|
1806
|
+
"from": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1807
|
+
"from_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1808
|
+
"from_parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1809
|
+
|
|
1349
1810
|
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
1350
1811
|
"timestamp": "<ORIGINAL_WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
1351
1812
|
"type": "<MEDIA_TYPE>",
|
|
@@ -1359,8 +1820,10 @@ As alterações serão aplicadas a webhooks de [histórico](/documentation/busin
|
|
|
1359
1820
|
"message_echoes": [
|
|
1360
1821
|
{
|
|
1361
1822
|
"from": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
|
|
1362
|
-
"to": "<WHATSAPP_USER_PHONE_NUMBER>",
|
|
1363
|
-
"to_user_id": "<BSUID>",
|
|
1823
|
+
"to": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1824
|
+
"to_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1825
|
+
"to_parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1826
|
+
|
|
1364
1827
|
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
1365
1828
|
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
1366
1829
|
"type": "<MESSAGE_TYPE>",
|
|
@@ -1379,7 +1842,14 @@ As alterações serão aplicadas a webhooks de [histórico](/documentation/busin
|
|
|
1379
1842
|
}
|
|
1380
1843
|
```
|
|
1381
1844
|
|
|
1382
|
-
- `contacts`:
|
|
1845
|
+
- `contacts`: novo objeto.
|
|
1846
|
+
- `profile`
|
|
1847
|
+
- `username`: nova propriedade. Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.- `wa_id`: nova propriedade.
|
|
1848
|
+
- Será omitido se, no momento da solicitação de sincronização, o usuário já tiver habilitado o recurso de nomes de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `messages`
|
|
1849
|
+
- `from`: novo comportamento (pode ser omitido).
|
|
1850
|
+
- Será omitido se, no momento da solicitação de sincronização, o usuário já tiver habilitado o recurso de nomes de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `from_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `from_parent_user_id`: será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `message_echoes`
|
|
1851
|
+
- `to`: novo comportamento (pode ser omitido).
|
|
1852
|
+
- Será omitido se, no momento da solicitação de sincronização, o usuário já tiver habilitado o recurso de nomes de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `to_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `to_parent_user_id`: será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
1383
1853
|
|
|
1384
1854
|
### Webhooks smb\_message\_echoes
|
|
1385
1855
|
|
|
@@ -1401,19 +1871,24 @@ As alterações serão aplicadas aos webhooks [smb\_message\_echoes](/documentat
|
|
|
1401
1871
|
},
|
|
1402
1872
|
"contacts": [ <!-- ADDED -->
|
|
1403
1873
|
{
|
|
1874
|
+
|
|
1875
|
+
<!-- Only included if user has enabled the usernames feature -->
|
|
1404
1876
|
"profile": {
|
|
1405
|
-
"username": "<USERNAME>"
|
|
1406
|
-
"country_code": "<COUNTRY_CODE>" <!-- ADDED -->
|
|
1877
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
1407
1878
|
},
|
|
1879
|
+
|
|
1408
1880
|
"wa_id": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- ADDED -->
|
|
1409
|
-
"user_id": "<BSUID>"
|
|
1881
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1882
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
1410
1883
|
}
|
|
1411
1884
|
],
|
|
1412
1885
|
"message_echoes": [
|
|
1413
1886
|
{
|
|
1414
1887
|
"from": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
|
|
1415
1888
|
"to": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1416
|
-
"to_user_id": "<BSUID>", <!-- ADDED -->
|
|
1889
|
+
"to_user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1890
|
+
"to_parent_user_id": "<PARENT_BSUID>", <!-- ADDED -->
|
|
1891
|
+
|
|
1417
1892
|
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
1418
1893
|
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
1419
1894
|
"type": "<MESSAGE_TYPE>",
|
|
@@ -1431,7 +1906,10 @@ As alterações serão aplicadas aos webhooks [smb\_message\_echoes](/documentat
|
|
|
1431
1906
|
}
|
|
1432
1907
|
```
|
|
1433
1908
|
|
|
1434
|
-
- `contacts`:
|
|
1909
|
+
- `contacts`: nova matriz.
|
|
1910
|
+
- `profile`
|
|
1911
|
+
- `username`: nova propriedade. Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.- `wa_id`: nova propriedade. Será omitido se, quando o cliente empresarial usou o app WhatsApp Business para enviar a mensagem ao usuário, o usuário já tiver habilitado o recurso de nomes de usuário e não conseguirmos incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `message_echoes`
|
|
1912
|
+
- `to`: novo comportamento (pode ser omitido). Será omitido se, quando o cliente empresarial usou o app WhatsApp Business para enviar a mensagem ao usuário, o usuário já tiver habilitado o recurso de nomes de usuário e não conseguirmos incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `to_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `to_parent_user_id`: será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
1435
1913
|
|
|
1436
1914
|
### Webhooks smb\_app\_state\_sync
|
|
1437
1915
|
|
|
@@ -1458,9 +1936,9 @@ As alterações serão aplicadas aos webhooks [smb\_app\_state\_sync](/documenta
|
|
|
1458
1936
|
"full_name": "<CONTACT_FULL_NAME>",
|
|
1459
1937
|
"first_name": "<CONTACT_FIRST_NAME>",
|
|
1460
1938
|
"phone_number": "<CONTACT_PHONE_NUMBER>", <!-- CHANGED -->
|
|
1461
|
-
"user_id": "<BSUID>", <!-- ADDED -->
|
|
1462
|
-
"
|
|
1463
|
-
"
|
|
1939
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1940
|
+
"parent_user_id": "<PARENT_BSUID>", <!-- ADDED --><!-- Only included if user has enabled the usernames feature -->
|
|
1941
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
1464
1942
|
},
|
|
1465
1943
|
"action": "<ACTION>",
|
|
1466
1944
|
"metadata": {
|
|
@@ -1478,7 +1956,130 @@ As alterações serão aplicadas aos webhooks [smb\_app\_state\_sync](/documenta
|
|
|
1478
1956
|
}
|
|
1479
1957
|
```
|
|
1480
1958
|
|
|
1481
|
-
- `phone_number`: novo
|
|
1959
|
+
- `phone_number`: novo comportamento (pode ser omitido). Será omitido se, no momento da solicitação de sincronização, o usuário já tiver habilitado nomes de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o número do usuário será definido como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.- `username`: nova propriedade. Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.
|
|
1960
|
+
|
|
1961
|
+
### Webhooks de revogar mensagens
|
|
1962
|
+
|
|
1963
|
+
As alterações serão aplicadas a webhooks de [revogação de mensagens](/documentation/business-messaging/whatsapp/webhooks/reference/messages/revoke).
|
|
1964
|
+
|
|
1965
|
+
```
|
|
1966
|
+
{
|
|
1967
|
+
"object": "whatsapp_business_account",
|
|
1968
|
+
"entry": [
|
|
1969
|
+
{
|
|
1970
|
+
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
|
|
1971
|
+
"changes": [
|
|
1972
|
+
{
|
|
1973
|
+
"value": {
|
|
1974
|
+
"messaging_product": "whatsapp",
|
|
1975
|
+
"metadata": {
|
|
1976
|
+
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
|
|
1977
|
+
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
|
|
1978
|
+
},
|
|
1979
|
+
"contacts": [
|
|
1980
|
+
{
|
|
1981
|
+
"profile": {
|
|
1982
|
+
"name": "<WHATSAPP_USER_PROFILE_NAME>",
|
|
1983
|
+
|
|
1984
|
+
<!-- Only included if user has enabled the usernames feature -->
|
|
1985
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
1986
|
+
},
|
|
1987
|
+
"wa_id": "<WHATSAPP_USER_ID>",
|
|
1988
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
1989
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
1990
|
+
}
|
|
1991
|
+
],
|
|
1992
|
+
"messages": [
|
|
1993
|
+
{
|
|
1994
|
+
"from": "<WHATSAPP_USER_PHONE_NUMBER>",
|
|
1995
|
+
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
1996
|
+
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
1997
|
+
"type": "revoke",
|
|
1998
|
+
"revoke": {
|
|
1999
|
+
"original_message_id": "<ORIGINAL_WHATSAPP_MESSAGE_ID>"
|
|
2000
|
+
}
|
|
2001
|
+
}
|
|
2002
|
+
]
|
|
2003
|
+
},
|
|
2004
|
+
"field": "messages"
|
|
2005
|
+
}
|
|
2006
|
+
]
|
|
2007
|
+
}
|
|
2008
|
+
]
|
|
2009
|
+
}
|
|
2010
|
+
```
|
|
2011
|
+
|
|
2012
|
+
- `contacts`
|
|
2013
|
+
- `profile`
|
|
2014
|
+
- `username`: nova propriedade. Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
2015
|
+
|
|
2016
|
+
### Webhooks de edição de mensagens
|
|
2017
|
+
|
|
2018
|
+
As alterações serão aplicadas aos webhooks de [edição de mensagens](/documentation/business-messaging/whatsapp/webhooks/reference/messages/edit).
|
|
2019
|
+
|
|
2020
|
+
```
|
|
2021
|
+
{
|
|
2022
|
+
"object": "whatsapp_business_account",
|
|
2023
|
+
"entry": [
|
|
2024
|
+
{
|
|
2025
|
+
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
|
|
2026
|
+
"changes": [
|
|
2027
|
+
{
|
|
2028
|
+
"value": {
|
|
2029
|
+
"messaging_product": "whatsapp",
|
|
2030
|
+
"metadata": {
|
|
2031
|
+
"display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
|
|
2032
|
+
"phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
|
|
2033
|
+
},
|
|
2034
|
+
"contacts": [
|
|
2035
|
+
{
|
|
2036
|
+
"profile": {
|
|
2037
|
+
"name": "<WHATSAPP_USER_PROFILE_NAME>",
|
|
2038
|
+
|
|
2039
|
+
<!-- Only included if the user has enabled usernames -->
|
|
2040
|
+
"username": "<USERNAME>" <!-- ADDED -->
|
|
2041
|
+
},
|
|
2042
|
+
"wa_id": "<WHATSAPP_USER_ID>", <!-- CHANGED -->
|
|
2043
|
+
"user_id": "<BSUID>", <!-- ADDED --><!-- Only included if parent BSUIDs enabled -->
|
|
2044
|
+
"parent_user_id": "<PARENT_BSUID>" <!-- ADDED -->
|
|
2045
|
+
}
|
|
2046
|
+
],
|
|
2047
|
+
"messages": [
|
|
2048
|
+
{
|
|
2049
|
+
"from": "<WHATSAPP_USER_PHONE_NUMBER>",
|
|
2050
|
+
"id": "<WHATSAPP_MESSAGE_ID>",
|
|
2051
|
+
"timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
|
|
2052
|
+
"type": "edit",
|
|
2053
|
+
"edit": {
|
|
2054
|
+
"original_message_id": "<ORIGINAL_WHATSAPP_MESSAGE_ID>",
|
|
2055
|
+
"message": {
|
|
2056
|
+
"context": {
|
|
2057
|
+
"id": "<CONTEXT_ID>"
|
|
2058
|
+
},
|
|
2059
|
+
"type": "image",
|
|
2060
|
+
"image": {
|
|
2061
|
+
"caption": "<MEDIA_ASSET_CAPTION>",
|
|
2062
|
+
"mime_type": "<MEDIA_ASSET_MIME_TYPE>",
|
|
2063
|
+
"sha256": "<MEDIA_ASSET_SHA256_HASH>",
|
|
2064
|
+
"id": "<MEDIA_ASSET_ID>",
|
|
2065
|
+
"url": "<MEDIA_ASSET_URL>"
|
|
2066
|
+
}
|
|
2067
|
+
}
|
|
2068
|
+
}
|
|
2069
|
+
}
|
|
2070
|
+
]
|
|
2071
|
+
},
|
|
2072
|
+
"field": "messages"
|
|
2073
|
+
}
|
|
2074
|
+
]
|
|
2075
|
+
}
|
|
2076
|
+
]
|
|
2077
|
+
}
|
|
2078
|
+
```
|
|
2079
|
+
|
|
2080
|
+
- `contacts`
|
|
2081
|
+
- `profile`
|
|
2082
|
+
- `username`: nova propriedade. Será definida como o nome de usuário, caso o usuário tenha habilitado o recurso de nome de usuário. Caso contrário, o campo será omitido.- `wa_id`: nova propriedade. Será omitida se, quando o usuário do WhatsApp editar a mensagem, ele já tiver habilitado o recurso de nomes de usuário e não for possível incluir o número de telefone com base nas condições descritas na seção [Números de telefone](#phone-numbers). Caso contrário, o campo será omitido.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `parent_user_id`: será definida como o [BSUID principal](#parent-business-scoped-user-ids) do usuário, se você tiver habilitado os BSUIDs principais. Caso contrário, o campo será omitido.
|
|
1482
2083
|
|
|
1483
2084
|
## Análise
|
|
1484
2085
|
|
|
@@ -1486,35 +2087,35 @@ Nenhuma alteração.
|
|
|
1486
2087
|
|
|
1487
2088
|
## Cobrança e faturamento
|
|
1488
2089
|
|
|
1489
|
-
Nenhuma alteração
|
|
2090
|
+
Nenhuma alteração.
|
|
1490
2091
|
|
|
1491
2092
|
## Perguntas frequentes
|
|
1492
2093
|
|
|
1493
2094
|
**O que preciso fazer para aceitar nomes de usuário?**
|
|
1494
2095
|
|
|
1495
|
-
As cargas de webhooks passarão a incluir
|
|
2096
|
+
As cargas de webhooks passarão a incluir os BSUIDs e os BSUIDs principais a partir de março de 2026, antes que os nomes de usuário fiquem disponíveis para os usuários do WhatsApp. Para processar mensagens de usuários que habilitarem o recurso assim que ele estiver disponível, você precisará aceitar BSUIDs (e os BSUIDs principais, se estiverem habilitados). Para isso, você deve:
|
|
1496
2097
|
|
|
1497
|
-
- Atualizar suas integrações de webhook para aceitar BSUIDs
|
|
2098
|
+
- Atualizar suas integrações de webhook para aceitar BSUIDs (e o [BSUID principal](#parent-business-scoped-user-ids), se estiver utilizando).- Desenvolver lógica para possibilitar o uso de vários identificadores (números de telefone de usuários que não são nomes de usuário; BSUIDs dos usuários que adotam nomes de usuário se o número de telefone não estiver presente nos webhooks) e mapear os campos relevantes de volta para seu CRM/banco de dados.- Atualizar sistemas internos e externos relacionados a essas integrações para poder lidar com BSUIDs e combinar com identificadores anteriores; principalmente CRM (3P ou banco de dados interno) e quaisquer ferramentas ou fluxos de trabalho disparados do CRM (por exemplo, mensagens de campanha disparadas, gerenciamento de campanhas, mensuração, cobrança etc.).- Caso você ainda precise do número de telefone do cliente, atualize os bots/jornadas de mensagens (se usados) para solicitar o telefone, lidar com cenários em que os usuários não compartilham o número de telefone e fazer iterações sobre essas novas jornadas de conversa. Consulte os [Termos do WhatsApp Business para Soluções](https://l.facebook.com/l.php?u=https%3A%2F%2Fwww.whatsapp.com%2Flegal%2Fbusiness-solution-terms&h=AT6YMuGiXXpq0BTzHMUw-UtTvOeBzfXSfEpoxQ53DXVnMryFpJ6NK0iAtQQR9_saZnunUEyHeFF_A6iFs-T8hUTd6uxXGVQMOicu7JxpnXucNr0zmylzJ3zP4nMCTJ06ArFJ4PviX23AFMDJXGh_whggxMA) para ver as restrições gerais aos casos de uso de IA.- Caso você tenha vários portfólios empresariais na Meta, implemente uma solução que permita o acesso central ao CRM em todos eles para minimizar as despesas operacionais relacionadas ao uso e armazenamento de BSUIDs (e BSUIDs principais).
|
|
1498
2099
|
|
|
1499
|
-
**Quando receberei uma BSUID ou um número de telefone?**
|
|
2100
|
+
**Quando receberei uma BSUID ou uma BSUID principal em vez de um número de telefone?**
|
|
1500
2101
|
|
|
1501
|
-
Quando um usuário adota um nome de usuário, ele tem privacidade de número de telefone, ou seja, o número não será exibido no app nem será incluído em webhooks. Se o número de telefone do usuário não estiver presente (a propriedade
|
|
2102
|
+
Quando um usuário adota um nome de usuário, ele tem privacidade de número de telefone, ou seja, o número não será exibido no app nem será incluído em webhooks. Se o número de telefone do usuário não estiver presente (a propriedade wa\_id não estiver presente), será possível usar o BSUID do usuário (ou o [BSUID principal](#parent-business-scoped-user-ids), se estiver em uso), que será incluído e atribuído a uma nova propriedade user\_id (`parent_user_id` para BSUIDs principais).
|
|
1502
2103
|
|
|
1503
|
-
Se um usuário não tiver adotado nomes de usuário, você receberá o número de telefone e o BSUID.
|
|
2104
|
+
Se um usuário não tiver adotado nomes de usuário, você receberá o número de telefone e o BSUID do usuário (e o BSUID principal, se estiver habilitado).
|
|
1504
2105
|
|
|
1505
|
-
Continuaremos compartilhando o número de telefone
|
|
1506
|
-
|
|
1507
|
-
Porém, de acordo com os Termos de Serviço da API de Nuvem, os números de telefone e os dados relacionados são armazenados por até 30 dias para compatibilidade com recursos como redirecionamento de mensagens. Em algumas situações, você pode receber mensagens de usuários existentes fora desse período de 30 dias, o que pode parecer uma nova conversa de usuário para você. Por isso, é essencial que você comece a aceitar BSUIDs assim que possível para evitar perder o contexto das conversas.
|
|
2106
|
+
Continuaremos compartilhando o número de telefone se [certas condições forem atendidas](#phone-numbers). Porém, de acordo com os Termos de Serviço da API de Nuvem, os números de telefone e os dados relacionados são armazenados por até 30 dias para compatibilidade com recursos como redirecionamento de mensagens. Em algumas situações, você pode receber mensagens de usuários existentes fora desse período de 30 dias, o que pode parecer uma nova conversa de usuário para você. Por isso, é essencial que você comece a aceitar BSUIDs assim que possível para evitar perder o contexto das conversas.
|
|
1508
2107
|
|
|
1509
2108
|
**Por que empresas e parceiros diretamente integrados que usam a API de Nuvem, incluindo anunciantes de anúncios de clique para o WhatsApp diretamente integrados, precisam adotar o BSUID?**
|
|
1510
2109
|
|
|
1511
|
-
Para continuar processando as mensagens recebidas de usuários do WhatsApp, os parceiros e as empresas devem adotar o BSUID. Depois que o BSUID for adotado e as mensagens de usuários com nomes de usuário forem processadas, os webhooks de mensagens não incluirão mais números de telefone em alguns casos como parte do webhook, como wa\_id. Portanto,
|
|
2110
|
+
Para continuar processando as mensagens recebidas de usuários do WhatsApp, os parceiros e as empresas devem adotar o BSUID. Depois que o BSUID for adotado e as mensagens de usuários com nomes de usuário forem processadas, os webhooks de mensagens não incluirão mais números de telefone em alguns casos como parte do webhook, como wa\_id. Portanto, qualquer pessoa que use a API de Nuvem deve garantir que todos os sistemas conectados sejam compatíveis com o BSUID. Também será possível pedir o número de telefone do usuário na conversa.
|
|
2111
|
+
|
|
2112
|
+
**Se eu ainda não tiver adotado os BSUIDs e começar a receber mensagens de usuários que não consigo processar, haverá algum recurso?**
|
|
1512
2113
|
|
|
1513
|
-
|
|
2114
|
+
Caso você ainda não tenha adotado o BSUID e não consiga processar mensagens de usuários que fizeram a alteração, não será possível tomar providências ou realizar ações corretivas.
|
|
1514
2115
|
|
|
1515
|
-
|
|
2116
|
+
Para mensagens de novos clientes: o webhook continuará sendo enviado de uma mensagem recebida. Dependendo dos detalhes da implementação, isso poderá afetar sistemas que não estão preparados para lidar com o recebimento de mensagens sem o número de telefone do usuário e o BSUID atribuído ao novo campo user\_id. Para mensagens de clientes existentes: o número de telefone continuará sendo incluído se as condições descritas na seção [Números de telefone](#phone-numbers) forem atendidas.
|
|
1516
2117
|
|
|
1517
|
-
|
|
2118
|
+
Depois de aceitar os BSUIDs, solicite os números de telefone dos usuários implementando um [botão de solicitação de número de telefone](#requesting-phone-numbers-from-users).
|
|
1518
2119
|
|
|
1519
2120
|
**Qual é a diferença entre o nome de usuário e o nome de exibição da empresa? Quando o usuário verá um nome de usuário comercial ou um nome de exibição?**
|
|
1520
2121
|
|
|
@@ -1524,7 +2125,17 @@ Os nomes de usuário comercial precisam seguir regras de formatação específic
|
|
|
1524
2125
|
|
|
1525
2126
|
Os nomes de usuário comercial são únicos e estão vinculados de forma individual aos números de telefone. Isso significa que @JaspersMarket seria vinculado a um número de telefone, enquanto @JaspersMarketCustomerSupport seria vinculado a outro. Os nomes de exibição não estão vinculados de forma individual aos números de telefone, ou seja, o nome de exibição Jasper's Market pode ter 10 números de telefone associados.
|
|
1526
2127
|
|
|
1527
|
-
Quando a empresa tiver um nome de usuário e um de exibição, o
|
|
2128
|
+
Quando a empresa tiver um nome de usuário e um de exibição, o nome de exibição será mostrado primeiro (por exemplo, no perfil, na lista de conversas, nas mensagens etc.). Dessa forma, as empresas poderão conquistar a confiança dos usuários e os usuários poderão reconhecer a empresa quando ela entrar em contato com eles.
|
|
2129
|
+
|
|
2130
|
+
## Registro de alterações do documento
|
|
2131
|
+
|
|
2132
|
+
### 18 de fevereiro de 2026
|
|
2133
|
+
|
|
2134
|
+
- Explicamos que as solicitações de API que aceitam um número de telefone e um BSUID ou um BSUID principal podem incluir ambos os identificadores simultaneamente, com o número de telefone tendo precedência. Atualizamos as solicitações para [enviar mensagem](#send-message-requests), [enviar mensagem de marketing](#send-marketing-message-requests), [solicitações de ligação iniciada pela empresa](#businesses-initiated-call-requests) e [para bloquear ou desbloquear usuários](#block-or-unblock-user-requests).
|
|
2135
|
+
|
|
2136
|
+
### 6 de fevereiro de 2026
|
|
2137
|
+
|
|
2138
|
+
- Alteramos o número de caracteres alfanuméricos que compõem [BSUIDs](#business-scoped-user-id) de 256 para 128 alfanuméricos.- Alteramos a forma de usar um BSUID para enviar uma mensagem. Agora, os BSUIDs devem ser atribuídos a propriedades/campos dedicados em solicitações de envio de mensagem (em vez de propriedades/campos existentes que aceitam BSUIDs e números de telefone).- Mudamos a forma como os [códigos de país](#country-codes) aparecerão nos webhooks: eles terão um prefixo para os BSUIDs do usuário em vez de serem atribuídos a uma propriedade de webhook dedicada.- Incluímos informações sobre o [BSUID principal](#parent-business-scoped-user-ids), que podem ser usadas em portfólios empresariais vinculados.- Incluímos informações da [lista de contatos](#contact-book), que podem armazenar automaticamente os números de telefone e BSUIDs dos usuários.- Incluímos informações sobre o [botão de solicitação de número de telefone](#requesting-phone-numbers-from-users).- Alteramos os exemplos de sintaxe, exemplos de carga e descrições para todos os webhooks que retornavam strings vazias nos casos em que um usuário habilitou o recurso de nomes de usuário. Agora, essas propriedades não serão definidas como uma string vazia. Em vez disso, elas serão omitidas (por exemplo, a propriedade `wa_id` em webhooks de mensagens recebidas).- Alteramos a forma de retornar erros ao tentar [adotar ou alterar um nome de usuário comercial](#adopt-or-change-a-business-username).- Alteramos a sintaxe da resposta para [obter o nome de usuário atual de uma empresa](#get-current-username).- Removemos a capacidade de cancelar solicitações de nome de usuário pendentes da empresa.- Mudamos o webhook phone\_number\_username\_update para o webhook [business\_username\_updates](#business_username_updates-webhook).
|
|
1528
2139
|
|
|
1529
2140
|
Você achou esta página útil?
|
|
1530
2141
|
|