whatsapp-docs-mcp 1.0.0

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 (406) hide show
  1. package/LICENSE +22 -0
  2. package/README.md +181 -0
  3. package/dist/index.d.ts +3 -0
  4. package/dist/index.d.ts.map +1 -0
  5. package/dist/index.js +65 -0
  6. package/dist/index.js.map +1 -0
  7. package/dist/prompts.d.ts +22 -0
  8. package/dist/prompts.d.ts.map +1 -0
  9. package/dist/prompts.js +305 -0
  10. package/dist/prompts.js.map +1 -0
  11. package/dist/resources.d.ts +24 -0
  12. package/dist/resources.d.ts.map +1 -0
  13. package/dist/resources.js +132 -0
  14. package/dist/resources.js.map +1 -0
  15. package/dist/tools.d.ts +6 -0
  16. package/dist/tools.d.ts.map +1 -0
  17. package/dist/tools.js +379 -0
  18. package/dist/tools.js.map +1 -0
  19. package/dist/utils/fileLoader.d.ts +19 -0
  20. package/dist/utils/fileLoader.d.ts.map +1 -0
  21. package/dist/utils/fileLoader.js +126 -0
  22. package/dist/utils/fileLoader.js.map +1 -0
  23. package/dist/utils/search.d.ts +27 -0
  24. package/dist/utils/search.d.ts.map +1 -0
  25. package/dist/utils/search.js +91 -0
  26. package/dist/utils/search.js.map +1 -0
  27. package/docs/QUICK_REFERENCE.md +223 -0
  28. package/docs/anuncios_com_clique_para_whatsapp/AGENTS.md +8 -0
  29. package/docs/anuncios_com_clique_para_whatsapp/welcome_message_sequences.md +449 -0
  30. package/docs/ativos_da_conta/AGENTS.md +9 -0
  31. package/docs/ativos_da_conta/outros_ativos/AGENTS.md +12 -0
  32. package/docs/ativos_da_conta/outros_ativos/business_profiles.md +137 -0
  33. package/docs/ativos_da_conta/outros_ativos/display_names.md +108 -0
  34. package/docs/ativos_da_conta/outros_ativos/official_business_accounts.md +123 -0
  35. package/docs/ativos_da_conta/outros_ativos/qr_codes.md +198 -0
  36. package/docs/ativos_da_conta/outros_ativos/whatsapp_business_accounts.md +99 -0
  37. package/docs/ativos_da_conta/telefones_comerciais/AGENTS.md +11 -0
  38. package/docs/ativos_da_conta/telefones_comerciais/conversational_components.md +347 -0
  39. package/docs/ativos_da_conta/telefones_comerciais/phone_numbers.md +486 -0
  40. package/docs/ativos_da_conta/telefones_comerciais/registration.md +171 -0
  41. package/docs/ativos_da_conta/telefones_comerciais/two_step_verification.md +66 -0
  42. package/docs/catalogos/AGENTS.md +12 -0
  43. package/docs/catalogos/receive_responses.md +28 -0
  44. package/docs/catalogos/sell_products_and_services.md +24 -0
  45. package/docs/catalogos/set_commerce_settings.md +163 -0
  46. package/docs/catalogos/share_products.md +401 -0
  47. package/docs/catalogos/upload_inventory.md +28 -0
  48. package/docs/comecar/AGENTS.md +8 -0
  49. package/docs/comecar/get_started.md +127 -0
  50. package/docs/dados_privacidade_e_politica/AGENTS.md +16 -0
  51. package/docs/dados_privacidade_e_politica/block_users.md +549 -0
  52. package/docs/dados_privacidade_e_politica/data_privacy_and_security.md +78 -0
  53. package/docs/dados_privacidade_e_politica/encryption.md +8 -0
  54. package/docs/dados_privacidade_e_politica/getting_opt_in.md +41 -0
  55. package/docs/dados_privacidade_e_politica/identity_change.md +34 -0
  56. package/docs/dados_privacidade_e_politica/local_storage.md +277 -0
  57. package/docs/dados_privacidade_e_politica/no_storage.md +132 -0
  58. package/docs/dados_privacidade_e_politica/policy_enforcement.md +85 -0
  59. package/docs/dados_privacidade_e_politica/policy_enforcement_violations.md +127 -0
  60. package/docs/grupos/AGENTS.md +15 -0
  61. package/docs/grupos/error_codes.md +170 -0
  62. package/docs/grupos/faq.md +30 -0
  63. package/docs/grupos/get_started.md +73 -0
  64. package/docs/grupos/groups.md +75 -0
  65. package/docs/grupos/groups_messaging.md +340 -0
  66. package/docs/grupos/pricing.md +322 -0
  67. package/docs/grupos/reference.md +1059 -0
  68. package/docs/grupos/webhooks.md +298 -0
  69. package/docs/index.md +318 -0
  70. package/docs/insights/AGENTS.md +8 -0
  71. package/docs/insights/analytics.md +944 -0
  72. package/docs/ligacoes/AGENTS.md +20 -0
  73. package/docs/ligacoes/app_review_guidelines.md +48 -0
  74. package/docs/ligacoes/business_initiated_calls.md +858 -0
  75. package/docs/ligacoes/call_button_messages_deep_links.md +454 -0
  76. package/docs/ligacoes/call_settings.md +643 -0
  77. package/docs/ligacoes/calling.md +130 -0
  78. package/docs/ligacoes/faq.md +468 -0
  79. package/docs/ligacoes/integration_patterns.md +121 -0
  80. package/docs/ligacoes/pricing.md +339 -0
  81. package/docs/ligacoes/reference.md +1923 -0
  82. package/docs/ligacoes/sip.md +1090 -0
  83. package/docs/ligacoes/troubleshooting.md +483 -0
  84. package/docs/ligacoes/user_call_permissions.md +672 -0
  85. package/docs/ligacoes/user_initiated_calls.md +1030 -0
  86. package/docs/mensagens/AGENTS.md +46 -0
  87. package/docs/mensagens/limites_de_mensagens/AGENTS.md +9 -0
  88. package/docs/mensagens/limites_de_mensagens/messaging_limits.md +91 -0
  89. package/docs/mensagens/limites_de_mensagens/upcoming_changes.md +8 -0
  90. package/docs/mensagens/recursos_adicionais/AGENTS.md +13 -0
  91. package/docs/mensagens/recursos_adicionais/contextual_replies.md +82 -0
  92. package/docs/mensagens/recursos_adicionais/link_previews.md +58 -0
  93. package/docs/mensagens/recursos_adicionais/mark_message_as_read.md +111 -0
  94. package/docs/mensagens/recursos_adicionais/media.md +419 -0
  95. package/docs/mensagens/recursos_adicionais/payload_encryption.md +8 -0
  96. package/docs/mensagens/recursos_adicionais/typing_indicators.md +117 -0
  97. package/docs/mensagens/tipos_de_mensagens/AGENTS.md +24 -0
  98. package/docs/mensagens/tipos_de_mensagens/address_messages.md +465 -0
  99. package/docs/mensagens/tipos_de_mensagens/audio_messages.md +211 -0
  100. package/docs/mensagens/tipos_de_mensagens/contacts_messages.md +482 -0
  101. package/docs/mensagens/tipos_de_mensagens/document_messages.md +232 -0
  102. package/docs/mensagens/tipos_de_mensagens/image_messages.md +176 -0
  103. package/docs/mensagens/tipos_de_mensagens/interactive_cta_url_messages.md +240 -0
  104. package/docs/mensagens/tipos_de_mensagens/interactive_flow_messages.md +8 -0
  105. package/docs/mensagens/tipos_de_mensagens/interactive_list_messages.md +300 -0
  106. package/docs/mensagens/tipos_de_mensagens/interactive_reply_buttons_messages.md +271 -0
  107. package/docs/mensagens/tipos_de_mensagens/location_messages.md +156 -0
  108. package/docs/mensagens/tipos_de_mensagens/location_request_messages.md +310 -0
  109. package/docs/mensagens/tipos_de_mensagens/message_with_link.md +8 -0
  110. package/docs/mensagens/tipos_de_mensagens/reaction_messages.md +144 -0
  111. package/docs/mensagens/tipos_de_mensagens/sticker_messages.md +157 -0
  112. package/docs/mensagens/tipos_de_mensagens/template_messages.md +20 -0
  113. package/docs/mensagens/tipos_de_mensagens/text_messages.md +142 -0
  114. package/docs/mensagens/tipos_de_mensagens/video_messages.md +149 -0
  115. package/docs/mensagens/visao_geral/AGENTS.md +8 -0
  116. package/docs/mensagens/visao_geral/send_messages.md +370 -0
  117. package/docs/mensagens_de_marketing/AGENTS.md +10 -0
  118. package/docs/mensagens_de_marketing/implementacao/AGENTS.md +10 -0
  119. package/docs/mensagens_de_marketing/implementacao/get_started.md +107 -0
  120. package/docs/mensagens_de_marketing/implementacao/onboard_business_customers.md +180 -0
  121. package/docs/mensagens_de_marketing/implementacao/send_marketing_messages.md +260 -0
  122. package/docs/mensagens_de_marketing/recursos/AGENTS.md +12 -0
  123. package/docs/mensagens_de_marketing/recursos/automatic_creative_optimization.md +8 -0
  124. package/docs/mensagens_de_marketing/recursos/conversion_measurement.md +8 -0
  125. package/docs/mensagens_de_marketing/recursos/deep_links.md +302 -0
  126. package/docs/mensagens_de_marketing/recursos/track_click_events.md +119 -0
  127. package/docs/mensagens_de_marketing/recursos/view_metrics.md +338 -0
  128. package/docs/mensagens_de_marketing/visao_geral/AGENTS.md +8 -0
  129. package/docs/mensagens_de_marketing/visao_geral/overview.md +26 -0
  130. package/docs/modelos/AGENTS.md +12 -0
  131. package/docs/modelos/gerenciamento_de_modelos/AGENTS.md +21 -0
  132. package/docs/modelos/gerenciamento_de_modelos/components.md +717 -0
  133. package/docs/modelos/gerenciamento_de_modelos/supported_languages.md +462 -0
  134. package/docs/modelos/gerenciamento_de_modelos/tap_target_url_title_override.md +211 -0
  135. package/docs/modelos/gerenciamento_de_modelos/template_categorization.md +499 -0
  136. package/docs/modelos/gerenciamento_de_modelos/template_comparison.md +136 -0
  137. package/docs/modelos/gerenciamento_de_modelos/template_library.md +526 -0
  138. package/docs/modelos/gerenciamento_de_modelos/template_management.md +148 -0
  139. package/docs/modelos/gerenciamento_de_modelos/template_media.md +8 -0
  140. package/docs/modelos/gerenciamento_de_modelos/template_migration.md +164 -0
  141. package/docs/modelos/gerenciamento_de_modelos/template_pacing.md +38 -0
  142. package/docs/modelos/gerenciamento_de_modelos/template_pausing.md +58 -0
  143. package/docs/modelos/gerenciamento_de_modelos/template_quality.md +47 -0
  144. package/docs/modelos/gerenciamento_de_modelos/template_review.md +74 -0
  145. package/docs/modelos/gerenciamento_de_modelos/time_to_live.md +88 -0
  146. package/docs/modelos/modelos_de_autenticacao/AGENTS.md +13 -0
  147. package/docs/modelos/modelos_de_autenticacao/authentication_best_practices.md +73 -0
  148. package/docs/modelos/modelos_de_autenticacao/authentication_templates.md +252 -0
  149. package/docs/modelos/modelos_de_autenticacao/autofill_button_authentication_templates.md +732 -0
  150. package/docs/modelos/modelos_de_autenticacao/copy_code_button_authentication_templates.md +402 -0
  151. package/docs/modelos/modelos_de_autenticacao/error_signals.md +143 -0
  152. package/docs/modelos/modelos_de_autenticacao/zero_tap_authentication_templates.md +742 -0
  153. package/docs/modelos/modelos_de_marketing/AGENTS.md +18 -0
  154. package/docs/modelos/modelos_de_marketing/call_permission_request_message_template.md +221 -0
  155. package/docs/modelos/modelos_de_marketing/catalog_templates.md +308 -0
  156. package/docs/modelos/modelos_de_marketing/coupon_templates.md +425 -0
  157. package/docs/modelos/modelos_de_marketing/custom_marketing_templates.md +537 -0
  158. package/docs/modelos/modelos_de_marketing/limited_time_offer_templates.md +496 -0
  159. package/docs/modelos/modelos_de_marketing/marketing_templates.md +112 -0
  160. package/docs/modelos/modelos_de_marketing/media_card_carousel_templates.md +770 -0
  161. package/docs/modelos/modelos_de_marketing/mpm_templates.md +717 -0
  162. package/docs/modelos/modelos_de_marketing/per_user_limits.md +42 -0
  163. package/docs/modelos/modelos_de_marketing/product_card_carousel_templates.md +515 -0
  164. package/docs/modelos/modelos_de_marketing/spm_templates.md +466 -0
  165. package/docs/modelos/modelos_de_utilidade/AGENTS.md +8 -0
  166. package/docs/modelos/modelos_de_utilidade/utility_templates.md +583 -0
  167. package/docs/modelos/visao_geral/AGENTS.md +8 -0
  168. package/docs/modelos/visao_geral/overview.md +163 -0
  169. package/docs/pagamentos/AGENTS.md +9 -0
  170. package/docs/pagamentos/pagamentos_na_india/AGENTS.md +19 -0
  171. package/docs/pagamentos/pagamentos_na_india/checkout_button_templates.md +1332 -0
  172. package/docs/pagamentos/pagamentos_na_india/enhanced_payment_links.md +93 -0
  173. package/docs/pagamentos/pagamentos_na_india/onboarding_apis.md +580 -0
  174. package/docs/pagamentos/pagamentos_na_india/orderdetailstemplate.md +205 -0
  175. package/docs/pagamentos/pagamentos_na_india/orderstatustemplate.md +143 -0
  176. package/docs/pagamentos/pagamentos_na_india/overview.md +102 -0
  177. package/docs/pagamentos/pagamentos_na_india/payment_links.md +581 -0
  178. package/docs/pagamentos/pagamentos_na_india/pg.md +1228 -0
  179. package/docs/pagamentos/pagamentos_na_india/upi_intent/AGENTS.md +12 -0
  180. package/docs/pagamentos/pagamentos_na_india/upi_intent/dynamic_vpa.md +572 -0
  181. package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_billdesk.md +343 -0
  182. package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_cashfree.md +145 -0
  183. package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_ccavenue.md +146 -0
  184. package/docs/pagamentos/pagamentos_na_india/upi_intent/upi_intent.md +660 -0
  185. package/docs/pagamentos/pagamentos_no_brasil/AGENTS.md +14 -0
  186. package/docs/pagamentos/pagamentos_no_brasil/boleto.md +104 -0
  187. package/docs/pagamentos/pagamentos_no_brasil/offsite_pix.md +128 -0
  188. package/docs/pagamentos/pagamentos_no_brasil/one_click_payments.md +226 -0
  189. package/docs/pagamentos/pagamentos_no_brasil/orderdetailstemplate.md +180 -0
  190. package/docs/pagamentos/pagamentos_no_brasil/orders.md +768 -0
  191. package/docs/pagamentos/pagamentos_no_brasil/overview.md +32 -0
  192. package/docs/pagamentos/pagamentos_no_brasil/payment_links.md +104 -0
  193. package/docs/parceiros/AGENTS.md +12 -0
  194. package/docs/parceiros/analise_do_app/AGENTS.md +8 -0
  195. package/docs/parceiros/analise_do_app/app_review.md +91 -0
  196. package/docs/parceiros/gerenciamento/AGENTS.md +14 -0
  197. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/AGENTS.md +15 -0
  198. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_accounts.md +274 -0
  199. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_system_users.md +106 -0
  200. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_webhooks.md +277 -0
  201. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/AGENTS.md +9 -0
  202. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/manage_phone_numbers.md +248 -0
  203. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/registering_phone_numbers.md +373 -0
  204. package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/share_and_revoke_credit_lines.md +551 -0
  205. package/docs/parceiros/gerenciamento/partner_led_business_verification.md +367 -0
  206. package/docs/parceiros/gerenciamento/pixel_tracking.md +35 -0
  207. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/AGENTS.md +18 -0
  208. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/adding_waba_to_mps.md +64 -0
  209. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/business_customer_support.md +102 -0
  210. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_embedded_signup.md +151 -0
  211. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_meta_business_suite.md +234 -0
  212. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_programmatically.md +292 -0
  213. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_via_embedded_signup.md +118 -0
  214. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solution_partners_via_embedded_signup.md +76 -0
  215. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_embedded_signup.md +90 -0
  216. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_meta_business_suite.md +265 -0
  217. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/support.md +48 -0
  218. package/docs/parceiros/gerenciamento/suporte_ao_parceiro/transferring_wabas_to_customers.md +8 -0
  219. package/docs/parceiros/integracao_de_clientes/AGENTS.md +9 -0
  220. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/AGENTS.md +26 -0
  221. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/app_only_install.md +135 -0
  222. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/automatic_events_api.md +204 -0
  223. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/bypass_phone_addition.md +52 -0
  224. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/custom_flows.md +40 -0
  225. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/default_flow.md +90 -0
  226. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/errors.md +185 -0
  227. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/hosted_es.md +153 -0
  228. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/implementation.md +417 -0
  229. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_business_app_users.md +926 -0
  230. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_solution_partner.md +402 -0
  231. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_tech_provider.md +332 -0
  232. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/overview.md +168 -0
  233. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_filled_data.md +524 -0
  234. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_verified_numbers.md +291 -0
  235. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/AGENTS.md +12 -0
  236. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_2_public_preview.md +88 -0
  237. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3.md +98 -0
  238. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3_public_preview.md +88 -0
  239. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_4.md +92 -0
  240. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/versions.md +463 -0
  241. package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/website_optional.md +57 -0
  242. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/AGENTS.md +11 -0
  243. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solution_embedded_creation.md +178 -0
  244. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solutions.md +775 -0
  245. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_solution_conversations.md +319 -0
  246. package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/partner_initiated_waba_creation.md +74 -0
  247. package/docs/parceiros/seja_um_parceiro/AGENTS.md +11 -0
  248. package/docs/parceiros/seja_um_parceiro/get_started_for_solution_partners.md +280 -0
  249. package/docs/parceiros/seja_um_parceiro/get_started_for_tech_providers.md +194 -0
  250. package/docs/parceiros/seja_um_parceiro/measurement_partners.md +146 -0
  251. package/docs/parceiros/seja_um_parceiro/upgrade_to_tech_partner.md +94 -0
  252. package/docs/parceiros/visao_geral/AGENTS.md +8 -0
  253. package/docs/parceiros/visao_geral/overview.md +190 -0
  254. package/docs/recado/AGENTS.md +9 -0
  255. package/docs/recado/precos/AGENTS.md +11 -0
  256. package/docs/recado/precos/pricing.md +915 -0
  257. package/docs/recado/precos/pricing_authentication_international_rates.md +464 -0
  258. package/docs/recado/precos/pricing_conversation_based_pricing.md +773 -0
  259. package/docs/recado/precos/pricing_updates_to_pricing.md +8 -0
  260. package/docs/recado/sobre_a_plataforma/AGENTS.md +10 -0
  261. package/docs/recado/sobre_a_plataforma/about_the_platform.md +217 -0
  262. package/docs/recado/sobre_a_plataforma/access_tokens.md +110 -0
  263. package/docs/recado/sobre_a_plataforma/permissions.md +55 -0
  264. package/docs/referencia/AGENTS.md +92 -0
  265. package/docs/referencia/bot_do_whatsapp_business/AGENTS.md +8 -0
  266. package/docs/referencia/bot_do_whatsapp_business/bot_details_api.md +762 -0
  267. package/docs/referencia/business/AGENTS.md +14 -0
  268. package/docs/referencia/business/add_phone_numbers_api.md +726 -0
  269. package/docs/referencia/business/client_whatsapp_business_accounts_api.md +1006 -0
  270. package/docs/referencia/business/owned_whatsapp_business_accounts.md +802 -0
  271. package/docs/referencia/business/whatsapp_business_accounts_api.md +1550 -0
  272. package/docs/referencia/business/whatsapp_business_partner_onboarding_to_mm_lite_api.md +783 -0
  273. package/docs/referencia/business/whatsapp_business_pre_verified_phone_number_sharing_api.md +790 -0
  274. package/docs/referencia/business/whatsapp_business_pre_verified_phone_numbers_api.md +886 -0
  275. package/docs/referencia/changelog.md +10 -0
  276. package/docs/referencia/conta_do_whatsapp_business/AGENTS.md +24 -0
  277. package/docs/referencia/conta_do_whatsapp_business/assigned_users_management_api.md +2202 -0
  278. package/docs/referencia/conta_do_whatsapp_business/business_account_api.md +267 -0
  279. package/docs/referencia/conta_do_whatsapp_business/business_account_extended_credits_api.md +275 -0
  280. package/docs/referencia/conta_do_whatsapp_business/conversational_automation_api.md +782 -0
  281. package/docs/referencia/conta_do_whatsapp_business/flows_api.md +1532 -0
  282. package/docs/referencia/conta_do_whatsapp_business/in_progress_on_behalf_requests_api.md +8 -0
  283. package/docs/referencia/conta_do_whatsapp_business/migration_intent_api.md +1581 -0
  284. package/docs/referencia/conta_do_whatsapp_business/obo_mobility_intent_api.md +8 -0
  285. package/docs/referencia/conta_do_whatsapp_business/phone_number_management_api.md +1686 -0
  286. package/docs/referencia/conta_do_whatsapp_business/schedules_api.md +1772 -0
  287. package/docs/referencia/conta_do_whatsapp_business/set_obo_mobility_intent_api.md +8 -0
  288. package/docs/referencia/conta_do_whatsapp_business/set_solution_migration_intent_api.md +8 -0
  289. package/docs/referencia/conta_do_whatsapp_business/subscribed_apps_api.md +2178 -0
  290. package/docs/referencia/conta_do_whatsapp_business/template_api.md +976 -0
  291. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_activities_api.md +842 -0
  292. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_api.md +1384 -0
  293. package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_solutions_list_api.md +854 -0
  294. package/docs/referencia/grupo/AGENTS.md +11 -0
  295. package/docs/referencia/grupo/groups_invite_link_api.md +304 -0
  296. package/docs/referencia/grupo/groups_join_requests_api.md +686 -0
  297. package/docs/referencia/grupo/groups_participants_api.md +274 -0
  298. package/docs/referencia/grupo/groups_query_api.md +436 -0
  299. package/docs/referencia/historico_de_mensagens/AGENTS.md +8 -0
  300. package/docs/referencia/historico_de_mensagens/whatsapp_business_message_history_events_api.md +866 -0
  301. package/docs/referencia/inscricao/AGENTS.md +10 -0
  302. package/docs/referencia/inscricao/application_connected_client_businesses.md +812 -0
  303. package/docs/referencia/inscricao/application_solutions_api.md +874 -0
  304. package/docs/referencia/inscricao/solution_creation_api.md +824 -0
  305. package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/AGENTS.md +8 -0
  306. package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/migration_intent_details_api.md +724 -0
  307. package/docs/referencia/midias/AGENTS.md +9 -0
  308. package/docs/referencia/midias/media_api.md +342 -0
  309. package/docs/referencia/midias/media_download_api.md +160 -0
  310. package/docs/referencia/numero_da_conta_do_whatsapp/AGENTS.md +8 -0
  311. package/docs/referencia/numero_da_conta_do_whatsapp/whatsapp_account_number_api.md +778 -0
  312. package/docs/referencia/perfil_do_whatsapp_business/AGENTS.md +8 -0
  313. package/docs/referencia/perfil_do_whatsapp_business/whatsapp_business_profile_node_api.md +1494 -0
  314. package/docs/referencia/solucao_do_whatsapp_business/AGENTS.md +14 -0
  315. package/docs/referencia/solucao_do_whatsapp_business/accept_deactivation_request_api.md +762 -0
  316. package/docs/referencia/solucao_do_whatsapp_business/access_token_api.md +704 -0
  317. package/docs/referencia/solucao_do_whatsapp_business/reject_deactivation_request_api.md +812 -0
  318. package/docs/referencia/solucao_do_whatsapp_business/send_deactivation_request_api.md +778 -0
  319. package/docs/referencia/solucao_do_whatsapp_business/solution_accept_api.md +812 -0
  320. package/docs/referencia/solucao_do_whatsapp_business/solution_details_api.md +768 -0
  321. package/docs/referencia/solucao_do_whatsapp_business/solution_reject_api.md +798 -0
  322. package/docs/referencia/telefone_do_whatsapp_business/AGENTS.md +29 -0
  323. package/docs/referencia/telefone_do_whatsapp_business/block_api.md +542 -0
  324. package/docs/referencia/telefone_do_whatsapp_business/business_compliance_information_api.md +1608 -0
  325. package/docs/referencia/telefone_do_whatsapp_business/business_encryption_api.md +1402 -0
  326. package/docs/referencia/telefone_do_whatsapp_business/calling_api.md +598 -0
  327. package/docs/referencia/telefone_do_whatsapp_business/encrypted_messages_api.md +482 -0
  328. package/docs/referencia/telefone_do_whatsapp_business/groups_management_api.md +485 -0
  329. package/docs/referencia/telefone_do_whatsapp_business/marketing_messages_lite_api.md +315 -0
  330. package/docs/referencia/telefone_do_whatsapp_business/media_upload_api.md +188 -0
  331. package/docs/referencia/telefone_do_whatsapp_business/message_api.md +1798 -0
  332. package/docs/referencia/telefone_do_whatsapp_business/phone_number_api.md +377 -0
  333. package/docs/referencia/telefone_do_whatsapp_business/phone_number_deregister_api.md +714 -0
  334. package/docs/referencia/telefone_do_whatsapp_business/phone_number_registration.md +780 -0
  335. package/docs/referencia/telefone_do_whatsapp_business/phone_number_verification_request_code_api.md +734 -0
  336. package/docs/referencia/telefone_do_whatsapp_business/register_api.md +411 -0
  337. package/docs/referencia/telefone_do_whatsapp_business/settings_api.md +674 -0
  338. package/docs/referencia/telefone_do_whatsapp_business/verify_code_api.md +746 -0
  339. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_message_history_api.md +932 -0
  340. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_official_business_account_status_api.md +1540 -0
  341. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_phone_number_api.md +1600 -0
  342. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_profile_api.md +1478 -0
  343. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_api.md +1179 -0
  344. package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_management_api.md +1315 -0
  345. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/AGENTS.md +11 -0
  346. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/request_verification_code_api.md +778 -0
  347. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/verify_code_api.md +768 -0
  348. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_api.md +1382 -0
  349. package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_partners_api.md +820 -0
  350. package/docs/referencia/usuario/AGENTS.md +8 -0
  351. package/docs/referencia/usuario/assigned_whatsapp_business_accounts_api.md +864 -0
  352. package/docs/referencia/webhooks/AGENTS.md +8 -0
  353. package/docs/referencia/webhooks/whatsapp_incoming_webhook_payload.md +1655 -0
  354. package/docs/suporte/AGENTS.md +13 -0
  355. package/docs/suporte/api_status_page.md +134 -0
  356. package/docs/suporte/error_codes.md +1194 -0
  357. package/docs/suporte/experiments.md +26 -0
  358. package/docs/suporte/health_status.md +225 -0
  359. package/docs/suporte/load_testing.md +340 -0
  360. package/docs/suporte/support.md +408 -0
  361. package/docs/visao_geral/AGENTS.md +8 -0
  362. package/docs/visao_geral/overview.md +2590 -0
  363. package/docs/webhooks/AGENTS.md +41 -0
  364. package/docs/webhooks/referencia/AGENTS.md +20 -0
  365. package/docs/webhooks/referencia/account_alerts.md +190 -0
  366. package/docs/webhooks/referencia/account_review_update.md +90 -0
  367. package/docs/webhooks/referencia/account_update.md +379 -0
  368. package/docs/webhooks/referencia/business_capability_update.md +121 -0
  369. package/docs/webhooks/referencia/history.md +302 -0
  370. package/docs/webhooks/referencia/message_template_components_update.md +179 -0
  371. package/docs/webhooks/referencia/message_template_quality_update.md +136 -0
  372. package/docs/webhooks/referencia/message_template_status_update.md +253 -0
  373. package/docs/webhooks/referencia/messages/AGENTS.md +24 -0
  374. package/docs/webhooks/referencia/messages/audio.md +298 -0
  375. package/docs/webhooks/referencia/messages/button.md +170 -0
  376. package/docs/webhooks/referencia/messages/contacts.md +491 -0
  377. package/docs/webhooks/referencia/messages/document.md +307 -0
  378. package/docs/webhooks/referencia/messages/errors.md +132 -0
  379. package/docs/webhooks/referencia/messages/image.md +304 -0
  380. package/docs/webhooks/referencia/messages/interactive.md +225 -0
  381. package/docs/webhooks/referencia/messages/location.md +296 -0
  382. package/docs/webhooks/referencia/messages/messages.md +44 -0
  383. package/docs/webhooks/referencia/messages/order.md +208 -0
  384. package/docs/webhooks/referencia/messages/reaction.md +178 -0
  385. package/docs/webhooks/referencia/messages/status.md +364 -0
  386. package/docs/webhooks/referencia/messages/sticker.md +298 -0
  387. package/docs/webhooks/referencia/messages/system.md +140 -0
  388. package/docs/webhooks/referencia/messages/text.md +322 -0
  389. package/docs/webhooks/referencia/messages/unsupported.md +165 -0
  390. package/docs/webhooks/referencia/messages/video.md +304 -0
  391. package/docs/webhooks/referencia/outros_webhooks/AGENTS.md +16 -0
  392. package/docs/webhooks/referencia/outros_webhooks/partner_solutions.md +114 -0
  393. package/docs/webhooks/referencia/outros_webhooks/payment_configuration_update.md +135 -0
  394. package/docs/webhooks/referencia/outros_webhooks/phone_number_name_update.md +129 -0
  395. package/docs/webhooks/referencia/outros_webhooks/phone_number_quality_update.md +172 -0
  396. package/docs/webhooks/referencia/outros_webhooks/security.md +108 -0
  397. package/docs/webhooks/referencia/outros_webhooks/smb_app_state_sync.md +146 -0
  398. package/docs/webhooks/referencia/outros_webhooks/smb_message_echoes.md +143 -0
  399. package/docs/webhooks/referencia/outros_webhooks/template_category_update.md +154 -0
  400. package/docs/webhooks/referencia/outros_webhooks/user_preferences.md +150 -0
  401. package/docs/webhooks/visao_geral/AGENTS.md +11 -0
  402. package/docs/webhooks/visao_geral/message_echoes.md +8 -0
  403. package/docs/webhooks/visao_geral/override.md +235 -0
  404. package/docs/webhooks/visao_geral/overview.md +158 -0
  405. package/docs/webhooks/visao_geral/set_up_whatsapp_echo_bot.md +109 -0
  406. package/package.json +50 -0
