whatsapp-docs-mcp 1.0.6 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. package/docs/ativos_da_conta/outros_ativos/display_names.md +9 -9
  2. package/docs/ativos_da_conta/outros_ativos/official_business_accounts.md +27 -27
  3. package/docs/ativos_da_conta/telefones_comerciais/phone_numbers.md +151 -27
  4. package/docs/business_profiles.md +72 -0
  5. package/docs/business_scoped_user_ids.md +1533 -0
  6. package/docs/dados_privacidade_e_politica/encryption.md +1 -1
  7. package/docs/flows/changelog.md +6 -6
  8. package/docs/flows/gettingstarted/health_insurance.md +12 -6
  9. package/docs/flows/gettingstarted/personalised_offer.md +6 -6
  10. package/docs/flows/gettingstarted/pre_approved_loan.md +6 -6
  11. package/docs/flows/gettingstarted/purchase_intent.md +2 -2
  12. package/docs/flows/gettingstarted.md +5 -5
  13. package/docs/flows/guias.md +1 -1
  14. package/docs/flows/playground.md +1 -1
  15. package/docs/flows/referencia.md +1 -1
  16. package/docs/flows/support.md +3 -3
  17. package/docs/flows.md +2 -2
  18. package/docs/insights/analytics.md +200 -66
  19. package/docs/ligacoes/call_settings.md +129 -57
  20. package/docs/ligacoes/calling.md +33 -16
  21. package/docs/ligacoes/integration_examples.md +526 -0
  22. package/docs/ligacoes/pricing.md +11 -300
  23. package/docs/ligacoes/sandbox.md +160 -0
  24. package/docs/ligacoes/video_calling.md +8 -0
  25. package/docs/mensagens/interactive_media_carousel_messages.md +256 -0
  26. package/docs/mensagens/interactive_product_carousel_messages.md +181 -0
  27. package/docs/mensagens/limites_de_mensagens/messaging_limits.md +16 -12
  28. package/docs/mensagens/recursos_adicionais/media.md +15 -16
  29. package/docs/mensagens/recursos_adicionais/payload_encryption.md +1 -1
  30. package/docs/mensagens/tipos_de_mensagens/audio_messages.md +11 -11
  31. package/docs/mensagens/tipos_de_mensagens/interactive_flow_messages.md +1 -1
  32. package/docs/mensagens/tipos_de_mensagens/message_with_link.md +1 -1
  33. package/docs/mensagens_de_marketing/changelog.md +299 -0
  34. package/docs/mensagens_de_marketing/features.md +184 -0
  35. package/docs/mensagens_de_marketing/implementacao/get_started.md +17 -21
  36. package/docs/mensagens_de_marketing/implementacao/send_marketing_messages.md +50 -45
  37. package/docs/mensagens_de_marketing/measure_conversion.md +132 -0
  38. package/docs/mensagens_de_marketing/onboarding.md +282 -0
  39. package/docs/mensagens_de_marketing/recursos/automatic_creative_optimization.md +1 -1
  40. package/docs/mensagens_de_marketing/recursos/conversion_measurement.md +1 -1
  41. package/docs/mensagens_de_marketing/visao_geral/overview.md +11 -9
  42. package/docs/messaging_limits/upcoming_changes.md +1 -1
  43. package/docs/modelos/authentication_templates/bulk_management.md +145 -0
  44. package/docs/modelos/authentication_templates/template_preview.md +109 -0
  45. package/docs/modelos/gerenciamento_de_modelos/components.md +23 -23
  46. package/docs/modelos/gerenciamento_de_modelos/template_media.md +1 -1
  47. package/docs/modelos/modelos_de_marketing/marketing_templates.md +20 -20
  48. package/docs/modelos/modelos_de_marketing/per_user_limits.md +7 -5
  49. package/docs/modelos/portfolio_pacing.md +30 -0
  50. package/docs/modelos/visao_geral/overview.md +17 -17
  51. package/docs/pagamentos/payments_br/cards.md +8 -0
  52. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/transferring_wabas_to_customers.md +1 -1
  53. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_business_app_users.md +364 -75
  54. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/overview.md +34 -30
  55. package/docs/parceiros/migrate_existing_whatsapp_number_to_a_business_account.md +40 -0
  56. package/docs/parceiros/obo_model_deprecation.md +32 -0
  57. package/docs/parceiros/seja_um_parceiro/get_started_for_solution_partners.md +42 -42
  58. package/docs/parceiros/seja_um_parceiro/get_started_for_tech_providers.md +38 -142
  59. package/docs/recado/precos/pricing.md +82 -50
  60. package/docs/recado/precos/pricing_authentication_international_rates.md +16 -18
  61. package/docs/recado/precos/pricing_updates_to_pricing.md +1 -1
  62. package/docs/recado/sobre_a_plataforma/about_the_platform.md +80 -24
  63. package/docs/recado/sobre_a_plataforma/access_tokens.md +19 -19
  64. package/docs/referencia/bot_do_whatsapp_business/bot_details_api.md +4 -758
  65. package/docs/referencia/business/add_phone_numbers_api.md +4 -722
  66. package/docs/referencia/business/business_account_api.md +8 -0
  67. package/docs/referencia/business/client_whatsapp_business_accounts_api.md +4 -1002
  68. package/docs/referencia/business/owned_whatsapp_business_accounts.md +4 -798
  69. package/docs/referencia/business/whatsapp_business_accounts_api.md +4 -1546
  70. package/docs/referencia/business/whatsapp_business_partner_onboarding_to_mm_lite_api.md +4 -779
  71. package/docs/referencia/business/whatsapp_business_pre_verified_phone_number_sharing_api.md +4 -786
  72. package/docs/referencia/business/whatsapp_business_pre_verified_phone_numbers_api.md +4 -882
  73. package/docs/referencia/changelog.md +1837 -3
  74. package/docs/referencia/conta_do_whatsapp_business/assigned_users_management_api.md +4 -2198
  75. package/docs/referencia/conta_do_whatsapp_business/business_account_api.md +4 -263
  76. package/docs/referencia/conta_do_whatsapp_business/business_account_extended_credits_api.md +4 -271
  77. package/docs/referencia/conta_do_whatsapp_business/conversational_automation_api.md +4 -778
  78. package/docs/referencia/conta_do_whatsapp_business/flows_api.md +4 -1528
  79. package/docs/referencia/conta_do_whatsapp_business/in_progress_on_behalf_requests_api.md +1 -1
  80. package/docs/referencia/conta_do_whatsapp_business/migration_intent_api.md +4 -1577
  81. package/docs/referencia/conta_do_whatsapp_business/obo_mobility_intent_api.md +1 -1
  82. package/docs/referencia/conta_do_whatsapp_business/phone_number_management_api.md +4 -1682
  83. package/docs/referencia/conta_do_whatsapp_business/schedules_api.md +4 -1768
  84. package/docs/referencia/conta_do_whatsapp_business/set_obo_mobility_intent_api.md +1 -1
  85. package/docs/referencia/conta_do_whatsapp_business/set_solution_migration_intent_api.md +1 -1
  86. package/docs/referencia/conta_do_whatsapp_business/subscribed_apps_api.md +4 -2174
  87. package/docs/referencia/conta_do_whatsapp_business/template_api.md +4 -972
  88. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_activities_api.md +4 -838
  89. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_api.md +4 -1380
  90. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_solutions_list_api.md +4 -850
  91. package/docs/referencia/groups/groups_invite_link_api.md +8 -0
  92. package/docs/referencia/groups/groups_join_requests_api.md +8 -0
  93. package/docs/referencia/groups/groups_participants_api.md +8 -0
  94. package/docs/referencia/groups/groups_query_api.md +8 -0
  95. package/docs/referencia/grupo/groups_invite_link_api.md +4 -300
  96. package/docs/referencia/grupo/groups_join_requests_api.md +4 -682
  97. package/docs/referencia/grupo/groups_participants_api.md +4 -270
  98. package/docs/referencia/grupo/groups_query_api.md +4 -432
  99. package/docs/referencia/historico_de_mensagens/whatsapp_business_message_history_events_api.md +4 -862
  100. package/docs/referencia/inscricao/application_connected_client_businesses.md +4 -808
  101. package/docs/referencia/inscricao/application_solutions_api.md +4 -870
  102. package/docs/referencia/inscricao/solution_creation_api.md +4 -820
  103. package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/migration_intent_details_api.md +4 -720
  104. package/docs/referencia/midias/media_api.md +4 -338
  105. package/docs/referencia/midias/media_download_api.md +4 -156
  106. package/docs/referencia/numero_da_conta_do_whatsapp/whatsapp_account_number_api.md +4 -774
  107. package/docs/referencia/perfil_do_whatsapp_business/whatsapp_business_profile_node_api.md +4 -1490
  108. package/docs/referencia/solucao_do_whatsapp_business/accept_deactivation_request_api.md +4 -758
  109. package/docs/referencia/solucao_do_whatsapp_business/access_token_api.md +4 -700
  110. package/docs/referencia/solucao_do_whatsapp_business/reject_deactivation_request_api.md +4 -808
  111. package/docs/referencia/solucao_do_whatsapp_business/send_deactivation_request_api.md +4 -774
  112. package/docs/referencia/solucao_do_whatsapp_business/solution_accept_api.md +4 -808
  113. package/docs/referencia/solucao_do_whatsapp_business/solution_details_api.md +4 -764
  114. package/docs/referencia/solucao_do_whatsapp_business/solution_reject_api.md +4 -794
  115. package/docs/referencia/telefone_do_whatsapp_business/block_api.md +4 -538
  116. package/docs/referencia/telefone_do_whatsapp_business/business_compliance_information_api.md +4 -1604
  117. package/docs/referencia/telefone_do_whatsapp_business/business_encryption_api.md +4 -1398
  118. package/docs/referencia/telefone_do_whatsapp_business/calling_api.md +4 -594
  119. package/docs/referencia/telefone_do_whatsapp_business/encrypted_messages_api.md +4 -478
  120. package/docs/referencia/telefone_do_whatsapp_business/groups_management_api.md +4 -481
  121. package/docs/referencia/telefone_do_whatsapp_business/marketing_messages_lite_api.md +4 -311
  122. package/docs/referencia/telefone_do_whatsapp_business/media_upload_api.md +4 -184
  123. package/docs/referencia/telefone_do_whatsapp_business/message_api.md +4 -1794
  124. package/docs/referencia/telefone_do_whatsapp_business/phone_number_api.md +4 -373
  125. package/docs/referencia/telefone_do_whatsapp_business/phone_number_deregister_api.md +4 -710
  126. package/docs/referencia/telefone_do_whatsapp_business/phone_number_registration.md +4 -776
  127. package/docs/referencia/telefone_do_whatsapp_business/phone_number_verification_request_code_api.md +4 -730
  128. package/docs/referencia/telefone_do_whatsapp_business/register_api.md +4 -407
  129. package/docs/referencia/telefone_do_whatsapp_business/settings_api.md +4 -670
  130. package/docs/referencia/telefone_do_whatsapp_business/verify_code_api.md +4 -742
  131. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_message_history_api.md +4 -928
  132. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_official_business_account_status_api.md +4 -1536
  133. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_phone_number_api.md +4 -1596
  134. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_profile_api.md +4 -1474
  135. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_api.md +4 -1175
  136. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_management_api.md +4 -1311
  137. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/request_verification_code_api.md +4 -774
  138. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/verify_code_api.md +4 -764
  139. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_api.md +4 -1378
  140. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_partners_api.md +4 -816
  141. package/docs/referencia/usuario/assigned_whatsapp_business_accounts_api.md +4 -860
  142. package/docs/referencia/webhooks/whatsapp_incoming_webhook_payload.md +4 -1651
  143. package/docs/referencia/whatsapp_business_account/extended_credits_api.md +8 -0
  144. package/docs/referencia/whatsapp_business_phone_number/commerce_settings_api.md +8 -0
  145. package/docs/suporte/error_codes.md +88 -89
  146. package/docs/suporte/migrating_from_onprem_to_cloud.md +222 -0
  147. package/docs/suporte/support.md +77 -186
  148. package/docs/suporte.md +77 -186
  149. package/docs/throughput.md +60 -0
  150. package/docs/upcoming_messaging_limits_changes.md +132 -0
  151. package/docs/visao_geral/overview.md +354 -306
  152. package/docs/webhooks/create_webhook_endpoint.md +158 -0
  153. package/docs/webhooks/reference/messages/group.md +182 -0
  154. package/docs/webhooks/referencia/account_update.md +27 -27
  155. package/docs/webhooks/referencia/messages/status.md +35 -35
  156. package/docs/webhooks/visao_geral/message_echoes.md +1 -1
  157. package/docs/webhooks/visao_geral/overview.md +23 -15
  158. package/package.json +1 -1