@@ -0,0 +1,858 @@
1
+ <!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/calling/business-initiated-calls -->
2
+ <!-- Scraped: 2025-12-20T17:40:45.821Z -->
3
+
4
+ # Ligações iniciadas pela empresa
5
+
6
+ Updated: 13 de nov de 2025
7
+
8
+ ## Visão geral
9
+
10
+ A API de ligações oferece suporte para realizar ligações a usuários do WhatsApp a partir da sua empresa.
11
+
12
+ O usuário determina quando as empresas podem receber ligações ao [conceder permissões de ligação ao número de telefone comercial](/documentation/business-messaging/whatsapp/calling/user-call-permissions).
13
+
14
+ ### Diagrama da sequência de ligações
15
+
16
+ ![Image](https://scontent-gru1-1.xx.fbcdn.net/v/t39.2365-6/561795972_1339317917926859_882777793042649890_n.jpg?_nc_cat=104&ccb=1-7&_nc_sid=e280be&_nc_ohc=QGXRLWxcDN0Q7kNvwGbUdnF&_nc_oc=AdnhEt1CiRxeV1cYwXmmb8yTUUb_Og2t0Y2L5ara8tEZn10QPkAdqXTWNa30PnehiGs&_nc_zt=14&_nc_ht=scontent-gru1-1.xx&_nc_gid=WZmQfVN2Pa5sF27N_--rOA&oh=00_AflD-LWDoRL6Fgk7p6al40XhKYWrRItiXhWu0JS6f5R3rQ&oe=6961314D) (_Clique com o botão direito do mouse na imagem e escolha "Abrir em uma nova aba" para ampliar a imagem_)
17
+
18
+ _Observação: o `ACCEPTED`geralmente, o webhook de status da ligação chega depois que a ligação é estabelecida. Ele é enviado principalmente para auditoria de eventos de ligação._
19
+
20
+ ## Pré-requisitos
21
+
22
+ Antes de começar a usar as ligações iniciadas pela empresa:
23
+
24
+ - [Assine](/documentation/business-messaging/whatsapp/webhooks/create-webhook-endpoint#configure-webhooks) o campo de webhook "ligações"- [As APIs de Ligações estão habilitadas para seu número de telefone comercial](/documentation/business-messaging/whatsapp/calling/call-settings)
25
+
26
+ Por fim, **antes de poder ligar para um usuário do WhatsApp, você deve obter a permissão dele para isso**.
27
+
28
+ [Saiba como obter as permissões de ligação de usuários do WhatsApp aqui](/documentation/business-messaging/whatsapp/calling/user-call-permissions)
29
+
30
+ ## Fluxo de ligação iniciada pela empresa
31
+
32
+ ### Parte 1: obter permissão para ligar ao usuário do WhatsApp
33
+
34
+ Existem duas maneiras de obter permissão para ligação do usuário do WhatsApp:
35
+
36
+ #### Envie uma mensagem de pedido de permissão para ligação
37
+
38
+ Para solicitar permissões de ligação, envie um pedido de permissão ao usuário do WhatsApp, seja como uma mensagem de formato livre durante uma janela aberta de atendimento ao cliente, seja usando uma mensagem de modelo que contenha o pedido.
39
+
40
+ - [Saiba como enviar uma solicitação de permissão para ligação de **formato livre**](/documentation/business-messaging/whatsapp/calling/user-call-permissions#how-to-send-a-free-form-call-permission-request-message)- [Aprenda a enviar um **modelo** de permissão para ligação](/documentation/business-messaging/whatsapp/calling/user-call-permissions#how-to-create-and-send-call-permission-request-template-messages)
41
+
42
+ #### Habilite `callback_permission_status` nas configurações de ligação
43
+
44
+ Quando `callback_permission_status` está habilitado, o usuário fornece automaticamente permissão para ligações à empresa.
45
+
46
+ [Saiba como habilitar o recurso `callback_permission_status`](/documentation/business-messaging/whatsapp/calling/call-settings#configure-update-business-phone-number-calling-settings)
47
+
48
+ #### O usuário do WhatsApp concede permissões permanentes
49
+
50
+ O usuário também pode conceder permissões permanentes para a empresa a qualquer momento por meio do próprio perfil comercial.
51
+
52
+ ### Parte 2: a empresa inicia uma nova ligação para o usuário do WhatsApp
53
+
54
+ Agora que você tem a permissão do usuário do WhatsApp, é possível iniciar uma nova ligação para ele.
55
+
56
+ Agora, você pode chamar o ponto de extremidade `POST <PHONE_NUMBER_ID>/calls` com o seguinte corpo de solicitação para iniciar uma nova ligação:
57
+
58
+ ```
59
+ POST <PHONE_NUMBER_ID>/calls
60
+ {
61
+ "messaging_product": "whatsapp",
62
+ "to":"12185552828", // The WhatsApp user's phone number (callee)
63
+ "action":"connect",
64
+ "session" : {
65
+ "sdp_type" : "offer",
66
+ "sdp" : "<<RFC 8866 SDP>>"
67
+ }
68
+ }
69
+ ```
70
+
71
+ Se não houver erros, você receberá uma resposta bem-sucedida:
72
+
73
+ ```
74
+ {
75
+ "messaging_product": "whatsapp",
76
+ "calls" : [
77
+ "id" : "wacid.HBgLMTIxODU1NTI4MjgVAgARGCAyODRQIAFRoA", // The WhatsApp call ID
78
+ ]
79
+ }
80
+ ```
81
+
82
+ _Observação: a resposta com o código de erro `138006` indica que o número comercial não tem permissão de pedido para ligação deste usuário do WhatsApp._
83
+
84
+ ### Parte 3: você estabelece a conexão da ligação usando o sinal do webhook
85
+
86
+ Após o início de uma nova ligação, você receberá uma resposta de webhook de conexão da ligação que contém um `SDP Answer` da API de Nuvem. Depois, a empresa aplicará o `SDP Answer` desse webhook à pilha WebRTC para iniciar a conexão de mídia.
87
+
88
+ ```
89
+ {
90
+ "entry": [
91
+ {
92
+ "changes": [
93
+ {
94
+ "field": "calls",
95
+ "value": {
96
+ "calls": [
97
+ {
98
+ "biz_opaque_callback_data": "TRx334DUDFTI4Mj", // Arbitrary string passed by business for tracking purposes
99
+ "session": {
100
+ "sdp_type": "answer",
101
+ "sdp": "<RFC 8866 SDP>"
102
+ },
103
+ "from": "13175551399", // The business phone number placing the call (caller)
104
+ "connection": {
105
+ "webrtc": {
106
+ "sdp": "<RFC 8866 SDP>"
107
+ }
108
+ },
109
+ "id": "wacid.HBgLMTIxODU1NTI4MjgVAgARGCAyODRQIAFRoA", // The WhatsApp call ID
110
+ "to": "12185552828", // The WhatsApp user's phone number (callee)
111
+ "event": "connect",
112
+ "timestamp": "1749196895",
113
+ "direction": "BUSINESS_INITIATED"
114
+ }
115
+ ],
116
+ "metadata": { // ID and display number for the business phone number placing the call (caller)
117
+ "phone_number_id": "436666719526789",
118
+ "display_phone_number": "13175551399"
119
+ },
120
+ "messaging_product": "whatsapp"
121
+ }
122
+ }
123
+ ],
124
+ "id": "366634483210360" // WhatsApp Business Account ID associated with the business phone number
125
+ }
126
+ ],
127
+ "object": "whatsapp_business_account"
128
+ },
129
+ ```
130
+
131
+ Depois, você receberá um webhook de status apropriado, indicando que a ligação é `RINGING`, `ACCEPTED` ou `REJECTED`:
132
+
133
+ ```
134
+ {
135
+ "entry": [
136
+ {
137
+ "changes": [
138
+ {
139
+ "field": "calls",
140
+ "value": {
141
+ "statuses": [
142
+ {
143
+ "id": "wacid.HBgLMTIxODU1NTI4MjgVAgARGCAyODRQIAFRoA", // The WhatsApp call ID
144
+ "type": "call",
145
+ "status": "[RINGING|ACCEPTED|REJECTED]", // The current call status
146
+ "timestamp": "1749197000",
147
+ "recipient_id": "12185552828" // The WhatsApp user's phone number (callee)
148
+ }
149
+ ],
150
+ "metadata": { // ID and display number for the business phone number placing the call (caller)
151
+ "phone_number_id": "436666719526789",
152
+ "display_phone_number": "13175551399"
153
+ },
154
+ "messaging_product": "whatsapp"
155
+ }
156
+ }
157
+ ],
158
+ "id": "366634483210360" // WhatsApp Business Account ID associated with the business phone number
159
+ }
160
+ ],
161
+ "object": "whatsapp_business_account"
162
+ }
163
+ ```
164
+
165
+ ### Parte 4: sua empresa ou o usuário do WhatsApp encerra a ligação
166
+
167
+ Você ou o usuário do WhatsApp podem encerrar a ligação a qualquer momento.
168
+
169
+ Chame o ponto de extremidade `POST <PHONE_NUMBER_ID>/calls` com o seguinte corpo de solicitação para encerrar uma nova ligação:
170
+
171
+ ```
172
+ POST <PHONE_NUMBER_ID>/calls
173
+ {
174
+ "messaging_product": "whatsapp",
175
+ "call_id": "wacid.HBgLMTIxODU1NTI4MjgVAgARGCAyODRQIAFRoA", // The WhatsApp call ID
176
+ "action" : "terminate"
177
+ }
178
+ ```
179
+
180
+ Se não houver erros, você receberá uma resposta bem-sucedida:
181
+
182
+ ```
183
+ {
184
+ "success" : true
185
+ }
186
+ ```
187
+
188
+ Quando a empresa ou o usuário do WhatsApp encerrar a ligação, você receberá um webhook de Encerramento de ligação:
189
+
190
+ ```
191
+ {
192
+ "object": "whatsapp_business_account",
193
+ "entry": [
194
+ {
195
+ "id": "366634483210360", // WhatsApp Business Account ID associated with the business phone number
196
+ "changes": [
197
+ {
198
+ "value": {
199
+ "messaging_product": "whatsapp",
200
+ "metadata": { // ID and display number for the business phone number placing the call (caller)
201
+ "phone_number_id": "436666719526789"
202
+ "display_phone_number": "13175551399",
203
+
204
+ },
205
+ "calls": [
206
+ {
207
+ "id": "wacid.HBgLMTIxODU1NTI4MjgVAgARGCAyODRQIAFRoA",
208
+ "to": "12185552828", // The WhatsApp user's phone number (callee)
209
+ "from": "13175551399", // The business phone number placing the call (caller)
210
+ "event": "terminate",
211
+ "direction": "BUSINESS_INITIATED",
212
+ "timestamp": "1749197480",
213
+ "status": ["Failed", "Completed"],
214
+ "start_time": "1671644824", // Call start UNIX timestamp
215
+ "end_time": "1671644944", // Call end UNIX timestamp
216
+ "duration": 480 // Call duration in seconds
217
+ }
218
+ ]
219
+ },
220
+ "field": "calls"
221
+ }
222
+ ]
223
+ }
224
+ ]
225
+ }
226
+ ```
227
+
228
+ ## Pontos de extremidade para ligações iniciadas pela empresa
229
+
230
+ ### Iniciar uma ligação
231
+
232
+ Use este ponto de extremidade para iniciar uma ligação para um usuário do WhatsApp. Para isso, basta fornecer um número de telefone e uma oferta de ligação WebRTC.
233
+
234
+ #### Sintaxe da solicitação
235
+
236
+ ```
237
+ POST <PHONE_NUMBER_ID>/calls
238
+ ```
239
+
240
+ Espaço reservado
241
+
242
+ Descrição
243
+
244
+ Exemplo de valor
245
+
246
+ `<PHONE_NUMBER_ID>`
247
+
248
+ _Número inteiro_
249
+
250
+ **Obrigatório**
251
+
252
+
253
+ O número de telefone comercial do qual você está iniciando uma nova ligação.
254
+
255
+ [Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers)
256
+
257
+ `+12784358810`
258
+
259
+ #### Corpo da solicitação
260
+
261
+ ```
262
+ {
263
+ "messaging_product": "whatsapp",
264
+ "to": "14085551234",
265
+ "action": "connect",
266
+ "session": {
267
+ "sdp_type": "offer",
268
+ "sdp": "<<RFC 8866 SDP>>"
269
+ },
270
+ "biz_opaque_callback_data": "0fS5cePMok"
271
+ }
272
+ ```
273
+
274
+ #### Parâmetros do corpo
275
+
276
+ Parâmetro
277
+
278
+ Descrição
279
+
280
+ Exemplo de valor
281
+
282
+ `to`
283
+
284
+ _Número inteiro_
285
+
286
+ **Obrigatório**
287
+
288
+
289
+ O número para o qual a ligação é feita (recebedor da ligação)
290
+
291
+ `“17863476655”`
292
+
293
+ `action`
294
+
295
+ _String_
296
+
297
+ **Obrigatório**
298
+
299
+
300
+ A ação sendo realizada na ligação em questão.
301
+
302
+ Os valores podem ser `connect` | `pre_accept` | `accept` | `reject` | `terminate`
303
+
304
+ `“connect”`
305
+
306
+ `session`
307
+
308
+ _Objeto JSON_
309
+
310
+ **Opcional**
311
+
312
+
313
+ Contém o tipo de protocolo de descrição de sessão (SDP) e a descrição do idioma.
314
+
315
+ Exige dois valores:
316
+
317
+ `sdp_type` – (_String_) **Obrigatório**
318
+
319
+ "oferta", para indicar a oferta de SDP
320
+
321
+ `sdp` – (_String_) **Obrigatório**
322
+
323
+ As informações do SDP do dispositivo do outro lado da ligação. O SDP deve estar em conformidade com o [RFC 8866](https://l.facebook.com/l.php?u=https%3A%2F%2Fdatatracker.ietf.org%2Fdoc%2Fhtml%2Frfc8866&h=AT3nQdKtq9X7DeoHbLDq3UbC77neT_Ww1AgG1Rd2Fo2VZDgvzdHZ4s2CY-D4nP45TZhKKGU6xDeTZKnxjeikdJh7ZfnqMvgYVpswtTLmN0rU-jI8eo-cjEB_D1IZ50VJLuh5vZBnffmC0tWkCZDqg2L9o4I).
324
+
325
+ [Saiba mais sobre o Protocolo de Descrição de Sessão (SDP)](https://l.facebook.com/l.php?u=https%3A%2F%2Fwww.rfc-editor.org%2Frfc%2Frfc8866.html&h=AT3nQdKtq9X7DeoHbLDq3UbC77neT_Ww1AgG1Rd2Fo2VZDgvzdHZ4s2CY-D4nP45TZhKKGU6xDeTZKnxjeikdJh7ZfnqMvgYVpswtTLmN0rU-jI8eo-cjEB_D1IZ50VJLuh5vZBnffmC0tWkCZDqg2L9o4I)
326
+
327
+ [Exemplo de estruturas SDP](/documentation/business-messaging/whatsapp/calling/reference#sdp-overview-and-sample-sdp-structures)
328
+
329
+ ```
330
+ "session" :
331
+ {
332
+ "sdp_type" : "offer",
333
+ "sdp" : "<<RFC 8866 SDP>>"
334
+ }
335
+ ```
336
+
337
+ `biz_opaque_callback_data`
338
+
339
+ _String_
340
+
341
+ **Opcional**
342
+
343
+
344
+ Uma string arbitrária que você pode incluir e que é útil para rastreamento e registro.
345
+
346
+ Qualquer app inscrito no campo de webhook "ligações" na sua conta do WhatsApp Business pode receber essa string, pois ela está incluída no objeto `calls` dentro da carga subsequente de [encerramento do webhook](/documentation/business-messaging/whatsapp/calling/business-initiated-calls#call-terminate-webhook).
347
+
348
+ A API de Nuvem não processa esse campo.
349
+
350
+ Máximo de 512 caracteres
351
+
352
+ `“0fS5cePMok”`
353
+
354
+ #### Resposta bem-sucedida
355
+
356
+ ```
357
+ {
358
+ "messaging_product": "whatsapp",
359
+ "calls" : [{
360
+ "id" : "wacid.ABGGFjFVU2AfAgo6V",
361
+ }]
362
+ }
363
+ ```
364
+
365
+ #### Resposta de erro
366
+
367
+ Veja os problemas que podem ocorrer:
368
+
369
+ - Inválido `phone-number-id`- Erros de permissão/autorização- Erros de validação de formato de solicitação, por exemplo, informações de conexão, sdp, ice- Erros de validação do SDP- Erros de restrição de ligações
370
+
371
+ [Consulte Códigos de erro e solução de problemas da API de Ligações para saber mais](/documentation/business-messaging/whatsapp/calling/troubleshooting)
372
+
373
+ [Veja os códigos de erro gerais da API de Nuvem aqui](/documentation/business-messaging/whatsapp/support/error-codes)
374
+
375
+
376
+
377
+ ### Encerrar ligação
378
+
379
+ Use este ponto de extremidade para encerrar uma ligação ativa.
380
+
381
+ Isso deve ser feito mesmo que exista um pacote `RTCP BYE` no caminho da mídia. Encerrar a ligação dessa forma também garante que o preço seja mais preciso.
382
+
383
+ Quando o usuário do WhatsApp encerrar a ligação, não será necessário chamar esse ponto de extremidade. Depois que a ligação for encerrada, você receberá um [Webhook de encerramento de ligação](/documentation/business-messaging/whatsapp/calling/business-initiated-calls#call-terminate-webhook).
384
+
385
+ #### Sintaxe da solicitação
386
+
387
+ ```
388
+ POST <PHONE_NUMBER_ID/calls
389
+ ```
390
+
391
+ Parâmetro
392
+
393
+ Descrição
394
+
395
+ Exemplo de valor
396
+
397
+ `<PHONE_NUMBER_ID>`
398
+
399
+ _Número inteiro_
400
+
401
+ **Obrigatório**
402
+
403
+
404
+ O número de telefone comercial do qual você está encerrando uma ligação.
405
+
406
+ [Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers)
407
+
408
+ `18274459827`
409
+
410
+ #### Corpo da solicitação
411
+
412
+ ```
413
+ {
414
+ "messaging_product": "whatsapp",
415
+ "call_id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
416
+ "action": "terminate"
417
+ }
418
+ ```
419
+
420
+ #### Parâmetros do corpo
421
+
422
+ Parâmetro
423
+
424
+ Descrição
425
+
426
+ Exemplo de valor
427
+
428
+ `call_id`
429
+
430
+ _String_
431
+
432
+ **Obrigatório**
433
+
434
+
435
+ O ID da ligação telefônica.
436
+
437
+ Para ligações recebidas, você obtém uma identificação de ligação do [webhook de conexão de ligação](/documentation/business-messaging/whatsapp/calling/business-initiated-calls#call-connect-webhook) quando um usuário do WhatsApp inicia a ligação.
438
+
439
+ `“wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh”`
440
+
441
+ `action`
442
+
443
+ _String_
444
+
445
+ **Obrigatório**
446
+
447
+
448
+ A ação sendo realizada na ligação em questão.
449
+
450
+ Os valores podem ser `connect` | `pre_accept` | `accept` | `reject` | `terminate`
451
+
452
+ `“terminate”`
453
+
454
+ #### Resposta bem-sucedida
455
+
456
+ ```
457
+ {
458
+ "messaging_product": "whatsapp",
459
+ "success" : true
460
+ }
461
+ ```
462
+
463
+ #### Resposta de erro
464
+
465
+ Veja os problemas que podem ocorrer:
466
+
467
+ - `call-id` inválida- `phone-number-id` inválida- O usuário do WhatsApp já encerrou a ligação- A rejeição da ligação já está em andamento- Erros de permissão/autorização
468
+
469
+ [Consulte Códigos de erro e solução de problemas da API de Ligações para saber mais](/documentation/business-messaging/whatsapp/calling/troubleshooting)
470
+
471
+ [Veja os códigos de erro gerais da API de Nuvem aqui](/documentation/business-messaging/whatsapp/support/error-codes)
472
+
473
+ ## Webhooks para ligações iniciadas pela empresa
474
+
475
+ Em todos os webhooks da API de Ligações, existe um objeto `”calls”` dentro do objeto `”value”` da resposta do webhook. O objeto `”calls”` contém metadados sobre a ligação, usados para ações em cada ligação feita ou recebida pela empresa.
476
+
477
+ Para receber webhooks da API de Ligações, assine o campo de webhook "ligações".
478
+
479
+ [Saiba mais sobre webhooks da API de Nuvem aqui](/documentation/business-messaging/whatsapp/webhooks/reference/messages/status)
480
+
481
+ ### Chamar webhook de conexão
482
+
483
+ Uma notificação de webhook é enviada quase em tempo real quando uma ligação iniciada pela empresa está pronta para ser conectada ao usuário do WhatsApp (uma `SDP Answer`).
484
+
485
+ É importante destacar que o webhook contém informações necessárias para estabelecer uma conexão de chamada por meio do WebRTC.
486
+
487
+ Depois de receber o webhook de conexão de ligação, você pode aplicar a `SDP Answer` recebida no webhook à pilha de WebRTC para iniciar a conexão de mídia.
488
+
489
+ ```
490
+ {
491
+ "object": "whatsapp_business_account",
492
+ "entry": [
493
+ {
494
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
495
+ "changes": [
496
+ {
497
+ "value": {
498
+ "messaging_product": "whatsapp",
499
+ "metadata": {
500
+ "display_phone_number": "16315553601",
501
+ "phone_number_id": "<PHONE_NUMBER_ID>"
502
+ },
503
+ "contacts": [
504
+ {
505
+ "profile": {
506
+ "name": "<CALLEE_NAME>"
507
+ },
508
+ "wa_id": "16315553602"
509
+ }
510
+ ],
511
+ "calls": [
512
+ {
513
+ "id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
514
+ "to": "16315553601",
515
+ "from": "16315553602",
516
+ "event": "connect",
517
+ "timestamp": "1671644824",
518
+ "direction": "BUSINESS_INITIATED",
519
+ "session": {
520
+ "sdp_type": "answer",
521
+ "sdp": "<<RFC 8866 SDP>>"
522
+ }
523
+ }
524
+ ]
525
+ },
526
+ "field": "calls"
527
+ }
528
+ ]
529
+ }
530
+ ]
531
+ }
532
+ ```
533
+
534
+ #### Valores de webhook para `"calls"`
535
+
536
+ Espaço reservado
537
+
538
+ Descrição
539
+
540
+ `id`
541
+
542
+ _String_
543
+
544
+ Uma identificação única para a ligação
545
+
546
+ `to`
547
+
548
+ _Número inteiro_
549
+
550
+ O número que está sendo chamado (recebedor da chamada)
551
+
552
+ `from`
553
+
554
+ _Número inteiro_
555
+
556
+ O número de telefone da pessoa realizando a ligação
557
+
558
+ `event`
559
+
560
+ _Número inteiro_
561
+
562
+ Evento de ligação sobre o qual esse webhook está notificando o assinante
563
+
564
+ `timestamp`
565
+
566
+ _Número inteiro_
567
+
568
+ O registro de data e hora UNIX do evento de webhook
569
+
570
+ `direction`
571
+
572
+ _String_
573
+
574
+ A direção da ligação que está sendo feita.
575
+
576
+ Pode conter:
577
+
578
+ `BUSINESS_INITIATED`, para ligações iniciadas pela empresa.
579
+
580
+ `USER_INITIATED`, para ligações iniciadas por um usuário do WhatsApp.
581
+
582
+ `session`
583
+
584
+ _Objeto JSON_
585
+
586
+ **Opcional**
587
+
588
+
589
+ Contém o tipo de protocolo de descrição de sessão (SDP) e a descrição do idioma.
590
+
591
+ Exige dois valores:
592
+
593
+ `sdp_type` – (_String_) **Obrigatório**
594
+
595
+ "oferta", para indicar a oferta de SDP
596
+
597
+ `sdp` – (_String_) **Obrigatório**
598
+
599
+ As informações do SDP do dispositivo do outro lado da ligação. O SDP deve estar em conformidade com o [RFC 8866](https://l.facebook.com/l.php?u=https%3A%2F%2Fdatatracker.ietf.org%2Fdoc%2Fhtml%2Frfc8866&h=AT3nQdKtq9X7DeoHbLDq3UbC77neT_Ww1AgG1Rd2Fo2VZDgvzdHZ4s2CY-D4nP45TZhKKGU6xDeTZKnxjeikdJh7ZfnqMvgYVpswtTLmN0rU-jI8eo-cjEB_D1IZ50VJLuh5vZBnffmC0tWkCZDqg2L9o4I).
600
+
601
+ [Saiba mais sobre o Protocolo de Descrição de Sessão (SDP)](https://l.facebook.com/l.php?u=https%3A%2F%2Fwww.rfc-editor.org%2Frfc%2Frfc8866.html&h=AT3nQdKtq9X7DeoHbLDq3UbC77neT_Ww1AgG1Rd2Fo2VZDgvzdHZ4s2CY-D4nP45TZhKKGU6xDeTZKnxjeikdJh7ZfnqMvgYVpswtTLmN0rU-jI8eo-cjEB_D1IZ50VJLuh5vZBnffmC0tWkCZDqg2L9o4I)
602
+
603
+ [Exemplo de estruturas SDP](/documentation/business-messaging/whatsapp/calling/reference#sdp-overview-and-sample-sdp-structures)
604
+
605
+ `contacts`
606
+
607
+ _Objeto JSON_
608
+
609
+ As informações de perfil do usuário que recebe a ligação.
610
+
611
+ Contém dois valores:
612
+
613
+ `name` – o nome do perfil do WhatsApp do destinatário da ligação.
614
+
615
+ `wa_id` – a identificação do WhatsApp do destinatário da ligação.
616
+
617
+
618
+
619
+ ### Webhook de status da ligação
620
+
621
+ Esse webhook é enviado durante os seguintes eventos de ligações:
622
+
623
+ - Chamando: quando o dispositivo do usuário do WhatsApp começa a tocar- Aceita: quando o usuário do WhatsApp aceita a ligação- Rejeitada: quando a ligação é rejeitada pelo usuário do WhatsApp. Nesse caso, você também receberá o webhook de encerramento da ligação
624
+
625
+ A estrutura de webhook aqui é semelhante aos webhooks de status usados para as mensagens da API de Nuvem.
626
+
627
+ ```
628
+ {
629
+ "object": "whatsapp_business_account",
630
+ "entry": [
631
+ {
632
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
633
+ "changes": [
634
+ {
635
+ "value": {
636
+ "messaging_product": "whatsapp",
637
+ "metadata": {
638
+ "display_phone_number": "16315553601",
639
+ "phone_number_id": "<PHONE_NUMBER_ID>",
640
+ },
641
+ "statuses": [{
642
+ "id": "wacid.ABGGFjFVU2AfAgo6V",
643
+ "timestamp": "1671644824",
644
+ "type": "call"
645
+ "status": "[RINGING|ACCEPTED|REJECTED]",
646
+ "recipient_id": "163155536021",
647
+ "biz_opaque_callback_data": "random_string",
648
+ }]
649
+ },
650
+ "field": "calls"
651
+ }
652
+ ]
653
+ }
654
+ ]
655
+ }
656
+ ```
657
+
658
+ [_Saiba mais sobre webhooks de status da API de Nuvem_](/documentation/business-messaging/whatsapp/webhooks/reference/messages/status)
659
+
660
+ #### Valores de webhook para `"statuses"`
661
+
662
+ Espaço reservado
663
+
664
+ Descrição
665
+
666
+ `id`
667
+
668
+ _String_
669
+
670
+ Uma identificação única para a ligação
671
+
672
+ `timestamp`
673
+
674
+ _Número inteiro_
675
+
676
+ O registro de data e hora Unix do evento de webhook
677
+
678
+ `recipient_id`
679
+
680
+ _Número inteiro_
681
+
682
+ O número de telefone do usuário do WhatsApp que está recebendo a ligação
683
+
684
+ `status`
685
+
686
+ _Número inteiro_
687
+
688
+ O status atual da ligação.
689
+
690
+ Valores possíveis:
691
+
692
+ `RINGING`: o usuário está recebendo uma ligação da empresa
693
+
694
+ `ACCEPTED`: a ligação iniciada pela empresa é aceita pelo usuário
695
+
696
+ `REJECTED`: a ligação iniciada pela empresa é rejeitada pelo usuário
697
+
698
+ `biz_opaque_callback_date`
699
+
700
+ _String_
701
+
702
+ Uma string arbitrária que a empresa inclui na ligação para rastreamento e registro.
703
+
704
+ Só será retornado se fornecido por meio de solicitações à [API de Iniciação de Nova Ligação](/documentation/business-messaging/whatsapp/calling/business-initiated-calls#initiate-a-new-call)
705
+
706
+
707
+
708
+ ### Webhook de encerramento de ligação
709
+
710
+ Uma notificação de webhook é enviada sempre que a ligação é encerrada por qualquer motivo, como quando o usuário do WhatsApp desliga ou quando a empresa faz uma chamada ao ponto de extremidade `POST /<PHONE_NUMBER_ID>/calls` com uma ação de `terminate` ou `reject`.
711
+
712
+ ```
713
+ {
714
+ "object": "whatsapp_business_account",
715
+ "entry": [
716
+ {
717
+ "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
718
+ "changes": [
719
+ {
720
+ "value": {
721
+ "messaging_product": "whatsapp",
722
+ "metadata": {
723
+ "display_phone_number": "16505553602",
724
+ "phone_number_id": "<PHONE_NUMBER_ID>",
725
+ },
726
+ "calls": [
727
+ {
728
+ "id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
729
+ "to": "16315553601",
730
+ "from": "16315553602",
731
+ "event": "terminate"
732
+ "direction": "BUSINESS_INITIATED",
733
+ "biz_opaque_callback_data": "random_string",
734
+ "timestamp": "1671644824",
735
+ "status" : [FAILED | COMPLETED],
736
+ "start_time" : "1671644824",
737
+ "end_time" : "1671644944",
738
+ "duration" : 120
739
+ }
740
+ ],
741
+ "errors": [
742
+ {
743
+ "code": INT_CODE,
744
+ "message": "ERROR_TITLE",
745
+ "href": "ERROR_HREF",
746
+ "error_data": {
747
+ "details": "ERROR_DETAILS"
748
+ }
749
+ }
750
+ ]
751
+ },
752
+ "field": "calls"
753
+ }
754
+ ]
755
+ }
756
+ ]
757
+ }
758
+ ```
759
+
760
+ #### Valores de webhook para `"calls"`
761
+
762
+ Espaço reservado
763
+
764
+ Descrição
765
+
766
+ `id`
767
+
768
+ _String_
769
+
770
+ Uma identificação única para a ligação
771
+
772
+ `to`
773
+
774
+ _Número inteiro_
775
+
776
+ O número que está sendo chamado (recebedor da chamada)
777
+
778
+ `from`
779
+
780
+ _Número inteiro_
781
+
782
+ O número de telefone da pessoa realizando a ligação
783
+
784
+ `event`
785
+
786
+ _Número inteiro_
787
+
788
+ Evento de ligação sobre o qual esse webhook está notificando o assinante
789
+
790
+ `timestamp`
791
+
792
+ _Número inteiro_
793
+
794
+ O registro de data e hora UNIX do evento de webhook
795
+
796
+ `direction`
797
+
798
+ _String_
799
+
800
+ A direção da ligação que está sendo feita.
801
+
802
+ Pode conter:
803
+
804
+ `BUSINESS_INITIATED`, para ligações iniciadas pela empresa.
805
+
806
+ `USER_INITIATED`, para ligações iniciadas por um usuário do WhatsApp.
807
+
808
+ `start_time`
809
+
810
+ _Número inteiro_
811
+
812
+ O registro de data e hora Unix do início da ligação.
813
+
814
+ Presente apenas quando a ligação foi atendida pela outra parte.
815
+
816
+ `end_time`
817
+
818
+ _Número inteiro_
819
+
820
+ O registro de data e hora Unix do término da ligação.
821
+
822
+ Presente apenas quando a ligação foi atendida pela outra parte.
823
+
824
+ `duration`
825
+
826
+ _Número inteiro_
827
+
828
+ Duração da ligação em segundos.
829
+
830
+ Apenas quando a chamada foi atendida pela outra parte.
831
+
832
+ `biz_opaque_callback_date`
833
+
834
+ _String_
835
+
836
+ Uma string arbitrária que a empresa inclui na ligação para rastreamento e registro.
837
+
838
+ Só será retornado se fornecido por meio de uma [solicitação à API de Início de Ligação](/documentation/business-messaging/whatsapp/calling/business-initiated-calls#initiate-call) ou [solicitação de Aceitação de Ligação](/documentation/business-messaging/whatsapp/calling/reference#accept-call)
839
+
840
+ `errors.code`
841
+
842
+ _Número inteiro_
843
+
844
+ O objeto `errors` é exibido apenas em ligações com falha quando há informações de erro disponíveis. O código é um dos [códigos de erro de ligação](/documentation/business-messaging/whatsapp/calling/troubleshooting#calling-error-codes)
845
+
846
+ ## Visão geral e exemplos de estruturas SDP
847
+
848
+ O Protocolo de Descrição de Sessão (SDP) é um formato baseado em texto usado para descrever as características das sessões multimídia, como ligações de voz e de vídeo, em apps de comunicação em tempo real. O SDP fornece uma maneira padronizada de transmitir informações sobre os fluxos de mídia da sessão, incluindo o tipo de mídia, codecs, protocolos e outros parâmetros necessários para estabelecer e gerenciar a sessão.
849
+
850
+ No contexto do WebRTC, o SDP é usado para negociar os parâmetros de mídia entre remetente e destinatário, permitindo que eles cheguem a um acordo sobre os detalhes da troca de mídia.
851
+
852
+ [Ver exemplos de estruturas SDP para ligações iniciadas pela empresa](/documentation/business-messaging/whatsapp/calling/reference#sdp-overview-and-sample-sdp-structures)
853
+
854
+ Você achou esta página útil?
855
+
856
+ ![Ícone de polegar para cima](https://static.xx.fbcdn.net/rsrc.php/yR/r/OEXJ0_DJeZv.svg)
857
+
858
+ ![Ícone de polegar para baixo](https://static.xx.fbcdn.net/rsrc.php/yb/r/qKPgNVNeatU.svg)