package/docs/business_scoped_user_ids.md ADDED
@@ -0,0 +1,1533 @@
1
+ <!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/business-scoped-user-ids -->
2
+ <!-- Scraped: 2026-01-24T00:27:18.901Z -->
3
+
4
+ # IDs de usuário no escopo da empresa
5
+
6
+ Updated: 21 de nov de 2025
7
+
8
+ O WhatsApp vai lançar os nomes de usuário em 2026.
9
+
10
+ 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
+
12
+ Para possibilitar os nomes de usuário, compartilharemos 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
+
14
+ 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
+
16
+ **As alterações descritas neste documento estão sujeitas a mudanças.**
17
+
18
+ ## Nomes de usuário
19
+
20
+ O nome de usuário é um nome único e opcional que os usuários do WhatsApp podem definir para exibir no app em vez do número de telefone. Em vez dos nomes de perfil, é possível usar os nomes de usuário para personalizar o conteúdo de mensagens para usuários individuais.
21
+
22
+ Os usuários do WhatsApp podem ter apenas um nome de usuário, mas é possível alterá-lo periodicamente. A alteração do nome de usuário não afeta o número de telefone nem o ID do usuário no escopo da empresa. Além disso, o usuário pode continuar se comunicando com outros usuários do WhatsApp ou empresas na Plataforma do WhatsApp Business.
23
+
24
+ Os nomes de usuário são atribuídos à propriedade `username` em respostas de API e cargas de webhooks. Depois da habilitação, o nome de usuário do WhatsApp aparecerá em todos os webhooks de [mensagem](/documentation/business-messaging/whatsapp/webhooks/reference/messages#incoming-messages) recebida, além de webhooks de mensagens com status **entregue** e **lida**[](/documentation/business-messaging/whatsapp/webhooks/reference/messages/status).
25
+
26
+ ## ID de usuário no escopo da empresa
27
+
28
+ O ID do usuário no escopo da empresa ("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.
29
+
30
+ Os BSUIDs serão:
31
+
32
+ - gerados automaticamente- compostos por até 256 caracteres alfanuméricos- ú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
+
34
+ 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
+
36
+ Como os BSUIDs são exclusivos para cada par de portfólio empresarial e usuário, caso você tenha vários portfólios, as solicitações de API falharão se tentarem enviar mensagem para um BSUID que esteja no escopo de um portfólio diferente. No entanto, pode haver casos legítimos de uso para algumas empresas compartilharem o BSUID entre portfólios empresariais. Estamos estudando uma solução para simplificar esse processo. Você pode falar com seu ponto de contato da Meta sobre o assunto.
37
+
38
+ ## Números de telefone
39
+
40
+ Quando um usuário adotar um nome de usuário, o número de telefone não será incluído nos webhooks de [mensagens](/documentation/business-messaging/whatsapp/webhooks/reference/messages) em alguns casos. Em vez disso, o BSUID será enviado em um novo campo `user_id`. O número de telefone será enviado como uma string vazia no campo `wa_id` nas versões antigas e novas da API. Embora os números de telefone ainda sejam compartilhados em alguns casos, principalmente para interações com clientes existentes, é essencial que você comece a ingerir BSUIDs assim que possível para minimizar a perda de contexto da conversa.
41
+
42
+ - Se você enviar uma mensagem/ligar para o número de telefone de um usuário do WhatsApp ou receber uma mensagem/ligação do número de telefone dele, incluiremos o número de telefone em respostas da API e webhooks de mensagem por 30 dias a partir do momento do envio ou recebimento, independentemente de o usuário ter adotado um nome de usuário ou não. **Se o usuário receber uma mensagem ou ligação, ou enviar uma mensagem ou fazer uma ligação dentro desse período, a janela de 30 dias será reiniciada.**- Em algumas situações, você pode receber mensagens de clientes existentes fora da janela de 30 dias que parecem ser de novos usuários, já que o número de telefone não está no webhook de mensagens (wa\_id é uma string vazia). Para garantir que você possa identificar usuários que adotaram nomes e manter o contexto da conversa após 30 dias, estamos criando um recurso que permitirá continuar recebendo o número de telefone do usuário, mesmo depois da adoção do nome, desde que você tenha enviado mensagem para o número de telefone dele no passado. O histórico de comunicação será registrado a partir do momento em que o cliente aceitar receber mensagens. Forneceremos detalhes sobre o processo e o prazo de aceitação assim que estiverem disponíveis.- Se um usuário não tiver adotado um nome de usuário, os webhooks de mensagens incluirão o número de telefone e o BSUID.
43
+
44
+ Será possível enviar mensagens aos usuários usando o número de telefone ou o BSUID assim que os BSUIDs começarem a aparecer nas respostas da API e nas cargas do webhook.
45
+
46
+ ## Códigos de país
47
+
48
+ Quando um usuário do WhatsApp tiver habilitado o recurso de nome de usuário, o número de telefone dele poderá não aparecer nos webhooks. Se não souber o número de telefone, mas precisar se comunicar com ele, envie uma mensagem para o BSUID.
49
+
50
+ O código do país será incluído em todos os webhooks de [mensagem](/documentation/business-messaging/whatsapp/webhooks/reference/messages) (sujeito a alteração).
51
+
52
+ ## Nomes de usuário comerciais
53
+
54
+ As empresas também poderão adotar um nome de usuário comercial. No entanto, se você adotar um nome de usuário comercial, o número de telefone da empresa não ficará oculto no cliente do WhatsApp ou do WhatsApp Business.
55
+
56
+ Cada nome de usuário comercial é mapeado para um único número de telefone comercial em todo o WhatsApp. Ou seja, um número de telefone pode ter apenas um nome de usuário por vez. Não é possível que dois números de telefone do WhatsApp (consumidor ou empresa) tenham o mesmo nome de usuário.
57
+
58
+ Os nomes de usuário comerciais devem ter o seguinte formato:
59
+
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 etc.)- 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
+
62
+ ### Nomes de usuário reservados
63
+
64
+ 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
+
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 [vincular](https://www.facebook.com/business/help/4631406400243963) o número de telefone comercial à Página do Facebook ou conta do Instagram para reivindicar o nome de usuário. Para vincular uma Página ou conta, você deve ter controle total da Página ou conta, ou acesso parcial básico com a permissão manage\_phone.
67
+
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.
69
+
70
+ ### Prioridade de exibição da janela de conversa
71
+
72
+ 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
+
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- Telefone
75
+
76
+ ### Suporte
77
+
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=AT2W2v3PqI2_Bc0dANQdSP2z2SnDUl9obumW51rKWvhGXGm0r52Y_jBJJr8jbMAe1UlDQ0UFo-mySTVQytrrNb-MumGmFkRKJPeuIndbE27iJKG_JcyV5cVAS3TlF9ogv1ABw8Ds4hBb2eUJDvzpn8rgtD0) para denunciar violações.
79
+
80
+ ### Como adotar ou alterar um nome de usuário comercial
81
+
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.
83
+
84
+ Sintaxe da solicitação:
85
+
86
+ ```
87
+ curl -X POST 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/username' \
88
+ -H 'Content-Type: application/json' \
89
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
90
+ -d '
91
+ {
92
+ "username": "<DESIRED_USERNAME>"
93
+ }'
94
+ ```
95
+
96
+ Sintaxe da resposta, em caso de sucesso:
97
+
98
+ ```
99
+ {
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
+ ]
107
+ }
108
+ ```
109
+
110
+ - `status`: o status do nome de usuário mais recente solicitado. Os valores podem ser os seguintes:
111
+ - `APPROVED`: o nome de usuário solicitado foi aprovado e ficará ativo assim que o recurso de nomes de usuário for disponibilizado.- `REJECTED`: o nome de usuário solicitado foi rejeitado. Caso exista um nome de usuário aprovado para o número de telefone comercial, ele continuará sendo usado. Confira `rejection_reasons` para saber mais.- `PENDING`: o nome de usuário está em análise. Quando uma decisão for tomada, o webhook phone\_number\_username\_update será disparado, indicando o novo status.- `rejection_reasons`: uma matriz de strings indicando o motivo ou motivos da rejeição. Incluída apenas se o nome de usuário solicitado tiver sido rejeitado. Os valores podem ser os seguintes:
112
+ - `REQUIRE_FB_ACCOUNT_LINKING`: o nome de usuário solicitado poderá estar disponível se você [vincular](https://www.facebook.com/business/help/4631406400243963) o número de telefone comercial do WhatsApp à Página do Facebook.- `REQUIRE_IG_ACCOUNT_LINKING`: o nome de usuário solicitado poderá estar disponível se você vincular seu número de telefone comercial do WhatsApp à conta do Instagram.- `EXISTING_PENDING_REQUEST`: um nome de usuário solicitado anteriormente ainda está em análise.- `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.
113
+
114
+ ### Como obter o nome de usuário atual
115
+
116
+ Use o ponto de extremidade **GET /<BUSINESS\_PHONE\_NUMBER\_ID>/username** para conferir o status do nome de usuário comercial associado ao número de telefone comercial ou informações sobre o nome de usuário.
117
+
118
+ Sintaxe da solicitação:
119
+
120
+ ```
121
+ curl 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/username' \
122
+ -H 'Authorization: Bearer <ACCESS_TOKEN>'
123
+ ```
124
+
125
+ Sintaxe da resposta:
126
+
127
+ ```
128
+ {
129
+ "username": "<USERNAME>",
130
+ "status": "<STATUS>",
131
+
132
+ <!-- Only included for phone number's with a pending username request -->
133
+ "requested_username": "<REQUESTED_USERNAME>"
134
+ }
135
+ ```
136
+
137
+ - `username`: nome de usuário atual. Será uma string vazia 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:
138
+ - `ACTIVE`: o nome de usuário foi aprovado e ficará ativo assim que o recurso de nomes de usuário for disponibilizado.- `RESERVED`: o nome de usuário está reservado para o número de telefone comercial, mas não está ativo.- `requested_username`: nome de usuário solicitado. Essa propriedade só será incluída se um novo nome de usuário tiver sido solicitado para o número de telefone comercial, mas o nome de usuário em questão ainda estiver em análise.
139
+
140
+ ### Como obter nomes de usuário reservados
141
+
142
+ Inclusão de um novo ponto de extremidade **GET /<BUSINESS\_PHONE\_NUMBER\_ID>/username\_suggestions** que retorna uma lista de nomes de usuário reservados para seu portfólio empresarial.
143
+
144
+ Chame o ponto de extremidade [**POST /<BUSINESS\_PHONE\_NUMBER\_ID>/username**](#adopt-or-change-a-business-username) para reivindicar o nome de usuário desejado da lista, que depois precisará ser aprovado. Depois que o nome de usuário for aprovado e disponibilizado no seu país, o status será definido como "ativo", e o nome de usuário da empresa começará a aparecer no seu perfil comercial. Além disso, os usuários poderão encontrá-lo usando a pesquisa por correspondência exata.
145
+
146
+ Sintaxe da solicitação:
147
+
148
+ ```
149
+ curl 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/username_suggestions' \
150
+ -H 'Authorization: Bearer <ACCESS_TOKEN>'
151
+ ```
152
+
153
+ Sintaxe da resposta:
154
+
155
+ ```
156
+ {
157
+ "data": [
158
+ {
159
+ "username_suggestions": [
160
+ "<RESERVED_USERNAME>",
161
+ <!-- Additional usernames would follow, if any -->
162
+ ]
163
+ }
164
+ ],
165
+ }
166
+ ```
167
+
168
+ - `username_suggestions`: uma matriz de nomes de usuário reservados, se houver. Esses nomes de usuário têm maior probabilidade de aprovação.
169
+
170
+ ### Como excluir um nome de usuário
171
+
172
+ É possível usar o ponto de extremidade **DELETE /<BUSINESS\_PHONE\_NUMBER\_ID>/username** para excluir o nome de usuário comercial associado ao número de telefone.
173
+
174
+ Sintaxe da solicitação:
175
+
176
+ ```
177
+ curl -X DELETE 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/username' \
178
+ -H 'Authorization: Bearer <ACCESS_TOKEN>'
179
+ ```
180
+
181
+ ### Sintaxe da resposta:
182
+
183
+ ```
184
+ {  "success": <SUCCESS?>}
185
+ ```
186
+
187
+ - `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
+
189
+ ### Como cancelar solicitação de nome de usuário pendente
190
+
191
+ Você pode usar o ponto de extremidade **DELETE /<BUSINESS\_PHONE\_NUMBER\_ID>/requested\_username** para cancelar uma solicitação de nome de usuário comercial pendente.
192
+
193
+ Sintaxe da solicitação:
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.
211
+
212
+ ```
213
+ {
214
+ "object": "whatsapp_business_account",
215
+ "entry": [
216
+ {
217
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
218
+ "time": <WEBHOOK_TRIGGER_TIMESTAMP>,
219
+ "changes": [
220
+ {
221
+ "field": "phone_number_username_update",
222
+ "value": {
223
+ "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
224
+ "decision": "<DECISION>",
225
+ "requested_username": "<REQUESTED_USERNAME>",
226
+ "rejection_reasons": [
227
+ "<REJECTION_REASON>",
228
+ <!-- Additional rejection reasons would follow, if any -->
229
+ ]
230
+ }
231
+ }
232
+ ]
233
+ }
234
+ ]
235
+ }
236
+ ```
237
+
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).- `decision`: indica o resultado do processo de análise do nome de usuário comercial. Os valores podem ser os seguintes:
239
+ - `APPROVED`: indica que o nome de usuário foi aprovado e ficará ativo assim que o recurso de nomes de usuário estiver disponível.- `REJECTED`: indica que o nome de usuário foi rejeitado. É possível editar o nome no Gerenciador do WhatsApp. Analise o motivo da rejeição antes de editar.- `requested_username`: o nome de usuário solicitado.- `rejection_reasons`: indica o motivo pelo qual o nome de usuário comercial foi rejeitado, se isso tiver acontecido. Os valores podem ser os seguintes:
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.
241
+
242
+ ## Mensagens
243
+
244
+ ### Como enviar pedidos de contato
245
+
246
+ 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
+
248
+ Esta sintaxe de exemplo envia uma mensagem de texto, mas as alterações se aplicam a todos os tipos de mensagens.
249
+
250
+ ```
251
+ 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/messages' \
252
+ -H 'Content-Type: application/json' \
253
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
254
+ -d '
255
+ {
256
+ "messaging_product": "whatsapp",
257
+ "recipient_type": "individual",
258
+ "to": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
259
+ "type": "text",
260
+ "text": {
261
+ "body": "<BODY_TEXT>"
262
+ }
263
+ }'
264
+ ```
265
+
266
+ - `to`: aceita números de telefone de usuário do WhatsApp e BSUIDs de usuário.
267
+
268
+ ### Como enviar resposta às mensagens
269
+
270
+ As alterações se aplicam às respostas do ponto de extremidade [POST /<BUSINESS\_PHONE\_NUMBER\_ID>/messages](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/message-api#Creating).
271
+
272
+ ```
273
+ {
274
+ "messaging_product": "whatsapp",
275
+ "contacts": [
276
+ {
277
+ "input": "<USER_PHONE_NUMBER_OR_ID>", <!-- CHANGED -->
278
+ "wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
279
+ "user_id": "<BSUID>" <!-- ADDED -->
280
+ }
281
+ ],
282
+ "messages": [
283
+ {
284
+ "id": "<WHATSAPP_MESSAGE_ID>"
285
+ }
286
+ ]
287
+ }
288
+ ```
289
+
290
+ - `input`: retorna o BSUID do usuário se a mensagem for enviada para o respectivo BSUID. Caso contrário, o número de telefone do usuário ou a identificação do grupo (se a mensagem for enviada a um grupo) será retornado.- `wa_id`: se você tiver enviado a mensagem para o BSUID do usuário, esse campo ficará vazio.- `user_id`: nova propriedade. Será definida como o BSUID do usuário se a mensagem for enviada para o BSUID dele. Caso contrário, a propriedade será omitida.
291
+
292
+ Exemplo de resposta a uma solicitação de envio de mensagem para o número de telefone de um usuário:
293
+
294
+ ```
295
+ {  "messaging_product": "whatsapp",  "contacts": [    {      "input": "+16505551234"      "wa_id": "16505551234"    }  ],  "messages": [    {      "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA"    }  ]}
296
+ ```
297
+
298
+ Exemplo de resposta a uma solicitação de envio de mensagem enviada ao BSUID de um usuário:
299
+
300
+ ```
301
+ {  "messaging_product": "whatsapp",  "contacts": [    {      "input": "user.9373795779eb6441c8adb2eaee5b848e7dd174ddd302d7db62142f4722d574b6"      "wa_id": "",      "user_id": "user.9373795779eb6441c8adb2eaee5b848e7dd174ddd302d7db62142f4722d574b6"    }  ],  "messages": [    {      "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA"    }  ]}
302
+ ```
303
+
304
+ ### Códigos de erro
305
+
306
+ 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
+
308
+ - Código de erro: `131062`- Detalhes: `You can only send authentication messages to recipients' phone numbers, not their business-scoped user IDs.`
309
+
310
+ ## API de Mensagens de Marketing para o WhatsApp
311
+
312
+ ### Como enviar solicitações de mensagem de marketing
313
+
314
+ A API de Mensagens de Marketing para o WhatsApp aceitará números de telefone e BSUIDs. Se você tiver os dois, recomendamos enviar mensagens para números de telefone, principalmente para continuar recebendo números de telefone em webhooks. Caso você tenha apenas o BSUID de um usuário, use-o.
315
+
316
+ 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
+
318
+ ```
319
+ 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/marketing_messages' \
320
+ -H 'Content-Type: application/json' \
321
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
322
+ -d '
323
+ {
324
+ "messaging_product": "whatsapp",
325
+ "recipient_type": "individual",
326
+ "to": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
327
+ "type": "template",
328
+ "template": {
329
+ <EXPECTED_TEMPLATE_PARAMETERS>
330
+ }
331
+ }'
332
+ ```
333
+
334
+ - `to`: aceita números de telefone de usuário do WhatsApp e BSUIDs de usuário.
335
+
336
+ ### Como enviar resposta a uma mensagem de marketing
337
+
338
+ Essas alterações se aplicam às respostas do ponto de extremidade [POST /<BUSINESS\_PHONE\_NUMBER\_ID>/marketing\_messages](/documentation/business-messaging/whatsapp/marketing-messages/send-marketing-messages#send-marketing-template-messages).
339
+
340
+ ```
341
+ {
342
+ "messaging_product": "whatsapp",
343
+ "contacts": [
344
+ {
345
+ "input": "<USER_PHONE_NUMBER_OR_ID>", <!-- CHANGED -->
346
+ "wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
347
+ "user_id": "<BSUID>" <!-- ADDED -->
348
+ }
349
+ ],
350
+ "messages": [
351
+ {
352
+ "id": "<WHATSAPP_MESSAGE_ID>",
353
+ "message_status": "<PACING_STATUS>"
354
+ }
355
+ ]
356
+ }
357
+ ```
358
+
359
+ - `input`: retorna o BSUID do usuário se a mensagem for enviada para o respectivo BSUID. Caso contrário, o número de telefone do usuário ou a identificação do grupo (se a mensagem for enviada a um grupo) será retornado.- `wa_id`: se você tiver enviado a mensagem para o BSUID do usuário, esse campo ficará vazio.- `user_id`: nova propriedade. Será definida como o BSUID do usuário se a mensagem for enviada para o BSUID dele. Caso contrário, a propriedade será omitida.
360
+
361
+ Exemplo de resposta ao envio de uma mensagem de modelo para o número de telefone de um usuário:
362
+
363
+ ```
364
+ {  "messaging_product": "whatsapp",  "contacts": [    {      "input": "+16505551234"      "wa_id": "16505551234"    }  ],  "messages": [    {      "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA",      "message_status": "accepted"    }  ]}
365
+ ```
366
+
367
+ Exemplo de resposta ao envio de uma mensagem de modelo para o BSUID de um usuário:
368
+
369
+ ```
370
+ {  "messaging_product": "whatsapp",  "contacts": [    {      "input": "user.9373795779eb6441c8adb2eaee5b848e7dd174ddd302d7db62142f4722d574b6"      "wa_id": "",      "user_id": "user.9373795779eb6441c8adb2eaee5b848e7dd174ddd302d7db62142f4722d574b6"    }  ],  "messages": [    {      "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1RjQyNUE3NEYxMzAzMzQ5MkEA",      "message_status": "accepted"    }  ]}
371
+ ```
372
+
373
+ ## Webhooks de mensagens
374
+
375
+ ### Webhooks de mensagens de status
376
+
377
+ 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
+
379
+ Exceção: os webhooks de mensagens de status enviada ou com falha da API de Grupos não serão afetados.
380
+
381
+ ```
382
+ {
383
+ "object": "whatsapp_business_account",
384
+ "entry": [
385
+ {
386
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
387
+ "changes": [
388
+ {
389
+ "value": {
390
+ "messaging_product": "whatsapp",
391
+ "metadata": {
392
+ "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
393
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
394
+ },
395
+
396
+ <!-- Contacts will be included for sent, delivered, and read status -->
397
+ "contacts": [
398
+ {
399
+ "profile": {
400
+ "name": "<USER_DISPLAY_NAME>", <!-- ADDED -->
401
+ "username": "<USERNAME>", <!-- ADDED -->
402
+ "country_code": "<USER_COUNTRY_CODE>" <!-- ADDED -->
403
+ },
404
+ "wa_id": "<USER_PHONE_NUMBER>", <!-- ADDED -->
405
+ "user_id": "<BSUID>" <!-- ADDED -->
406
+ }
407
+ ],
408
+
409
+ "statuses": [
410
+ {
411
+ "id": "<WHATSAPP_MESSAGE_ID>",
412
+ "status": "<STATUS>",
413
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
414
+ "recipient_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
415
+ "recipient_user_id": "<BSUID>", <!-- ADDED --><!-- Only for status failed messages -->
416
+ "errors": [
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
+ ]
427
+ }
428
+ ]
429
+ },
430
+ "field": "messages"
431
+ }
432
+ ]
433
+ }
434
+ ]
435
+ }
436
+ ```
437
+
438
+ - `contacts`: nova matriz. Incluído apenas em mensagens com status enviada, entregue ou lida. Será omitido por completo para webhooks de mensagens de status com falha.
439
+ - `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. Essa informação será omitida para webhooks de mensagens com status "enviada".- `country_code`: nova propriedade. Será definida como o código do país do usuário (_sujeito a alteração_).- `wa_id`: nova propriedade. Será definida como vazia se o usuário tiver adotado um nome de usuário e (1) você tiver enviado a mensagem para o BSUID do usuário, (2) não tiver enviado mensagem para o número de telefone do usuário nos últimos 30 dias ou (3) o usuário não tiver adicionado seu número à lista de contatos do WhatsApp. Se a mensagem tiver sido enviada para o número de telefone do usuário, o valor será definido como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário do WhatsApp.- `recipient_id`: novo valor vazio. Será definido como:
440
+ - o número de telefone do usuário do WhatsApp, se a mensagem foi enviada para o número de telefone do usuário.- a identificação do grupo, se a mensagem foi enviada a um grupo.- vazio, se você tiver enviado a mensagem para o BSUID do usuário e (1) não tiver enviado mensagens para o número de telefone do usuário nos últimos 30 dias e (2) o usuário não tiver adicionado seu número à lista de contatos do WhatsApp.- `recipient_user_id`: nova propriedade. Será definida como o BSUID do usuário se a mensagem for enviada para o BSUID dele. Caso contrário, a propriedade será totalmente omitida.
441
+
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:
443
+
444
+ ```
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",                  "country_code": "US"                },                "wa_id": "16505551234",                "user_id": "user.9373795779eb6441c8adb2eaee5b848e7dd174ddd302d7db62142f4722d574b6"              }            ],            "statuses": [              {                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=",                "status": "delivered",                "timestamp": "1750030073",                "recipient_id": "16505551234",                "pricing": {                  "billable": true,                  "pricing_model": "PMP",                  "type": "regular",                  "category": "marketing"                }              }            ]          },          "field": "messages"        }      ]    }  ]}
446
+ ```
447
+
448
+ Exemplo de webhook de mensagens com status "entregue" descrevendo uma mensagem enviada para o ID da empresa de um usuário do WhatsApp que habilitou o recurso de nome de usuário. Observe que `wa_id`, que normalmente seria definido como o número de telefone do usuário, está vazio:
449
+
450
+ ```
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",                  "country_code": "US"                },                "wa_id": "",                "user_id": "user.9373795779eb6441c8adb2eaee5b848e7dd174ddd302d7db62142f4722d574b6"              }            ],            "statuses": [              {                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=",                "status": "delivered",                "timestamp": "1750030073",                "recipient_id": "",                "recipient_user_id": "user.9373795779eb6441c8adb2eaee5b848e7dd174ddd302d7db62142f4722d574b6",                "pricing": {                  "billable": true,                  "pricing_model": "PMP",                  "type": "regular",                  "category": "marketing"                }              }            ]          },          "field": "messages"        }      ]    }  ]}
452
+ ```
453
+
454
+ ### Webhooks de mensagens recebidas
455
+
456
+ As alterações se aplicam a webhooks de mensagens recebidas ([texto](/documentation/business-messaging/whatsapp/webhooks/reference/messages/text), [imagem](/documentation/business-messaging/whatsapp/webhooks/reference/messages/image), [interativa](/documentation/business-messaging/whatsapp/webhooks/reference/messages/interactive), entre outros), incluindo mensagens recebidas enviadas por usuários em uma conversa em grupo.
457
+
458
+ O exemplo de sintaxe abaixo é para uma mensagem de **texto** recebida, mas as alterações são as mesmas para todos os tipos de mensagem recebida.
459
+
460
+ ```
461
+ {
462
+ "object": "whatsapp_business_account",
463
+ "entry": [
464
+ {
465
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
466
+ "changes": [
467
+ {
468
+ "value": {
469
+ "messaging_product": "whatsapp",
470
+ "metadata": {
471
+ "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
472
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
473
+ },
474
+ "contacts": [
475
+ {
476
+ "profile": {
477
+ "name": "<WHATSAPP_USER_PROFILE_NAME>",
478
+ "username": "<USERNAME>", <!-- ADDED -->
479
+ "country_code": "<COUNTRY_CODE>" <!-- ADDED -->
480
+ },
481
+ "wa_id": "<WHATSAPP_USER_ID>", <!-- CHANGED -->
482
+ "user_id": "<BSUID>" <!-- ADDED -->
483
+ }
484
+ ],
485
+ "messages": [
486
+ {
487
+ "from": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
488
+ "from_user_id": "<BSUID>", <!-- ADDED -->
489
+ "id": "<WHATSAPP_MESSAGE_ID>",
490
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
491
+ "type": "text",
492
+ "text": {
493
+ "body": "<MESSAGE_TEXT_BODY>"
494
+ }
495
+ }
496
+ ]
497
+ },
498
+ "field": "messages"
499
+ }
500
+ ]
501
+ }
502
+ ]
503
+ }
504
+ ```
505
+
506
+ - `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.- `country_code`: nova propriedade. É definida como o código do país do usuário (_sujeito a alteração_).- `wa_id`: novo valor (vazio). Se o usuário tiver habilitado o recurso de nome de usuário e você não tiver enviado mensagem para o número de telefone dele nos últimos 30 dias, ou se o seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário, o campo ficará vazio. Caso contrário, o número de telefone do usuário será definido.- `user_id`: nova propriedade, definida como o BSUID do usuário.- `from`: novo valor (vazio). Estará vazio se o usuário tiver habilitado o recurso de nome de usuário e você não tiver enviado mensagem para o número de telefone do usuário nos últimos 30 dias ou se o seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `from_user_id`: nova propriedade, definida como o BSUID do usuário.
507
+
508
+ Exemplo de mensagem de texto recebida de um usuário que habilitou o recurso de nome de usuário. Nesse cenário, a empresa não envia mensagens para o número de telefone do usuário nos últimos 30 dias e o usuário não adiciona o número de telefone da empresa à lista de contatos do WhatsApp. Observe que `wa_id`, que normalmente seria definido como o número de telefone do usuário, está vazio:
509
+
510
+ ```
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",                  "country_code": "US"                },                "wa_id": "",                "user_id": "user.93737..."              }            ],            "messages": [              {                "from": "",                "from_user_id": "user.93737...",                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQTRBNjU5OUFFRTAzODEwMTQ0RgA=",                "timestamp": "1749416383",                "type": "text",                "text": {                  "body": "Does it come in another color?"                }              }            ]          },          "field": "messages"        }      ]    }  ]}
512
+ ```
513
+
514
+ ### Webhooks de mensagens de status do sistema
515
+
516
+ As alterações se aplicam a webhooks de mensagens com [status do sistema](/documentation/business-messaging/whatsapp/webhooks/reference/messages/system).
517
+
518
+ ```
519
+ {
520
+ "object": "whatsapp_business_account",
521
+ "entry": [
522
+ {
523
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
524
+ "changes": [
525
+ {
526
+ "value": {
527
+ "messaging_product": "whatsapp",
528
+ "metadata": {
529
+ "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
530
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
531
+ },
532
+ "messages": [
533
+ {
534
+ "from": "<WHATSAPP_USER_PHONE_NUMBER>",
535
+ "id": "<WHATSAPP_MESSAGE_ID>",
536
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
537
+ "type": "system",
538
+ "system": {
539
+ "body": "User...", <!-- CHANGED -->
540
+ "wa_id": "<NEW_WHATSAPP_USER_ID>", <!-- CHANGED -->
541
+ "user_id": "<NEW_BSUID>", <!-- ADDED -->
542
+ "type": "<SYSTEM_CHANGE_TYPE>" <!-- CHANGED -->
543
+ }
544
+ }
545
+ ]
546
+ },
547
+ "field": "messages"
548
+ }
549
+ ]
550
+ }
551
+ ]
552
+ }
553
+ ```
554
+
555
+ - `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 valor (vazio). Ficará vazio se o usuário tiver habilitado o recurso de nome de usuário e você não tiver enviado mensagens para o número de telefone do usuário nos últimos 30 dias ou se o seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o novo BSUID do usuário.- `type`: novo valor (`user_changed_user_id`). Será definido como `user_changed_user_id` se o usuário tiver alterado o número de telefone comercial.
556
+
557
+ ### Webhooks user\_preferences
558
+
559
+ As alterações serão aplicadas aos webhooks [user\_preferences](/documentation/business-messaging/whatsapp/webhooks/reference/user_preferences).
560
+
561
+ ```
562
+ {
563
+ "object": "whatsapp_business_account",
564
+ "entry": [
565
+ {
566
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
567
+ "changes": [
568
+ {
569
+ "value": {
570
+ "messaging_product": "whatsapp",
571
+ "metadata": {
572
+ "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
573
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
574
+ },
575
+ "contacts": [
576
+ {
577
+ "profile": {
578
+ "name": "<WHATSAPP_USER_NAME>",
579
+ "username": "<USERNAME>", <!-- ADDED -->
580
+ "country_code": "<COUNTRY_CODE>" <!-- ADDED -->
581
+ },
582
+ "wa_id": "<WHATSAPP_USER_ID>", <!-- CHANGED -->
583
+ "user_id": "<BSUID>" <!-- ADDED -->
584
+ }
585
+ ],
586
+ "user_preferences": [
587
+ {
588
+ "wa_id": "<WHATSAPP_USER_ID>", <!-- CHANGED -->
589
+ "user_id": "<BSUID>", <!-- ADDED -->
590
+ "detail": "<PREFERENCE_DESCRIPTION>",
591
+ "category": "marketing_messages",
592
+ "value": "<PREFERENCE>",
593
+ "timestamp": <WEBHOOK_SENT_TIMESTAMP>
594
+ }
595
+ ]
596
+ },
597
+ "field": "user_preferences"
598
+ }
599
+ ]
600
+ }
601
+ ]
602
+ }
603
+ ```
604
+
605
+ - `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.- `country_code`: nova propriedade. É definida como o código do país do usuário (_sujeito a alteração_).- `wa_id`: novo valor (vazio). Se o usuário tiver habilitado o recurso de nome de usuário e você não tiver enviado mensagem para o número de telefone dele nos últimos 30 dias, ou se o seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário, o campo ficará vazio. Caso contrário, o número de telefone do usuário será definido.- `user_id`: nova propriedade, definida como o BSUID do usuário.
606
+
607
+ ## API de Grupos
608
+
609
+ ### Como obter informações do grupo
610
+
611
+ As alterações se aplicam a respostas do ponto de extremidade [GET /<GROUP\_ID>](/documentation/business-messaging/whatsapp/groups/reference#get-group-info).
612
+
613
+ ```
614
+ {
615
+ "participants": [
616
+ {
617
+ "wa_id": "<USER_PHONE_NUMBER>" <!-- CHANGED -->
618
+ "user_id": "<BSUID>", <!-- ADDED -->
619
+ "username": "<USERNAME>", <!-- ADDED -->
620
+ "country_code": "COUNTRY_CODE" <!-- ADDED -->
621
+ }
622
+ ],
623
+ "subject": "<GROUP_SUBJECT>",
624
+ "id": "<GROUP_ID>",
625
+ "messaging_product": "whatsapp"
626
+ }
627
+ ```
628
+
629
+ - `wa_id`: novo valor (vazio). Estará vazio se o usuário tiver habilitado o recurso de nome de usuário e você não tiver enviado mensagem para o número de telefone do usuário nos últimos 30 dias ou se o seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definido como o número de telefone do usuário. `user_id`: nova propriedade, definida como o BSUID do usuário.- `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.- `country_code`: nova propriedade. É definida como o código do país do usuário (_sujeito a alteração_).
630
+
631
+ ### Como obter as solicitações para participar de grupos
632
+
633
+ As alterações se aplicam a respostas do ponto de extremidade [GET /<GROUP\_ID>/join\_requests](/documentation/business-messaging/whatsapp/groups/reference#groups-with-join-requests).
634
+
635
+ ```
636
+ {
637
+ "data": [
638
+ {
639
+ "join_request_id": "<JOIN_REQUEST_ID>",
640
+ "creation_timestamp": "<JOIN_REQUEST_TIMESTAMP>",
641
+ "wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
642
+ "user_id": "<BSUID>", <!-- ADDED -->
643
+ "username": "<USERNAME>", <!-- ADDED -->
644
+ "country_code": "<COUNTRY_CODE>" <!-- ADDED -->
645
+ }
646
+ ],
647
+ "paging": {
648
+ "cursors": {
649
+ "before": "<BEFORE_CURSOR>",
650
+ "after": "<AFTER_CURSOR>"
651
+ }
652
+ }
653
+ }
654
+ ```
655
+
656
+ - `wa_id`: novo valor (vazio). Estará vazio se o usuário tiver habilitado o recurso de nome de usuário e você não tiver enviado mensagem para o número de telefone do usuário nos últimos 30 dias ou se o seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, ele será definido como o número de telefone do usuário.- `user_id`: nova propriedade, definida como o BSUID do usuário.- `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.- `country_code`: nova propriedade. É definida como o código do país do usuário (_sujeito a alteração_).
657
+
658
+ ### Como remover participantes do grupo
659
+
660
+ As alterações se aplicam a solicitações do ponto de extremidade [DELETE /<GROUP\_ID>/participants](/documentation/business-messaging/whatsapp/groups/reference#remove-group-participants).
661
+
662
+ ```
663
+ curl -g -X DELETE 'https://graph.facebook.com/<API_VERSION>/<GROUP_ID>/participants' \
664
+ -H 'Content-Type: application/json' \
665
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
666
+ -d '
667
+ {
668
+ "messaging_product": "whatsapp",
669
+ "participants": [
670
+ {
671
+ "user": "<USER_PHONE_NUMBER>" <!-- CHANGED -->
672
+ }
673
+ ]
674
+ }'
675
+ ```
676
+
677
+ - `user`: aceitará o número de telefone ou o BSUID do usuário.
678
+
679
+ ## Webhooks da API de Grupos
680
+
681
+ ### Webhooks group\_participants\_update
682
+
683
+ Essas alterações se aplicam ao webhook [group\_participants\_update](/documentation/business-messaging/whatsapp/groups/webhooks#group-participants-update-webhooks).
684
+
685
+ ```
686
+ {
687
+ "object": "whatsapp_business_account",
688
+ "entry": [
689
+ {
690
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
691
+ "changes": [
692
+ {
693
+ "value": {
694
+ "messaging_product": "whatsapp",
695
+ "metadata": {
696
+ "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
697
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
698
+ },
699
+ "groups": [
700
+ {
701
+ "timestamp": <WEBHOOK_TRIGGER_TIMESTAMP>,
702
+ "group_id": "<GROUP_ID>",
703
+
704
+ <!-- Only if business removes participant from group -->
705
+ "type": "group_participants_remove",
706
+ "request_id": "REQUEST_ID",
707
+ "removed_participants": [
708
+ {
709
+ "input": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
710
+ }
711
+ ],
712
+ "initiated_by": "business"
713
+
714
+ <!-- Only if user removes themself from group -->
715
+ "type": "group_participants_remove",
716
+ "request_id": "REQUEST_ID",
717
+ "removed_participants": [
718
+ {
719
+ "wa_id": "<USER_PHONE_NUMBER>" <!-- CHANGED -->
720
+ "user_id": "<BSUID>",
721
+ "username": "<USERNAME>",
722
+ "country_code": "<COUNTRY_CODE>"
723
+ }
724
+ ],
725
+ "initiated_by": "participant"
726
+
727
+ <!-- Only if user joins group via invite link -->
728
+ "type": "group_participants_add",
729
+ "reason": "invite_link",
730
+ "added_participants": [
731
+ {
732
+ "wa_id": "<USER_PHONE_NUMBER>" <!-- CHANGED -->
733
+ "user_id": "<BSUID>", <!-- ADDED -->
734
+ "username": "<USERNAME>", <!-- ADDED -->
735
+ "country_code": "<COUNTRY_CODE>" <!-- ADDED -->
736
+ }
737
+ ]
738
+
739
+ <!-- Only if join request created -->
740
+ "type": "group_join_request_created",
741
+ "join_request_id": "<JOIN_REQUEST_ID>",
742
+ "wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
743
+ "user_id": "<BSUID>", <!-- ADDED -->
744
+ "username": "<USERNAME>", <!-- ADDED -->
745
+ "country_code": "<COUNTRY_CODE>" <!-- ADDED --><!-- Only if join request revoked -->
746
+ "type": "group_join_request_revoked",
747
+ "join_request_id": "<JOIN_REQUEST_ID>",
748
+ "wa_id": "<USER_PHONE_NUMBER>" <!-- CHANGED -->
749
+ "user_id": "<BSUID>", <!-- ADDED -->
750
+ "username": "<USERNAME>", <!-- ADDED -->
751
+ "country_code": "<COUNTRY_CODE>" <!-- ADDED -->
752
+
753
+ }
754
+ ]
755
+ },
756
+ "field": "group_participants_update"
757
+ }
758
+ ]
759
+ }
760
+ ]
761
+ }
762
+ ```
763
+
764
+ - `wa_id`: novo valor (vazio). Estará vazio se o usuário tiver habilitado o recurso de nome de usuário e você não tiver enviado mensagem para o número de telefone do usuário nos últimos 30 dias ou se o seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `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.- `country_code`: nova propriedade. Será definida como o código do país do usuário (_sujeito a alteração_).
765
+
766
+ ## API de Bloqueio de Usuários
767
+
768
+ ### Como bloquear ou desbloquear solicitações de usuários
769
+
770
+ 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
+
772
+ ```
773
+ {
774
+ "messaging_product": "whatsapp",
775
+ "block_users": {
776
+ "added_users": [
777
+ {
778
+ "input": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
779
+ "wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
780
+ "user_id": "<BSUID>" <!-- ADDED -->
781
+ }
782
+ ]
783
+ }
784
+ }
785
+ ```
786
+
787
+ - `input`: será definido como o BSUID do usuário se você tiver usado esse ID ao bloquear ou desbloquear a pessoa. 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 valor vazio. Ficará vazio se você tiver usado o BSUID do usuário ao bloqueá-lo ou desbloqueá-lo. 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.- `user_id`: nova propriedade. Será definida como o BSUID do usuário se você tiver usado o BSUID dele ao bloqueá-lo ou desbloqueá-lo. Se você tiver usado o número de telefone do contato, a propriedade será omitida.
788
+
789
+ ## API de Ligações
790
+
791
+ ### Solicitações de ligações iniciadas pela empresa
792
+
793
+ As alterações se aplicam a solicitações da API de Ligações iniciadas pela empresa.
794
+
795
+ ```
796
+ 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/calls' \
797
+ -H 'Content-Type: application/json' \
798
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
799
+ -d '
800
+ {
801
+ "messaging_product": "whatsapp",
802
+ "to": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
803
+ "action": "connect",
804
+ "session": {
805
+ "sdp_type": "offer",
806
+ "sdp": "<RFC_4566_SDP>"
807
+ }
808
+ }'
809
+ ```
810
+
811
+ - `to`: aceita números de telefone de usuário do WhatsApp e BSUIDs de usuário.
812
+
813
+ ### Como obter permissões de ligação
814
+
815
+ 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
+
817
+ ```
818
+ curl 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/call_permissions?user_wa_id=<BSUID>' \
819
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
820
+ ```
821
+
822
+ - `user_wa_id`: aceita números de telefone e BSUIDs de usuário do WhatsApp.
823
+
824
+ ### Como enviar uma solicitação de permissão para ligação
825
+
826
+ Confira como [enviar pedidos de contato](#send-message-requests).
827
+
828
+ ### Webhooks de solicitação de permissão para ligação
829
+
830
+ Confira os [webhooks de mensagens recebidas](#incoming-messages-webhooks).
831
+
832
+ ### Webhooks de ligações conectadas iniciadas pela empresa
833
+
834
+ As alterações se aplicam a webhooks de [ligações conectadas](/documentation/business-messaging/whatsapp/calling/reference#call-connect-webhook) iniciadas pela empresa.
835
+
836
+ ```
837
+ {
838
+ "entry": [
839
+ {
840
+ "changes": [
841
+ {
842
+ "field": "calls",
843
+ "value": {
844
+ "contacts": [ <!-- ADDED -->
845
+ {
846
+ "profile": {
847
+ "name": "<USER_DISPLAY_NAME>", <!-- ADDED -->
848
+ "country_code": "<USER_COUNTRY_CODE>" <!-- ADDED -->
849
+ },
850
+ "user_id": "<BSUID>" <!-- ADDED -->
851
+ }
852
+ ],
853
+ "calls": [
854
+ {
855
+ "biz_opaque_callback_data": "<data>",
856
+ "session": {
857
+ "sdp_type": "answer",
858
+ "sdp": "<SDP>"
859
+ },
860
+ "from": "<BUSINESS_PHONE_NUMBER>",
861
+ "id": "<WHATSAPP_CALL_ID>",
862
+ "to": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
863
+ "to_user_id": "<BSUID>", <!-- ADDED -->
864
+ "event": "connect",
865
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
866
+ "direction": "BUSINESS_INITIATED"
867
+ }
868
+ ],
869
+ "metadata": {
870
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>",
871
+ "display_phone_number": "<BUSINESS_PHONE_NUMBER>"
872
+ },
873
+ "messaging_product": "whatsapp"
874
+ }
875
+ }
876
+ ],
877
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>"
878
+ }
879
+ ],
880
+ "object": "whatsapp_business_account"
881
+ }
882
+ ```
883
+
884
+ - `contacts`: um novo objeto de contatos será incluído.- `name`: nova propriedade. Será definida como o nome do perfil do usuário.- `country_code`: nova propriedade. Será definida como o código do país do usuário (_sujeito a alteração_).- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `to`: novo valor vazio. Se o usuário tiver adotado um nome de usuário e (1) a mensagem tiver sido enviada para o número de telefone dele, (2) o seu número de telefone comercial já estiver na lista de contatos do WhatsApp do usuário ou (3) você tiver enviado mensagem ou ligado para o número de telefone dele nos últimos 30 dias, essa propriedade será definida como o número de telefone do usuário do WhatsApp. Caso contrário, será definida como uma string vazia.- `to_user_id`: nova propriedade. Será definida como o BSUID do usuário.
885
+
886
+ ### Webhooks de ligações conectadas iniciadas pelo usuário
887
+
888
+ As alterações serão aplicadas a webhooks de [ligações conectadas](/documentation/business-messaging/whatsapp/calling/reference#call-connect-webhook) iniciadas pelo usuário.
889
+
890
+ ```
891
+ {
892
+ "entry": [
893
+ {
894
+ "changes": [
895
+ {
896
+ "field": "calls",
897
+ "value": {
898
+ "metadata": {
899
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>",
900
+ "display_phone_number": "<BUSINESS_PHONE_NUMBER>"
901
+ },
902
+ "calls": [
903
+ {
904
+ "session": {
905
+ "sdp_type": "offer",
906
+ "sdp": "<SDP>"
907
+ },
908
+ "from": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
909
+ "from_user_id": "<BSUID>", <!-- ADDED -->
910
+ "id": "<WHATSAPP_CALL_ID>",
911
+ "to": "<BUSINESS_PHONE_NUMBER>",
912
+ "event": "connect",
913
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
914
+ "direction": "USER_INITIATED"
915
+ }
916
+ ],
917
+ "contacts": [
918
+ {
919
+ "wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
920
+ "profile": {
921
+ "name": "<USER_DISPLAY_NAME>", <!-- ADDED -->
922
+ "username": "<USERNAME>", <!-- ADDED -->
923
+ "country_code": "<COUNTRY_CODE>" <!-- ADDED -->
924
+ },
925
+ "user_id": "<BSUID>" <!-- ADDED -->
926
+ }
927
+ ],
928
+ "messaging_product": "whatsapp"
929
+ }
930
+ }
931
+ ],
932
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>"
933
+ }
934
+ ],
935
+ "object": "whatsapp_business_account"
936
+ }
937
+ ```
938
+
939
+ - `from`: novo valor vazio. Caso o usuário tenha definido um nome de usuário, ele será configurado como uma string vazia se (1) você não tiver enviado mensagem ou ligado para o número de telefone do usuário nos últimos 30 dias ou (2) seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `from_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `wa_id`: novo valor vazio. Caso o usuário tenha definido um nome de usuário, ele será configurado como uma string vazia se (1) você não tiver enviado mensagem ou ligado para o número de telefone do usuário nos últimos 30 dias ou (2) seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida 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, a propriedade será omitida.- `country_code`: nova propriedade. Será definida como o código do país do usuário (_sujeito a alteração_).- `user_id`: nova propriedade. Será definida como o BSUID do usuário.
940
+
941
+ ### Webhooks de ligações iniciadas pela empresa que foram encerradas
942
+
943
+ As alterações se aplicam a webhooks de ligações iniciadas pela empresa que foram [encerradas](/documentation/business-messaging/whatsapp/calling/reference#call-terminate-webhook).
944
+
945
+ ```
946
+ {
947
+ "entry": [
948
+ {
949
+ "changes": [
950
+ {
951
+ "field": "calls",
952
+ "value": {
953
+ "calls": [
954
+ {
955
+ "biz_opaque_callback_data": "<BUSINESS_OPAQUE_DATA>",
956
+ "from": "<BUSINESS_PHONE_NUMBER>",
957
+ "id": "<WHATSAPP_CALL_ID>",
958
+ "to": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
959
+ "to_user_id": "<BSUID>", <!-- ADDED -->
960
+ "event": "terminate",
961
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
962
+ "direction": "BUSINESS_INITIATED",
963
+ "status": "COMPLETED"
964
+ }
965
+ ],
966
+ "metadata": {
967
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>",
968
+ "display_phone_number": "<BUSINESS_PHONE_NUMBER>"
969
+ },
970
+ "contacts": [ <!-- ADDED -->
971
+ {
972
+ "profile": {
973
+ "name": "<USER_PROFILE_NAME>", <!-- ADDED -->
974
+ "country_code": "<USER_COUNTRY_CODE>" <!-- ADDED -->
975
+
976
+ },
977
+ "user_id": "<BSUID>" <!-- ADDED -->
978
+ }
979
+ ],
980
+ "messaging_product": "whatsapp"
981
+ }
982
+ }
983
+ ],
984
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>"
985
+ }
986
+ ],
987
+ "object": "whatsapp_business_account"
988
+ }
989
+ ```
990
+
991
+ - `to`: novo valor vazio. Se o usuário tiver adotado um nome de usuário e (1) a ligação tiver sido feita para o número de telefone dele, (2) seu número de telefone comercial já estiver na lista de contatos do WhatsApp do usuário ou (3) você tiver enviado mensagem ou ligado para o número de telefone dele nos últimos 30 dias, essa propriedade será definida como o número de telefone do usuário do WhatsApp. Caso contrário, será definida como uma string vazia.- `to_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `contacts`: um novo objeto de contatos será incluído.- `name`: nova propriedade. Será definida como o nome do perfil do usuário.- `country_code`: nova propriedade. Será definida como o código do país do usuário (_sujeito a alteração_).- `user_id`: nova propriedade. Será definida como o BSUID do usuário.
992
+
993
+ ### Webhooks de ligações encerradas iniciadas pelo usuário
994
+
995
+ As alterações serão aplicadas aos webhooks de ligações iniciadas pelo usuário que foram [encerradas](/documentation/business-messaging/whatsapp/calling/reference#call-terminate-webhook).
996
+
997
+ ```
998
+ {
999
+ "entry": [
1000
+ {
1001
+ "changes": [
1002
+ {
1003
+ "field": "calls",
1004
+ "value": {
1005
+ "metadata": {
1006
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>",
1007
+ "display_phone_number": "<BUSINESS_PHONE_NUMBER>"
1008
+ },
1009
+ "calls": [
1010
+ {
1011
+ "duration": <CALL_DURATION>,
1012
+ "start_time": "<CALL_START_TIMESTAMP>",
1013
+ "biz_opaque_callback_data": "<BUSINESS_OPAQUE_DATA>",
1014
+ "end_time": "<CALL_END_TIMESTAMP>",
1015
+ "from": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
1016
+ "from_user_id": "<BSUID>", <!-- ADDED -->
1017
+ "id": "<WHATSAPP_CALL_ID>",
1018
+ "to": "<BUSINESS_PHONE_NUMBER>",
1019
+ "event": "terminate",
1020
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
1021
+ "direction": "USER_INITIATED",
1022
+ "status": "COMPLETED"
1023
+ }
1024
+ ],
1025
+ "contacts": [
1026
+ {
1027
+ "wa_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
1028
+ "profile": {
1029
+ "name": "<USER_PROFILE_NAME>", <!-- ADDED -->
1030
+ "country_code": "<USER_COUNTRY_CODE>" <!-- ADDED -->
1031
+ },
1032
+ "user_id": "<BSUID>" <!-- ADDED -->
1033
+ }
1034
+ ],
1035
+ "messaging_product": "whatsapp"
1036
+ }
1037
+ }
1038
+ ],
1039
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>"
1040
+ }
1041
+ ],
1042
+ "object": "whatsapp_business_account"
1043
+ }
1044
+ ```
1045
+
1046
+ - `from`: novo valor vazio. O campo ficará vazio se o usuário tiver adotado um nome de usuário e (1) seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário e (2) você não tiver enviado mensagem ou ligado para o número de telefone do usuário nos últimos 30 dias. Caso contrário, será definida como o número de telefone do usuário.- `from_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `wa_id`: novo valor vazio. O campo ficará vazio se o usuário tiver adotado um nome de usuário e (1) seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário e (2) você não tiver enviado mensagem ou ligado para o número de telefone do usuário nos últimos 30 dias. Caso contrário, será definida como o número de telefone do usuário.- `name`: nova propriedade. Será definida como o nome do perfil do usuário.- `country_code`: nova propriedade. Será definida como o código do país do usuário (_sujeito a alteração_).- `user_id`: nova propriedade. Será definida como o BSUID do usuário.
1047
+
1048
+ ### Webhooks de status de ligações iniciadas pela empresa
1049
+
1050
+ As alterações serão aplicadas a webhooks de [status de ligações](/documentation/business-messaging/whatsapp/calling/reference#call-status-webhook) iniciadas pela empresa.
1051
+
1052
+ ```
1053
+ {
1054
+ "entry": [
1055
+ {
1056
+ "changes": [
1057
+ {
1058
+ "field": "calls",
1059
+ "value": {
1060
+ "statuses": [
1061
+ {
1062
+ "biz_opaque_callback_data": "<BUSINESS_OPAQUE_DATA>",
1063
+ "id": "<WHATSAPP_CALL_ID>",
1064
+ "type": "call",
1065
+ "status": "<STATUS>",
1066
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
1067
+ "recipient_id": "<USER_PHONE_NUMBER>", <!-- CHANGED -->
1068
+ "recipient_user_id": "<BSUID>" <!-- ADDED -->
1069
+ }
1070
+ ],
1071
+ "metadata": {
1072
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>",
1073
+ "display_phone_number": "<BUSINESS_PHONE_NUMBER>"
1074
+ },
1075
+ "contacts": [ <!-- ADDED -->
1076
+ {
1077
+ "profile": {
1078
+ "name": "<USER_PROFILE_NAME>", <!-- ADDED -->
1079
+ "country_code": "<USER_COUNTRY_CODE>" <!-- ADDED -->
1080
+ },
1081
+ "user_id": "<BSUID>" <!-- ADDED -->
1082
+ }
1083
+ ],
1084
+ "messaging_product": "whatsapp"
1085
+ }
1086
+ }
1087
+ ],
1088
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>"
1089
+ }
1090
+ ],
1091
+ "object": "whatsapp_business_account"
1092
+ }
1093
+ ```
1094
+
1095
+ - `recipient_id`: novo valor vazio. Essa propriedade será definida como uma string vazia se o usuário do WhatsApp tiver adotado um nome de usuário e (1) a ligação tiver sido feita para o respectivo BSUID, (2) seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário e (3) você não tiver enviado mensagem ou ligado para o número de telefone do usuário nos últimos 30 dias. Caso contrário, será definida como o número de telefone do usuário.- `recipient_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `contacts`: uma nova matriz de contatos será incluída.- `name`: nova propriedade. Será definida como o nome do perfil do usuário.- `country_code`: nova propriedade. Será definida como o código do país do usuário (_sujeito a alteração_).- `user_id`: nova propriedade. Será definida como o BSUID do usuário.
1096
+
1097
+ ### Convites de SIP para ligações iniciadas pela empresa
1098
+
1099
+ As alterações se aplicam a ligações iniciadas pela empresa usando [SIP](/documentation/business-messaging/whatsapp/calling/sip).
1100
+
1101
+ ```
1102
+ <!-- BEGIN CHANGE -->
1103
+ INVITE sip:<BSUID>@wa.meta.vc;transport=tls SIP/2.0
1104
+ <!-- END CHANGE -->
1105
+
1106
+ Record-Route: <sip:+159.65.244.171:5061;transport=tls;lr;ftag=Kc9QZg4496maQ;nat=yes>
1107
+ Via: SIP/2.0/TLS 159.65.244.171:5061;received=2803:6081:798c:93f8:5f9b:bfe8:300:0;branch=z9hG4bK0da2.36614b8977461b486ceabc004c723476.0;i=617261
1108
+ Via: SIP/2.0/TLS 137.184.87.1:35181;rport=56533;received=137.184.87.1;branch=z9hG4bKQNa6meey5Dj2g
1109
+ Max-Forwards: 69
1110
+ From: <sip:+17125550259@meta-voip.example.com>;tag=Kc9QZg4496maQ
1111
+
1112
+ <!-- BEGIN CHANGE -->
1113
+ To: <sip:<BSUID>@wa.meta.vc>
1114
+ <!-- END CHANGE -->
1115
+
1116
+ Call-ID: dc2c5b33-1b81-43ee-9213-afb56f4e56ba
1117
+ CSeq: 96743476 INVITE
1118
+ Contact: <sip:mod_sofia@137.184.87.1:35181;transport=tls;swrad=137.184.87.1~56533~3>
1119
+ User-Agent: SignalWire
1120
+ Allow: INVITE, ACK, BYE, CANCEL, OPTIONS, MESSAGE, INFO, UPDATE, REGISTER, REFER, NOTIFY
1121
+ Supported: timer, path, replaces
1122
+ Allow-Events: talk, hold, conference, refer
1123
+ Session-Expires: 600;refresher=uac
1124
+ Min-SE: 90
1125
+ Content-Type: application/sdp
1126
+ Content-Disposition: session
1127
+ Content-Length: 2427
1128
+ X-Relay-Call-ID: dc2c5b33-1b81-43ee-9213-afb56f4e56ba
1129
+ Remote-Party-ID: <sip:+17125550259@meta-voip.example.com>;party=calling;screen=yes;privacy=off
1130
+ Content-Type: application/sdp
1131
+ Content-Length: 2427
1132
+
1133
+ <!-- SDP omitted for brevity -->
1134
+ ```
1135
+
1136
+ - `BSUID`: será o BSUID do usuário se a ligação tiver sido feita para o BSUID do usuário ou o número de telefone do usuário se tiver sido enviada para o número de telefone.
1137
+
1138
+ ### Convites de SIP para ligações iniciadas pelo usuário
1139
+
1140
+ As alterações se aplicam a ligações iniciadas pelo usuário realizadas usando [SIP](/documentation/business-messaging/whatsapp/calling/sip).
1141
+
1142
+ ```
1143
+ INVITE sip:+17015558857@meta-voip.example.com;transport=tls SIP/2.0
1144
+ Via: SIP/2.0/TLS [2803:6080:e888:51aa:d4a4:c5e0:300:0]:33819;rport=33819;received=2803:6080:e888:51aa:d4a4:c5e0:300:0;branch=z9hG4bKPjNvs.IZBnUa1W4l8oHPpk3SUMmcx3MMcE;alias
1145
+ Max-Forwards: 70
1146
+
1147
+ <!-- BEGIN CHANGE -->
1148
+ From: "<BSUID>" <sip:<BSUID>@wa.meta.vc>;tag=bbf1ad6e-79bb-4d9c-8a2c-094168a10bea
1149
+ <!-- END CHANGE -->
1150
+
1151
+ To: <sip:+17015558857@meta-voip.example.com>
1152
+
1153
+ <!-- BEGIN CHANGE -->
1154
+ Contact: <sip:<BSUID>@wa.meta.vc;transport=tls;ob>;isfocus
1155
+ <!-- END CHANGE -->
1156
+
1157
+ Call-ID: outgoing:wacid.HBgLMTIxOTU1NTA3MTQVAgASGCAzODg1NTE5NEU1NTBEMTc1RTFFQUY5NjNCQ0FCRkEzRhwYCzE3MDE1NTU4ODU3FQIAAA==
1158
+ CSeq: 2824 INVITE
1159
+ Route: <sip:onevc-sip-proxy-dev.fbinfra.net:8191;transport=tls;lr>
1160
+ X-FB-External-Domain: wa.meta.vc
1161
+
1162
+ <!-- BEGIN ADDITION -->
1163
+ x-wa-meta-user-id: <BSUID>
1164
+ x-wa-meta-user-name: <USERNAME>
1165
+ x-wa-meta-user-country-code: <USER_COUNTRY_CODE><!-- END ADDITION -->
1166
+
1167
+ Allow: INVITE, ACK, BYE, CANCEL, NOTIFY, OPTIONS
1168
+ User-Agent: Facebook SipGateway
1169
+ Content-Type: application/sdp
1170
+ Content-Length: 1028
1171
+
1172
+ <!-- SDP omitted for brevity -->
1173
+ ```
1174
+
1175
+ - `BSUID`: será o BSUID do usuário se a ligação tiver sido feita para o respectivo BSUID ou se o usuário tiver adotado um nome de usuário e (1) você não tiver enviado mensagem ou ligado para o número de telefone do usuário nos últimos 30 dias ou (2) seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será o número de telefone do usuário.- `USERNAME`: será o nome de usuário do usuário.- `USER_COUNTRY_CODE`: será o código do país do usuário (_sujeito a alteração_).
1176
+
1177
+ ### Respostas OK do SIP para ligações iniciadas pela empresa
1178
+
1179
+ ```
1180
+ SIP/2.0 200 OK
1181
+ Via: SIP/2.0/TLS 54.172.60.1:5061;received=2803:6080:f934:8894:7eb5:24f9:300:0;branch=z9hG4bK1e5a.0da2ace9cc912d9e5f2595ca4acb9847.0
1182
+ Via: SIP/2.0/UDP 172.25.10.217:5060;rport=5060;branch=z9hG4bK5cdada8c-cbf0-4369-b02d-cc97d3c36f2b_c3356d0b_54-457463274351249162
1183
+ Record-Route: <sip:onevc-sip-proxy.fbinfra.net:8191;transport=tls;lr>
1184
+ Record-Route: <sip:wa.meta.vc;transport=tls;lr>
1185
+ Record-Route: <sip:54.172.60.1:5061;transport=tls;lr;r2=on>
1186
+ Record-Route: <sip:54.172.60.1;lr;r2=on>
1187
+ Call-ID: f304a1d2cafb8139c1f9ff93a7733586@0.0.0.0
1188
+
1189
+ <!-- BEGIN CHANGE -->
1190
+ From: "<BSUID>" <sip:<BSUID>@meta-voip.example.com>;tag=28460006_c3356d0b_5cdada8c-cbf0-4369-b02d-cc97d3c36f2b
1191
+ <!-- END CHANGE -->
1192
+
1193
+ To: <sip:12195550714@wa.meta.vc>;tag=0d185053-2615-46c7-8ff2-250bda494cf1
1194
+ CSeq: 2 INVITE
1195
+ Allow: INVITE, ACK, BYE, CANCEL, NOTIFY, OPTIONS
1196
+ Supported: timer
1197
+ X-FB-External-Domain: wa.meta.vc
1198
+
1199
+ <!-- BEGIN CHANGE -->
1200
+ Contact: <sip:<BSUID>@wa.meta.vc;transport=tls;ob;X-FB-Sip-Smc-Tier=collaboration.sip_gateway.sip.prod>;isfocus
1201
+ <!-- END CHANGE --><!-- BEGIN ADDITION -->
1202
+ x-wa-meta-user-id: <BSUID>
1203
+ x-wa-meta-user-name: <USERNAME>
1204
+ x-wa-meta-user-country-code: <COUNTRY_CODE><!-- END ADDITION -->
1205
+
1206
+ Content-Type: application/sdp
1207
+ Content-Length: 645
1208
+
1209
+ <!-- SDP omitted for brevity -->
1210
+ ```
1211
+
1212
+ - `BSUID`: será o BSUID do usuário se a ligação tiver sido feita para o respectivo BSUID ou se o usuário tiver adotado um nome de usuário e (1) você não tiver enviado mensagem ou ligado para o número de telefone do usuário nos últimos 30 dias ou (2) seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será o número de telefone do usuário.- `USERNAME`: será o nome de usuário do usuário.- `USER_COUNTRY_CODE`: será o código do país do usuário (_sujeito a alteração_).
1213
+
1214
+ ### Respostas BYE do SIP para ligações iniciadas pela empresa e pelo usuário
1215
+
1216
+ ```
1217
+ BYE sip:+12195550714@103.30.244.182:5061;transport=tls SIP/2.0
1218
+ Via: SIP/2.0/TLS [2803:6080:e800:6746::]:56843;rport;branch=z9hG4bKPj65946b3e6f68128d52b6a498a8fd00a5;alias
1219
+ Record-Route: <sip:wa.meta.vc;transport=tls;lr>
1220
+ Record-Route: <sip:onevc-sip-proxy.fbinfra.net:8191;transport=tls;lr>
1221
+ Via: SIP/2.0/TLS [2803:6080:e800:6746:3347:2251:14a4:a00]:5061;branch=z9hG4bKPj65946b3e6f68128d52b6a498a8fd00a5
1222
+ Via: SIP/2.0/TLS [2803:6080:e934:3f82:b543:8a4d:1414:a00]:52767;rport=52767;received=2803:6080:e934:3f82:b543:8a4d:1414:a00;branch=z9hG4bKPj-D8BXdIVMqAUT9MIJIp78LxKUZNnjYKF;alias
1223
+ Max-Forwards: 69
1224
+
1225
+ <!-- BEGIN CHANGE -->
1226
+ From: <sip:<BSUID>@wa.meta.vc>;tag=0fb8b5f1-2703-49f4-a454-46b1bcb9bfac
1227
+ <!-- END CHANGE -->
1228
+
1229
+ To: <sip:+12195550714@dev.moxcal.com>;tag=2c21fad0-c581-4e54-a707-3bd52abfcc3f
1230
+ Call-ID: 21e38222-6fcb-4631-8e7d-5b94cf849c90
1231
+ CSeq: 31641 BYE
1232
+
1233
+ <!-- BEGIN ADDITION -->
1234
+ x-wa-meta-user-id: <BSUID>
1235
+ x-wa-meta-user-name: <USERNAME>
1236
+ x-wa-meta-user-country-code: <USER_COUNTRY_CODE><!-- END ADDITION -->
1237
+
1238
+ X-FB-External-Domain: wa.meta.vc
1239
+ Allow: INVITE, ACK, BYE, CANCEL, NOTIFY, OPTIONS
1240
+ User-Agent: Facebook SipGateway
1241
+ Content-Length: 0
1242
+ ```
1243
+
1244
+ - `BSUID`: será o BSUID do usuário se a ligação tiver sido feita para o respectivo BSUID ou se o usuário tiver adotado um nome de usuário e (1) você não tiver enviado mensagem ou ligado para o número de telefone do usuário nos últimos 30 dias ou (2) seu número de telefone comercial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será o número de telefone do usuário.- `USERNAME`: será o nome de usuário do usuário.- `USER_COUNTRY_CODE`: será o código do país do usuário (_sujeito a alteração_).
1245
+
1246
+ ## Coexistência
1247
+
1248
+ ### Webhooks de histórico
1249
+
1250
+ As alterações serão aplicadas aos webhooks de [histórico](/documentation/business-messaging/whatsapp/webhooks/reference/history) que descrevem o histórico de conversas do app WhatsApp Business de um cliente empresarial integrado.
1251
+
1252
+ ```
1253
+ {
1254
+ "object": "whatsapp_business_account",
1255
+ "entry": [
1256
+ {
1257
+ "id": "<CUSTOMER_WABA_ID>",
1258
+ "changes": [
1259
+ {
1260
+ "value": {
1261
+ "messaging_product": "whatsapp",
1262
+ "metadata": {
1263
+ "display_phone_number": "<CUSTOMER_DISPLAY_PHONE_NUMBER>",
1264
+ "phone_number_id": "<CUSTOMER_PHONE_NUMBER_ID>"
1265
+ },
1266
+ "history": [
1267
+ {
1268
+ "metadata": {
1269
+ "phase": <PHASE>,
1270
+ "chunk_order": <CHUNK_ORDER>,
1271
+ "progress": <PROGRESS>
1272
+ },
1273
+ "threads": [
1274
+ <!-- First chat history thread object -->
1275
+ {
1276
+ "id": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
1277
+ "context": { <!-- ADDED -->
1278
+ "wa_id": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- ADDED -->
1279
+ "user_id": "<BSUID>", <!-- ADDED -->
1280
+ "username": "<USERNAME>", <!-- ADDED -->
1281
+ "country_code": "US" <!-- ADDED -->
1282
+ },
1283
+ "messages": [
1284
+ <!-- First message object in thread -->
1285
+ {
1286
+ "from": "<BUSINESS_OR_WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
1287
+ "from_user_id" : "<BSUID>", <!-- ADDED -->
1288
+ "to": "<WHATSAPP_USER_PHONE_NUMBER>",
1289
+ "id": "<WHATSAPP_MESSAGE_ID>",
1290
+ "timestamp": "<DEVICE_TIMESTAMP>,
1291
+ "type": "<MESSAGE_TYPE>",
1292
+ "<MESSAGE_TYPE>": {
1293
+ <MESSAGE_CONTENTS>
1294
+ },
1295
+ "history_context": {
1296
+ "status": "<MESSAGE_STATUS>"
1297
+ }
1298
+ },
1299
+ <!-- Additional message objects in thread would follow, if any -->
1300
+ ]
1301
+ },
1302
+ <!-- Additional chat history thread objects would follow, if any -->
1303
+ ]
1304
+ }
1305
+ ]
1306
+ },
1307
+ "field": "history"
1308
+ }
1309
+ ]
1310
+ }
1311
+ ]
1312
+ }
1313
+ ```
1314
+
1315
+ - `id`: novo valor vazio. Será uma string vazia se, no momento em que o usuário enviou a mensagem para o cliente comercial, (1) o usuário já tiver habilitado nomes de usuário, (2) o cliente comercial não tiver enviado mensagem para o número de telefone do usuário em até 30 dias a partir do momento do envio da mensagem e (3) o número de telefone comercial do cliente não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `context`: um novo objeto de contexto será incluído.- `wa_id`: nova propriedade. Será uma string vazia se, no momento em que o usuário enviou a mensagem para o cliente comercial, (1) o usuário já tiver habilitado nomes de usuário, (2) o cliente comercial não tiver enviado mensagem para o número de telefone do usuário em até 30 dias a partir do momento do envio da mensagem e (3) o número de telefone comercial do cliente não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `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.- `country_code`: nova propriedade. Será definida como o código do país do usuário (\_sujeito a alteração).- `from`: novo valor vazio. Será uma string vazia se, no momento em que o usuário enviou a mensagem para o cliente comercial, (1) o usuário já tiver habilitado nomes de usuário, (2) o cliente comercial não tiver enviado mensagem para o número de telefone do usuário em até 30 dias a partir do momento do envio da mensagem e (3) o número de telefone comercial do cliente não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `from_user_id`: nova propriedade. Será definida como o BSUID do usuário.
1316
+
1317
+ 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
+
1319
+ ```
1320
+ {
1321
+ "object": "whatsapp_business_account",
1322
+ "entry": [
1323
+ {
1324
+ "id": "<CUSTOMER_WABA_ID>",
1325
+ "changes": [
1326
+ {
1327
+ "value": {
1328
+ "messaging_product": "whatsapp",
1329
+ "metadata": {
1330
+ "display_phone_number": "<CUSTOMER_DISPLAY_PHONE_NUMBER>",
1331
+ "phone_number_id": "<CUSTOMER_PHONE_NUMBER_ID>"
1332
+ },
1333
+ "contacts": [ <!-- ADDED -->
1334
+ {
1335
+ "profile": {
1336
+ "username": "<USERNAME>", <!-- ADDED -->
1337
+ "country_code": "<COUNTRY_CODE>" <!-- ADDED -->
1338
+ },
1339
+ "wa_id": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- ADDED -->
1340
+ "user_id": "<BSUID>" <!-- ADDED -->
1341
+ },
1342
+ ],
1343
+
1344
+ <!-- Only for messages sent from a user to a business -->
1345
+ "messages": [
1346
+ {
1347
+ "from": "<WHATSAPP_USER_PHONE_NUMBER>",
1348
+ "from_user_id": "<BSUID>", <!-- ADDED -->
1349
+ "id": "<WHATSAPP_MESSAGE_ID>",
1350
+ "timestamp": "<ORIGINAL_WEBHOOK_TRIGGER_TIMESTAMP>",
1351
+ "type": "<MEDIA_TYPE>",
1352
+ "<MEDIA_TYPE>": {
1353
+ <MEDIA_METADATA>
1354
+ }
1355
+ }
1356
+ ],
1357
+
1358
+ <!-- Only for messages sent from a business to a user -->
1359
+ "message_echoes": [
1360
+ {
1361
+ "from": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
1362
+ "to": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
1363
+ "to_user_id": "<BSUID>", <!-- ADDED -->
1364
+ "id": "<WHATSAPP_MESSAGE_ID>",
1365
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
1366
+ "type": "<MESSAGE_TYPE>",
1367
+ "<MESSAGE_TYPE>": {
1368
+ <MESSAGE_CONTENTS>
1369
+ }
1370
+ }
1371
+ ]
1372
+
1373
+ },
1374
+ "field": "history"
1375
+ }
1376
+ ]
1377
+ }
1378
+ ]
1379
+ }
1380
+ ```
1381
+
1382
+ - `contacts`: um novo objeto de contatos será incluído.- `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.- `country_code`: nova propriedade. Será definida como o código do país do usuário (_sujeito a alteração_).- `wa_id`: nova propriedade. Será uma string vazia se, no momento em que o usuário enviou a mensagem para o cliente comercial, (1) o usuário já tiver habilitado nomes de usuário, (2) o cliente comercial não tiver enviado mensagem para o número de telefone do usuário em até 30 dias a partir do momento do envio da mensagem e (3) o número de telefone comercial do cliente não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `from_user_id`: nova propriedade. Será definida como o BSUID do usuário.- `to`: novo valor vazio. Será uma string vazia se, no momento em que a empresa enviou a mensagem para o usuário, (1) o usuário já tiver habilitado nomes de usuário, (2) o cliente comercial não tiver enviado mensagem para o número de telefone do usuário em até 30 dias a partir do momento do envio da mensagem e (3) o número de telefone comercial do cliente não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `to_user_id`: nova propriedade. Será definida como o BSUID do usuário.
1383
+
1384
+ ### Webhooks smb\_message\_echoes
1385
+
1386
+ As alterações serão aplicadas aos webhooks [smb\_message\_echoes](/documentation/business-messaging/whatsapp/webhooks/reference/smb_message_echoes).
1387
+
1388
+ ```
1389
+ {
1390
+ "object": "whatsapp_business_account",
1391
+ "entry": [
1392
+ {
1393
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
1394
+ "changes": [
1395
+ {
1396
+ "value": {
1397
+ "messaging_product": "whatsapp",
1398
+ "metadata": {
1399
+ "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
1400
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
1401
+ },
1402
+ "contacts": [ <!-- ADDED -->
1403
+ {
1404
+ "profile": {
1405
+ "username": "<USERNAME>", <!-- ADDED -->
1406
+ "country_code": "<COUNTRY_CODE>" <!-- ADDED -->
1407
+ },
1408
+ "wa_id": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- ADDED -->
1409
+ "user_id": "<BSUID>" <!-- ADDED -->
1410
+ }
1411
+ ],
1412
+ "message_echoes": [
1413
+ {
1414
+ "from": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
1415
+ "to": "<WHATSAPP_USER_PHONE_NUMBER>", <!-- CHANGED -->
1416
+ "to_user_id": "<BSUID>", <!-- ADDED -->
1417
+ "id": "<WHATSAPP_MESSAGE_ID>",
1418
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
1419
+ "type": "<MESSAGE_TYPE>",
1420
+ "<MESSAGE_TYPE>": {
1421
+ <MESSAGE_CONTENTS>
1422
+ }
1423
+ }
1424
+ ]
1425
+ },
1426
+ "field": "smb_message_echoes"
1427
+ }
1428
+ ]
1429
+ }
1430
+ ]
1431
+ }
1432
+ ```
1433
+
1434
+ - `contacts`: um novo objeto de contatos será incluído.- `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.- `country_code`: nova propriedade. Será definida como o código do país do usuário (_sujeito a alteração_).- `wa_id`: nova propriedade. Será uma string vazia se, no momento em que o usuário enviou a mensagem para o cliente comercial, (1) o usuário já tiver habilitado nomes de usuário, (2) o cliente comercial não tiver enviado mensagem para o número de telefone do usuário em até 30 dias a partir do momento do envio da mensagem e (3) o número de telefone comercial do cliente não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `to`: novo valor vazio. Será uma string vazia se, no momento em que a empresa enviou a mensagem para o usuário, (1) o usuário já tiver habilitado nomes de usuário, (2) o cliente comercial não tiver enviado mensagem para o número de telefone do usuário em até 30 dias a partir do momento do envio da mensagem e (3) o número de telefone comercial do cliente não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `to_user_id`: nova propriedade. Será definida como o BSUID do usuário.
1435
+
1436
+ ### Webhooks smb\_app\_state\_sync
1437
+
1438
+ As alterações serão aplicadas aos webhooks [smb\_app\_state\_sync](/documentation/business-messaging/whatsapp/webhooks/reference/smb_app_state_sync).
1439
+
1440
+ ```
1441
+ {
1442
+ "object": "whatsapp_business_account",
1443
+ "entry": [
1444
+ {
1445
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
1446
+ "changes": [
1447
+ {
1448
+ "value": {
1449
+ "messaging_product": "whatsapp",
1450
+ "metadata": {
1451
+ "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
1452
+ "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
1453
+ },
1454
+ "state_sync": [
1455
+ {
1456
+ "type": "contact",
1457
+ "contact": {
1458
+ "full_name": "<CONTACT_FULL_NAME>",
1459
+ "first_name": "<CONTACT_FIRST_NAME>",
1460
+ "phone_number": "<CONTACT_PHONE_NUMBER>", <!-- CHANGED -->
1461
+ "user_id": "<BSUID>", <!-- ADDED -->
1462
+ "username": "<USERNAME>", <!-- ADDED -->
1463
+ "country_code": "<COUNTRY_CODE>" <!-- ADDED -->
1464
+ },
1465
+ "action": "<ACTION>",
1466
+ "metadata": {
1467
+ "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>"
1468
+ }
1469
+ },
1470
+ <!-- Additional contacts would follow, if any -->
1471
+ ]
1472
+ },
1473
+ "field": "smb_app_state_sync"
1474
+ }
1475
+ ]
1476
+ }
1477
+ ]
1478
+ }
1479
+ ```
1480
+
1481
+ - `phone_number`: novo valor vazio. Será uma string vazia se, no momento da solicitação de sincronização, (1) o usuário já tiver habilitado nomes de usuário, (2) o cliente empresarial não tiver enviado mensagem para o número de telefone do usuário no prazo de 30 dias a partir da solicitação de sincronização e (3) o número de telefone comercial do cliente empresarial não estiver na lista de contatos do WhatsApp do usuário. Caso contrário, será definida como o número de telefone do usuário.- `user_id`: nova propriedade. Será definida como o BSUID do usuário.- `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.- `country_code`: nova propriedade. Será definida como o código do país do usuário (_sujeito a alteração_).
1482
+
1483
+ ## Análise
1484
+
1485
+ Nenhuma alteração.
1486
+
1487
+ ## Cobrança e faturamento
1488
+
1489
+ Nenhuma alteração
1490
+
1491
+ ## Perguntas frequentes
1492
+
1493
+ **O que preciso fazer para aceitar nomes de usuário?**
1494
+
1495
+ As cargas de webhooks passarão a incluir o BSUID e o código do país (sujeito a alteração) antes que os nomes de usuário fiquem disponíveis para os usuários do WhatsApp. Será necessário adotar BSUIDs para processar mensagens iniciadas por usuários que tenham um nome de usuário. Para isso, você deve:
1496
+
1497
+ - Atualizar suas integrações de webhook para aceitar BSUIDs, que serão atribuídos a uma nova propriedade `user_id` nos webhooks existentes.- 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=AT2W2v3PqI2_Bc0dANQdSP2z2SnDUl9obumW51rKWvhGXGm0r52Y_jBJJr8jbMAe1UlDQ0UFo-mySTVQytrrNb-MumGmFkRKJPeuIndbE27iJKG_JcyV5cVAS3TlF9ogv1ABw8Ds4hBb2eUJDvzpn8rgtD0) 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.
1498
+
1499
+ **Quando receberei uma BSUID ou um número de telefone?**
1500
+
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 `wa_id` estiver definida como uma string vazia), será possível usar o respectivo BSUID, que será incluído e atribuído a uma nova propriedade `user_id`.
1502
+
1503
+ Se um usuário não tiver adotado nomes de usuário, você receberá o número de telefone e o BSUID.
1504
+
1505
+ Continuaremos compartilhando o número de telefone em alguns casos, principalmente para interações com clientes existentes. Incluiremos ou retornaremos automaticamente o número de telefone do usuário em até 30 dias após qualquer interação entre você e o número de telefone do usuário ou se o número de telefone da sua empresa estiver na lista de contatos do WhatsApp do usuário.
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.
1508
+
1509
+ **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
+
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, parceiros e empresas precisarão garantir que todos os sistemas conectados possam lidar com o BSUID. Elas também poderão pedir o número de telefone do usuário na conversa.
1512
+
1513
+ **Se uma empresa ainda não tiver adotado o BSUID e começar a receber mensagens de usuários que não consegue processar, haverá algum recurso ou ação corretiva?**
1514
+
1515
+ Se uma empresa ainda não tiver adotado o BSUID e não conseguir processar mensagens de usuários que fizeram a alteração, não haverá recursos ou ações corretivas.
1516
+
1517
+ - Para mensagens de novos clientes da empresa: a Meta continuará enviando o webhook de uma mensagem recebida. Dependendo das especificidades da implementação, isso pode afetar sistemas que não estão preparados para lidar com uma string vazia enviada no campo wa\_id quando o número de telefone não está presente e o ID de usuário do sistema de empresa é enviado por meio de um novo campo.- Para mensagens de clientes existentes da empresa: continuaremos compartilhando o número de telefone em alguns casos, principalmente para interações com clientes existentes.
1518
+
1519
+ **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
+
1521
+ Os nomes de usuário comerciais permitirão que os usuários entrem em contato com a empresa usando o nome de usuário dela. Ou seja, um usuário final pode pesquisar um nome de usuário comercial e entrar em contato com a organização. Como os usuários finais não podem pesquisar por nomes de exibição, os nomes de usuário comerciais oferecem uma clara vantagem como identificador único e pesquisável para que os usuários encontrem a empresa correta de forma confiável.
1522
+
1523
+ Os nomes de usuário comercial precisam seguir regras de formatação específicas em relação ao tamanho e aos caracteres permitidos, mas os nomes de exibição são mais flexíveis em termos de formatação.
1524
+
1525
+ 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
+
1527
+ Quando a empresa tiver um nome de usuário e um de exibição, o último será mostrado primeiro (por exemplo, no perfil, na lista de conversas, nas mensagens e assim por diante). 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.
1528
+
1529
+ Você achou esta página útil?
1530
+
1531
+ ![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
1532
+
1533
+ ![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)