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.
- package/LICENSE +22 -0
- package/README.md +181 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +65 -0
- package/dist/index.js.map +1 -0
- package/dist/prompts.d.ts +22 -0
- package/dist/prompts.d.ts.map +1 -0
- package/dist/prompts.js +305 -0
- package/dist/prompts.js.map +1 -0
- package/dist/resources.d.ts +24 -0
- package/dist/resources.d.ts.map +1 -0
- package/dist/resources.js +132 -0
- package/dist/resources.js.map +1 -0
- package/dist/tools.d.ts +6 -0
- package/dist/tools.d.ts.map +1 -0
- package/dist/tools.js +379 -0
- package/dist/tools.js.map +1 -0
- package/dist/utils/fileLoader.d.ts +19 -0
- package/dist/utils/fileLoader.d.ts.map +1 -0
- package/dist/utils/fileLoader.js +126 -0
- package/dist/utils/fileLoader.js.map +1 -0
- package/dist/utils/search.d.ts +27 -0
- package/dist/utils/search.d.ts.map +1 -0
- package/dist/utils/search.js +91 -0
- package/dist/utils/search.js.map +1 -0
- package/docs/QUICK_REFERENCE.md +223 -0
- package/docs/anuncios_com_clique_para_whatsapp/AGENTS.md +8 -0
- package/docs/anuncios_com_clique_para_whatsapp/welcome_message_sequences.md +449 -0
- package/docs/ativos_da_conta/AGENTS.md +9 -0
- package/docs/ativos_da_conta/outros_ativos/AGENTS.md +12 -0
- package/docs/ativos_da_conta/outros_ativos/business_profiles.md +137 -0
- package/docs/ativos_da_conta/outros_ativos/display_names.md +108 -0
- package/docs/ativos_da_conta/outros_ativos/official_business_accounts.md +123 -0
- package/docs/ativos_da_conta/outros_ativos/qr_codes.md +198 -0
- package/docs/ativos_da_conta/outros_ativos/whatsapp_business_accounts.md +99 -0
- package/docs/ativos_da_conta/telefones_comerciais/AGENTS.md +11 -0
- package/docs/ativos_da_conta/telefones_comerciais/conversational_components.md +347 -0
- package/docs/ativos_da_conta/telefones_comerciais/phone_numbers.md +486 -0
- package/docs/ativos_da_conta/telefones_comerciais/registration.md +171 -0
- package/docs/ativos_da_conta/telefones_comerciais/two_step_verification.md +66 -0
- package/docs/catalogos/AGENTS.md +12 -0
- package/docs/catalogos/receive_responses.md +28 -0
- package/docs/catalogos/sell_products_and_services.md +24 -0
- package/docs/catalogos/set_commerce_settings.md +163 -0
- package/docs/catalogos/share_products.md +401 -0
- package/docs/catalogos/upload_inventory.md +28 -0
- package/docs/comecar/AGENTS.md +8 -0
- package/docs/comecar/get_started.md +127 -0
- package/docs/dados_privacidade_e_politica/AGENTS.md +16 -0
- package/docs/dados_privacidade_e_politica/block_users.md +549 -0
- package/docs/dados_privacidade_e_politica/data_privacy_and_security.md +78 -0
- package/docs/dados_privacidade_e_politica/encryption.md +8 -0
- package/docs/dados_privacidade_e_politica/getting_opt_in.md +41 -0
- package/docs/dados_privacidade_e_politica/identity_change.md +34 -0
- package/docs/dados_privacidade_e_politica/local_storage.md +277 -0
- package/docs/dados_privacidade_e_politica/no_storage.md +132 -0
- package/docs/dados_privacidade_e_politica/policy_enforcement.md +85 -0
- package/docs/dados_privacidade_e_politica/policy_enforcement_violations.md +127 -0
- package/docs/grupos/AGENTS.md +15 -0
- package/docs/grupos/error_codes.md +170 -0
- package/docs/grupos/faq.md +30 -0
- package/docs/grupos/get_started.md +73 -0
- package/docs/grupos/groups.md +75 -0
- package/docs/grupos/groups_messaging.md +340 -0
- package/docs/grupos/pricing.md +322 -0
- package/docs/grupos/reference.md +1059 -0
- package/docs/grupos/webhooks.md +298 -0
- package/docs/index.md +318 -0
- package/docs/insights/AGENTS.md +8 -0
- package/docs/insights/analytics.md +944 -0
- package/docs/ligacoes/AGENTS.md +20 -0
- package/docs/ligacoes/app_review_guidelines.md +48 -0
- package/docs/ligacoes/business_initiated_calls.md +858 -0
- package/docs/ligacoes/call_button_messages_deep_links.md +454 -0
- package/docs/ligacoes/call_settings.md +643 -0
- package/docs/ligacoes/calling.md +130 -0
- package/docs/ligacoes/faq.md +468 -0
- package/docs/ligacoes/integration_patterns.md +121 -0
- package/docs/ligacoes/pricing.md +339 -0
- package/docs/ligacoes/reference.md +1923 -0
- package/docs/ligacoes/sip.md +1090 -0
- package/docs/ligacoes/troubleshooting.md +483 -0
- package/docs/ligacoes/user_call_permissions.md +672 -0
- package/docs/ligacoes/user_initiated_calls.md +1030 -0
- package/docs/mensagens/AGENTS.md +46 -0
- package/docs/mensagens/limites_de_mensagens/AGENTS.md +9 -0
- package/docs/mensagens/limites_de_mensagens/messaging_limits.md +91 -0
- package/docs/mensagens/limites_de_mensagens/upcoming_changes.md +8 -0
- package/docs/mensagens/recursos_adicionais/AGENTS.md +13 -0
- package/docs/mensagens/recursos_adicionais/contextual_replies.md +82 -0
- package/docs/mensagens/recursos_adicionais/link_previews.md +58 -0
- package/docs/mensagens/recursos_adicionais/mark_message_as_read.md +111 -0
- package/docs/mensagens/recursos_adicionais/media.md +419 -0
- package/docs/mensagens/recursos_adicionais/payload_encryption.md +8 -0
- package/docs/mensagens/recursos_adicionais/typing_indicators.md +117 -0
- package/docs/mensagens/tipos_de_mensagens/AGENTS.md +24 -0
- package/docs/mensagens/tipos_de_mensagens/address_messages.md +465 -0
- package/docs/mensagens/tipos_de_mensagens/audio_messages.md +211 -0
- package/docs/mensagens/tipos_de_mensagens/contacts_messages.md +482 -0
- package/docs/mensagens/tipos_de_mensagens/document_messages.md +232 -0
- package/docs/mensagens/tipos_de_mensagens/image_messages.md +176 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_cta_url_messages.md +240 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_flow_messages.md +8 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_list_messages.md +300 -0
- package/docs/mensagens/tipos_de_mensagens/interactive_reply_buttons_messages.md +271 -0
- package/docs/mensagens/tipos_de_mensagens/location_messages.md +156 -0
- package/docs/mensagens/tipos_de_mensagens/location_request_messages.md +310 -0
- package/docs/mensagens/tipos_de_mensagens/message_with_link.md +8 -0
- package/docs/mensagens/tipos_de_mensagens/reaction_messages.md +144 -0
- package/docs/mensagens/tipos_de_mensagens/sticker_messages.md +157 -0
- package/docs/mensagens/tipos_de_mensagens/template_messages.md +20 -0
- package/docs/mensagens/tipos_de_mensagens/text_messages.md +142 -0
- package/docs/mensagens/tipos_de_mensagens/video_messages.md +149 -0
- package/docs/mensagens/visao_geral/AGENTS.md +8 -0
- package/docs/mensagens/visao_geral/send_messages.md +370 -0
- package/docs/mensagens_de_marketing/AGENTS.md +10 -0
- package/docs/mensagens_de_marketing/implementacao/AGENTS.md +10 -0
- package/docs/mensagens_de_marketing/implementacao/get_started.md +107 -0
- package/docs/mensagens_de_marketing/implementacao/onboard_business_customers.md +180 -0
- package/docs/mensagens_de_marketing/implementacao/send_marketing_messages.md +260 -0
- package/docs/mensagens_de_marketing/recursos/AGENTS.md +12 -0
- package/docs/mensagens_de_marketing/recursos/automatic_creative_optimization.md +8 -0
- package/docs/mensagens_de_marketing/recursos/conversion_measurement.md +8 -0
- package/docs/mensagens_de_marketing/recursos/deep_links.md +302 -0
- package/docs/mensagens_de_marketing/recursos/track_click_events.md +119 -0
- package/docs/mensagens_de_marketing/recursos/view_metrics.md +338 -0
- package/docs/mensagens_de_marketing/visao_geral/AGENTS.md +8 -0
- package/docs/mensagens_de_marketing/visao_geral/overview.md +26 -0
- package/docs/modelos/AGENTS.md +12 -0
- package/docs/modelos/gerenciamento_de_modelos/AGENTS.md +21 -0
- package/docs/modelos/gerenciamento_de_modelos/components.md +717 -0
- package/docs/modelos/gerenciamento_de_modelos/supported_languages.md +462 -0
- package/docs/modelos/gerenciamento_de_modelos/tap_target_url_title_override.md +211 -0
- package/docs/modelos/gerenciamento_de_modelos/template_categorization.md +499 -0
- package/docs/modelos/gerenciamento_de_modelos/template_comparison.md +136 -0
- package/docs/modelos/gerenciamento_de_modelos/template_library.md +526 -0
- package/docs/modelos/gerenciamento_de_modelos/template_management.md +148 -0
- package/docs/modelos/gerenciamento_de_modelos/template_media.md +8 -0
- package/docs/modelos/gerenciamento_de_modelos/template_migration.md +164 -0
- package/docs/modelos/gerenciamento_de_modelos/template_pacing.md +38 -0
- package/docs/modelos/gerenciamento_de_modelos/template_pausing.md +58 -0
- package/docs/modelos/gerenciamento_de_modelos/template_quality.md +47 -0
- package/docs/modelos/gerenciamento_de_modelos/template_review.md +74 -0
- package/docs/modelos/gerenciamento_de_modelos/time_to_live.md +88 -0
- package/docs/modelos/modelos_de_autenticacao/AGENTS.md +13 -0
- package/docs/modelos/modelos_de_autenticacao/authentication_best_practices.md +73 -0
- package/docs/modelos/modelos_de_autenticacao/authentication_templates.md +252 -0
- package/docs/modelos/modelos_de_autenticacao/autofill_button_authentication_templates.md +732 -0
- package/docs/modelos/modelos_de_autenticacao/copy_code_button_authentication_templates.md +402 -0
- package/docs/modelos/modelos_de_autenticacao/error_signals.md +143 -0
- package/docs/modelos/modelos_de_autenticacao/zero_tap_authentication_templates.md +742 -0
- package/docs/modelos/modelos_de_marketing/AGENTS.md +18 -0
- package/docs/modelos/modelos_de_marketing/call_permission_request_message_template.md +221 -0
- package/docs/modelos/modelos_de_marketing/catalog_templates.md +308 -0
- package/docs/modelos/modelos_de_marketing/coupon_templates.md +425 -0
- package/docs/modelos/modelos_de_marketing/custom_marketing_templates.md +537 -0
- package/docs/modelos/modelos_de_marketing/limited_time_offer_templates.md +496 -0
- package/docs/modelos/modelos_de_marketing/marketing_templates.md +112 -0
- package/docs/modelos/modelos_de_marketing/media_card_carousel_templates.md +770 -0
- package/docs/modelos/modelos_de_marketing/mpm_templates.md +717 -0
- package/docs/modelos/modelos_de_marketing/per_user_limits.md +42 -0
- package/docs/modelos/modelos_de_marketing/product_card_carousel_templates.md +515 -0
- package/docs/modelos/modelos_de_marketing/spm_templates.md +466 -0
- package/docs/modelos/modelos_de_utilidade/AGENTS.md +8 -0
- package/docs/modelos/modelos_de_utilidade/utility_templates.md +583 -0
- package/docs/modelos/visao_geral/AGENTS.md +8 -0
- package/docs/modelos/visao_geral/overview.md +163 -0
- package/docs/pagamentos/AGENTS.md +9 -0
- package/docs/pagamentos/pagamentos_na_india/AGENTS.md +19 -0
- package/docs/pagamentos/pagamentos_na_india/checkout_button_templates.md +1332 -0
- package/docs/pagamentos/pagamentos_na_india/enhanced_payment_links.md +93 -0
- package/docs/pagamentos/pagamentos_na_india/onboarding_apis.md +580 -0
- package/docs/pagamentos/pagamentos_na_india/orderdetailstemplate.md +205 -0
- package/docs/pagamentos/pagamentos_na_india/orderstatustemplate.md +143 -0
- package/docs/pagamentos/pagamentos_na_india/overview.md +102 -0
- package/docs/pagamentos/pagamentos_na_india/payment_links.md +581 -0
- package/docs/pagamentos/pagamentos_na_india/pg.md +1228 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/AGENTS.md +12 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/dynamic_vpa.md +572 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_billdesk.md +343 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_cashfree.md +145 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/pg_guide_ccavenue.md +146 -0
- package/docs/pagamentos/pagamentos_na_india/upi_intent/upi_intent.md +660 -0
- package/docs/pagamentos/pagamentos_no_brasil/AGENTS.md +14 -0
- package/docs/pagamentos/pagamentos_no_brasil/boleto.md +104 -0
- package/docs/pagamentos/pagamentos_no_brasil/offsite_pix.md +128 -0
- package/docs/pagamentos/pagamentos_no_brasil/one_click_payments.md +226 -0
- package/docs/pagamentos/pagamentos_no_brasil/orderdetailstemplate.md +180 -0
- package/docs/pagamentos/pagamentos_no_brasil/orders.md +768 -0
- package/docs/pagamentos/pagamentos_no_brasil/overview.md +32 -0
- package/docs/pagamentos/pagamentos_no_brasil/payment_links.md +104 -0
- package/docs/parceiros/AGENTS.md +12 -0
- package/docs/parceiros/analise_do_app/AGENTS.md +8 -0
- package/docs/parceiros/analise_do_app/app_review.md +91 -0
- package/docs/parceiros/gerenciamento/AGENTS.md +14 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/AGENTS.md +15 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_accounts.md +274 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_system_users.md +106 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/manage_webhooks.md +277 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/AGENTS.md +9 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/manage_phone_numbers.md +248 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/numeros_de_telefone/registering_phone_numbers.md +373 -0
- package/docs/parceiros/gerenciamento/gerenciar_ativos_do_cliente/share_and_revoke_credit_lines.md +551 -0
- package/docs/parceiros/gerenciamento/partner_led_business_verification.md +367 -0
- package/docs/parceiros/gerenciamento/pixel_tracking.md +35 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/AGENTS.md +18 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/adding_waba_to_mps.md +64 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/business_customer_support.md +102 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_embedded_signup.md +151 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_customers_off_solutions_via_meta_business_suite.md +234 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_programmatically.md +292 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_phone_numbers_among_solution_partners_via_embedded_signup.md +118 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solution_partners_via_embedded_signup.md +76 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_embedded_signup.md +90 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/migrating_wabas_among_solutions_via_meta_business_suite.md +265 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/support.md +48 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/transferring_wabas_to_customers.md +8 -0
- package/docs/parceiros/integracao_de_clientes/AGENTS.md +9 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/AGENTS.md +26 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/app_only_install.md +135 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/automatic_events_api.md +204 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/bypass_phone_addition.md +52 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/custom_flows.md +40 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/default_flow.md +90 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/errors.md +185 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/hosted_es.md +153 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/implementation.md +417 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_business_app_users.md +926 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_solution_partner.md +402 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_customers_as_a_tech_provider.md +332 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/overview.md +168 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_filled_data.md +524 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/pre_verified_numbers.md +291 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/AGENTS.md +12 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_2_public_preview.md +88 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3.md +98 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_3_public_preview.md +88 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/version_4.md +92 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/versions/versions.md +463 -0
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/website_optional.md +57 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/AGENTS.md +11 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solution_embedded_creation.md +178 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_partner_solutions.md +775 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/multi_solution_conversations.md +319 -0
- package/docs/parceiros/integracao_de_clientes/outras_opcoes_de_integracao/partner_initiated_waba_creation.md +74 -0
- package/docs/parceiros/seja_um_parceiro/AGENTS.md +11 -0
- package/docs/parceiros/seja_um_parceiro/get_started_for_solution_partners.md +280 -0
- package/docs/parceiros/seja_um_parceiro/get_started_for_tech_providers.md +194 -0
- package/docs/parceiros/seja_um_parceiro/measurement_partners.md +146 -0
- package/docs/parceiros/seja_um_parceiro/upgrade_to_tech_partner.md +94 -0
- package/docs/parceiros/visao_geral/AGENTS.md +8 -0
- package/docs/parceiros/visao_geral/overview.md +190 -0
- package/docs/recado/AGENTS.md +9 -0
- package/docs/recado/precos/AGENTS.md +11 -0
- package/docs/recado/precos/pricing.md +915 -0
- package/docs/recado/precos/pricing_authentication_international_rates.md +464 -0
- package/docs/recado/precos/pricing_conversation_based_pricing.md +773 -0
- package/docs/recado/precos/pricing_updates_to_pricing.md +8 -0
- package/docs/recado/sobre_a_plataforma/AGENTS.md +10 -0
- package/docs/recado/sobre_a_plataforma/about_the_platform.md +217 -0
- package/docs/recado/sobre_a_plataforma/access_tokens.md +110 -0
- package/docs/recado/sobre_a_plataforma/permissions.md +55 -0
- package/docs/referencia/AGENTS.md +92 -0
- package/docs/referencia/bot_do_whatsapp_business/AGENTS.md +8 -0
- package/docs/referencia/bot_do_whatsapp_business/bot_details_api.md +762 -0
- package/docs/referencia/business/AGENTS.md +14 -0
- package/docs/referencia/business/add_phone_numbers_api.md +726 -0
- package/docs/referencia/business/client_whatsapp_business_accounts_api.md +1006 -0
- package/docs/referencia/business/owned_whatsapp_business_accounts.md +802 -0
- package/docs/referencia/business/whatsapp_business_accounts_api.md +1550 -0
- package/docs/referencia/business/whatsapp_business_partner_onboarding_to_mm_lite_api.md +783 -0
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_number_sharing_api.md +790 -0
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_numbers_api.md +886 -0
- package/docs/referencia/changelog.md +10 -0
- package/docs/referencia/conta_do_whatsapp_business/AGENTS.md +24 -0
- package/docs/referencia/conta_do_whatsapp_business/assigned_users_management_api.md +2202 -0
- package/docs/referencia/conta_do_whatsapp_business/business_account_api.md +267 -0
- package/docs/referencia/conta_do_whatsapp_business/business_account_extended_credits_api.md +275 -0
- package/docs/referencia/conta_do_whatsapp_business/conversational_automation_api.md +782 -0
- package/docs/referencia/conta_do_whatsapp_business/flows_api.md +1532 -0
- package/docs/referencia/conta_do_whatsapp_business/in_progress_on_behalf_requests_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/migration_intent_api.md +1581 -0
- package/docs/referencia/conta_do_whatsapp_business/obo_mobility_intent_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/phone_number_management_api.md +1686 -0
- package/docs/referencia/conta_do_whatsapp_business/schedules_api.md +1772 -0
- package/docs/referencia/conta_do_whatsapp_business/set_obo_mobility_intent_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/set_solution_migration_intent_api.md +8 -0
- package/docs/referencia/conta_do_whatsapp_business/subscribed_apps_api.md +2178 -0
- package/docs/referencia/conta_do_whatsapp_business/template_api.md +976 -0
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_activities_api.md +842 -0
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_api.md +1384 -0
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_solutions_list_api.md +854 -0
- package/docs/referencia/grupo/AGENTS.md +11 -0
- package/docs/referencia/grupo/groups_invite_link_api.md +304 -0
- package/docs/referencia/grupo/groups_join_requests_api.md +686 -0
- package/docs/referencia/grupo/groups_participants_api.md +274 -0
- package/docs/referencia/grupo/groups_query_api.md +436 -0
- package/docs/referencia/historico_de_mensagens/AGENTS.md +8 -0
- package/docs/referencia/historico_de_mensagens/whatsapp_business_message_history_events_api.md +866 -0
- package/docs/referencia/inscricao/AGENTS.md +10 -0
- package/docs/referencia/inscricao/application_connected_client_businesses.md +812 -0
- package/docs/referencia/inscricao/application_solutions_api.md +874 -0
- package/docs/referencia/inscricao/solution_creation_api.md +824 -0
- package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/AGENTS.md +8 -0
- package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/migration_intent_details_api.md +724 -0
- package/docs/referencia/midias/AGENTS.md +9 -0
- package/docs/referencia/midias/media_api.md +342 -0
- package/docs/referencia/midias/media_download_api.md +160 -0
- package/docs/referencia/numero_da_conta_do_whatsapp/AGENTS.md +8 -0
- package/docs/referencia/numero_da_conta_do_whatsapp/whatsapp_account_number_api.md +778 -0
- package/docs/referencia/perfil_do_whatsapp_business/AGENTS.md +8 -0
- package/docs/referencia/perfil_do_whatsapp_business/whatsapp_business_profile_node_api.md +1494 -0
- package/docs/referencia/solucao_do_whatsapp_business/AGENTS.md +14 -0
- package/docs/referencia/solucao_do_whatsapp_business/accept_deactivation_request_api.md +762 -0
- package/docs/referencia/solucao_do_whatsapp_business/access_token_api.md +704 -0
- package/docs/referencia/solucao_do_whatsapp_business/reject_deactivation_request_api.md +812 -0
- package/docs/referencia/solucao_do_whatsapp_business/send_deactivation_request_api.md +778 -0
- package/docs/referencia/solucao_do_whatsapp_business/solution_accept_api.md +812 -0
- package/docs/referencia/solucao_do_whatsapp_business/solution_details_api.md +768 -0
- package/docs/referencia/solucao_do_whatsapp_business/solution_reject_api.md +798 -0
- package/docs/referencia/telefone_do_whatsapp_business/AGENTS.md +29 -0
- package/docs/referencia/telefone_do_whatsapp_business/block_api.md +542 -0
- package/docs/referencia/telefone_do_whatsapp_business/business_compliance_information_api.md +1608 -0
- package/docs/referencia/telefone_do_whatsapp_business/business_encryption_api.md +1402 -0
- package/docs/referencia/telefone_do_whatsapp_business/calling_api.md +598 -0
- package/docs/referencia/telefone_do_whatsapp_business/encrypted_messages_api.md +482 -0
- package/docs/referencia/telefone_do_whatsapp_business/groups_management_api.md +485 -0
- package/docs/referencia/telefone_do_whatsapp_business/marketing_messages_lite_api.md +315 -0
- package/docs/referencia/telefone_do_whatsapp_business/media_upload_api.md +188 -0
- package/docs/referencia/telefone_do_whatsapp_business/message_api.md +1798 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_api.md +377 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_deregister_api.md +714 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_registration.md +780 -0
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_verification_request_code_api.md +734 -0
- package/docs/referencia/telefone_do_whatsapp_business/register_api.md +411 -0
- package/docs/referencia/telefone_do_whatsapp_business/settings_api.md +674 -0
- package/docs/referencia/telefone_do_whatsapp_business/verify_code_api.md +746 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_message_history_api.md +932 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_official_business_account_status_api.md +1540 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_phone_number_api.md +1600 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_profile_api.md +1478 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_api.md +1179 -0
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_management_api.md +1315 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/AGENTS.md +11 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/request_verification_code_api.md +778 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/verify_code_api.md +768 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_api.md +1382 -0
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_partners_api.md +820 -0
- package/docs/referencia/usuario/AGENTS.md +8 -0
- package/docs/referencia/usuario/assigned_whatsapp_business_accounts_api.md +864 -0
- package/docs/referencia/webhooks/AGENTS.md +8 -0
- package/docs/referencia/webhooks/whatsapp_incoming_webhook_payload.md +1655 -0
- package/docs/suporte/AGENTS.md +13 -0
- package/docs/suporte/api_status_page.md +134 -0
- package/docs/suporte/error_codes.md +1194 -0
- package/docs/suporte/experiments.md +26 -0
- package/docs/suporte/health_status.md +225 -0
- package/docs/suporte/load_testing.md +340 -0
- package/docs/suporte/support.md +408 -0
- package/docs/visao_geral/AGENTS.md +8 -0
- package/docs/visao_geral/overview.md +2590 -0
- package/docs/webhooks/AGENTS.md +41 -0
- package/docs/webhooks/referencia/AGENTS.md +20 -0
- package/docs/webhooks/referencia/account_alerts.md +190 -0
- package/docs/webhooks/referencia/account_review_update.md +90 -0
- package/docs/webhooks/referencia/account_update.md +379 -0
- package/docs/webhooks/referencia/business_capability_update.md +121 -0
- package/docs/webhooks/referencia/history.md +302 -0
- package/docs/webhooks/referencia/message_template_components_update.md +179 -0
- package/docs/webhooks/referencia/message_template_quality_update.md +136 -0
- package/docs/webhooks/referencia/message_template_status_update.md +253 -0
- package/docs/webhooks/referencia/messages/AGENTS.md +24 -0
- package/docs/webhooks/referencia/messages/audio.md +298 -0
- package/docs/webhooks/referencia/messages/button.md +170 -0
- package/docs/webhooks/referencia/messages/contacts.md +491 -0
- package/docs/webhooks/referencia/messages/document.md +307 -0
- package/docs/webhooks/referencia/messages/errors.md +132 -0
- package/docs/webhooks/referencia/messages/image.md +304 -0
- package/docs/webhooks/referencia/messages/interactive.md +225 -0
- package/docs/webhooks/referencia/messages/location.md +296 -0
- package/docs/webhooks/referencia/messages/messages.md +44 -0
- package/docs/webhooks/referencia/messages/order.md +208 -0
- package/docs/webhooks/referencia/messages/reaction.md +178 -0
- package/docs/webhooks/referencia/messages/status.md +364 -0
- package/docs/webhooks/referencia/messages/sticker.md +298 -0
- package/docs/webhooks/referencia/messages/system.md +140 -0
- package/docs/webhooks/referencia/messages/text.md +322 -0
- package/docs/webhooks/referencia/messages/unsupported.md +165 -0
- package/docs/webhooks/referencia/messages/video.md +304 -0
- package/docs/webhooks/referencia/outros_webhooks/AGENTS.md +16 -0
- package/docs/webhooks/referencia/outros_webhooks/partner_solutions.md +114 -0
- package/docs/webhooks/referencia/outros_webhooks/payment_configuration_update.md +135 -0
- package/docs/webhooks/referencia/outros_webhooks/phone_number_name_update.md +129 -0
- package/docs/webhooks/referencia/outros_webhooks/phone_number_quality_update.md +172 -0
- package/docs/webhooks/referencia/outros_webhooks/security.md +108 -0
- package/docs/webhooks/referencia/outros_webhooks/smb_app_state_sync.md +146 -0
- package/docs/webhooks/referencia/outros_webhooks/smb_message_echoes.md +143 -0
- package/docs/webhooks/referencia/outros_webhooks/template_category_update.md +154 -0
- package/docs/webhooks/referencia/outros_webhooks/user_preferences.md +150 -0
- package/docs/webhooks/visao_geral/AGENTS.md +11 -0
- package/docs/webhooks/visao_geral/message_echoes.md +8 -0
- package/docs/webhooks/visao_geral/override.md +235 -0
- package/docs/webhooks/visao_geral/overview.md +158 -0
- package/docs/webhooks/visao_geral/set_up_whatsapp_echo_bot.md +109 -0
- package/package.json +50 -0
|
@@ -0,0 +1,1030 @@
|
|
|
1
|
+
<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/calling/user-initiated-calls -->
|
|
2
|
+
<!-- Scraped: 2025-12-20T17:41:00.588Z -->
|
|
3
|
+
|
|
4
|
+
# Ligações iniciadas pelo usuário
|
|
5
|
+
|
|
6
|
+
Updated: 13 de nov de 2025
|
|
7
|
+
|
|
8
|
+
## Visão geral
|
|
9
|
+
|
|
10
|
+
A API de ligações é compatível com o recebimento de ligações feitas por usuários do WhatsApp para sua empresa.
|
|
11
|
+
|
|
12
|
+
Sua empresa determina quando as ligações podem ser recebidas ao [configurar o horário de atendimento e a indisponibilidade em feriados](/documentation/business-messaging/whatsapp/calling/call-settings#parameter-details).
|
|
13
|
+
|
|
14
|
+
**Dispositivos qualificados para o consumidor**
|
|
15
|
+
|
|
16
|
+
No momento, a API de Ligações Comerciais do WhatsApp só aceita ligações originadas do dispositivo principal do consumidor. As ligações originadas em dispositivos adicionais do consumidor serão rejeitadas.
|
|
17
|
+
|
|
18
|
+
O **dispositivo principal** é o dispositivo principal do consumidor, normalmente um celular, que detém o estado autorizado da conta do usuário. Essa opção oferece acesso total ao histórico de mensagens e às funcionalidades principais. Só é possível ter um dispositivo principal por conta de usuário por vez.
|
|
19
|
+
|
|
20
|
+
Os **dispositivos adicionais** são outros dispositivos registrados na conta do usuário que podem funcionar juntamente com o dispositivo principal. Esses exemplos incluem clientes da web, apps para computador, tablets e óculos inteligentes. Os dispositivos adicionais têm acesso a alguns ou todos os recursos principais e do histórico de mensagens, mas são limitados em comparação ao dispositivo principal. Eles podem funcionar de forma independente por um período, mas não são compatíveis com as ligações no momento.
|
|
21
|
+
|
|
22
|
+
## Pré-requisitos
|
|
23
|
+
|
|
24
|
+
Antes de começar a usar as ligações iniciadas pelo usuário:
|
|
25
|
+
|
|
26
|
+
- [Assine](/documentation/business-messaging/whatsapp/webhooks/create-webhook-endpoint#configure-webhooks) o campo de webhook **ligações**- [Habilitar os recursos da API de Ligações no número de telefone da sua empresa](/documentation/business-messaging/whatsapp/calling/call-settings)
|
|
27
|
+
|
|
28
|
+
### Diagrama da sequência de ligações
|
|
29
|
+
|
|
30
|
+

|
|
31
|
+
|
|
32
|
+
## Fluxo de ligação iniciada pelo usuário
|
|
33
|
+
|
|
34
|
+
### Parte 1: um usuário do WhatsApp liga para a empresa a partir do próprio app
|
|
35
|
+
|
|
36
|
+
Quando um usuário do WhatsApp liga para a empresa, um webhook de Conexão de ligação será disparado com um `SDP Offer`:
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
{
|
|
40
|
+
"object": "whatsapp_business_account",
|
|
41
|
+
"entry": [
|
|
42
|
+
{
|
|
43
|
+
"id": "366634483210360", // WhatsApp Business Account ID associated with the business phone number
|
|
44
|
+
"changes": [
|
|
45
|
+
{
|
|
46
|
+
"value": {
|
|
47
|
+
"messaging_product": "whatsapp",
|
|
48
|
+
"metadata": { // ID and display number for the business phone number placing the call (caller)
|
|
49
|
+
"phone_number_id": "436666719526789",
|
|
50
|
+
"display_phone_number": "13175551399",
|
|
51
|
+
},
|
|
52
|
+
"calls": [
|
|
53
|
+
{
|
|
54
|
+
"id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh", // The WhatsApp call ID
|
|
55
|
+
"to": "16315553601", // The WhatsApp user's phone number (callee)
|
|
56
|
+
"from": "13175551399",
|
|
57
|
+
"event": "connect",
|
|
58
|
+
"timestamp": "1671644824",
|
|
59
|
+
"session": {
|
|
60
|
+
"sdp_type": "offer",
|
|
61
|
+
"sdp": "<<RFC 8866 SDP>>"
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
]
|
|
65
|
+
},
|
|
66
|
+
"field": "calls"
|
|
67
|
+
}
|
|
68
|
+
]
|
|
69
|
+
}
|
|
70
|
+
]
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Parte 2: sua empresa aceita previamente a ligação (recomendado)
|
|
75
|
+
|
|
76
|
+
Basicamente, aceitando previamente uma ligação recebida, você permite que a conexão de mídia seja estabelecida antes de tentar enviar a mídia da ligação por meio da conexão.
|
|
77
|
+
|
|
78
|
+
Recomendamos aceitar as ligações previamente, pois isso facilita o contato mais rápido e evita [problemas de clipe de áudio](/documentation/business-messaging/whatsapp/calling/troubleshooting#audio-clipping-issue-and-solution).
|
|
79
|
+
|
|
80
|
+
Para aceitar previamente, faça uma ligação ao ponto de extremidade `POST <PHONE_NUMBER_ID>/calls` com o `call_id` do webhook anterior, `action` de `pre-accept` e `SDP Answer`:
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
POST <PHONE_NUMBER_ID>/calls
|
|
84
|
+
{
|
|
85
|
+
"messaging_product": "whatsapp",
|
|
86
|
+
"call_id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
|
|
87
|
+
"action": "pre_accept",
|
|
88
|
+
"session": {
|
|
89
|
+
"sdp_type": "answer"
|
|
90
|
+
"sdp": "<<RFC 8866 SDP>>"
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Se não houver erros, você receberá uma resposta bem-sucedida:
|
|
96
|
+
|
|
97
|
+
```
|
|
98
|
+
{
|
|
99
|
+
"success" : true
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Parte 3: sua empresa aceita a ligação após a conexão do WebRTC
|
|
104
|
+
|
|
105
|
+
Depois que a conexão for estabelecida, você poderá aceitar a ligação.
|
|
106
|
+
|
|
107
|
+
Depois de aceitar a chamada, aguarde até receber uma resposta `200 OK` do ponto de extremidade. A mídia começará a fluir imediatamente, já que a conexão foi estabelecida antes de a ligação ser conectada.
|
|
108
|
+
|
|
109
|
+
Agora, você pode chamar o ponto de extremidade `POST <PHONE_NUMBER_ID>/calls` com o seguinte corpo de solicitação para aceitar a ligação:
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
POST <PHONE_NUMBER_ID>/calls
|
|
113
|
+
{
|
|
114
|
+
"messaging_product": "whatsapp",
|
|
115
|
+
"call_id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
|
|
116
|
+
"action": "accept",
|
|
117
|
+
"session" : {
|
|
118
|
+
"sdp_type" : "answer",
|
|
119
|
+
"sdp" : "<<RFC 8866 SDP>>"
|
|
120
|
+
},
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Parte 4: sua empresa ou o usuário do WhatsApp encerra a ligação
|
|
125
|
+
|
|
126
|
+
Tanto a empresa quanto o usuário do WhatsApp podem encerrar a ligação a qualquer momento.
|
|
127
|
+
|
|
128
|
+
Chame o ponto de extremidade `POST <PHONE_NUMBER_ID>/calls` com o seguinte corpo de solicitação para encerrar uma nova ligação:
|
|
129
|
+
|
|
130
|
+
```
|
|
131
|
+
POST <PHONE_NUMBER_ID>/calls
|
|
132
|
+
{
|
|
133
|
+
"messaging_product": "whatsapp",
|
|
134
|
+
"call_id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
|
|
135
|
+
"action" : "terminate"
|
|
136
|
+
}
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Se não houver erros, você receberá uma resposta bem-sucedida:
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
{
|
|
143
|
+
"success" : true
|
|
144
|
+
}
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
Quando a empresa ou o usuário do WhatsApp encerrar a ligação, você receberá um webhook de Encerramento de ligação:
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
{
|
|
151
|
+
"object": "whatsapp_business_account",
|
|
152
|
+
"entry": [
|
|
153
|
+
{
|
|
154
|
+
"id": "366634483210360", // WhatsApp Business Account ID associated with the business phone number
|
|
155
|
+
"changes": [
|
|
156
|
+
{
|
|
157
|
+
"value": {
|
|
158
|
+
"messaging_product": "whatsapp",
|
|
159
|
+
"metadata": { // ID and display number for the business phone number placing the call (caller)
|
|
160
|
+
"phone_number_id": "436666719526789"
|
|
161
|
+
"display_phone_number": "13175551399",
|
|
162
|
+
|
|
163
|
+
},
|
|
164
|
+
"calls": [
|
|
165
|
+
{
|
|
166
|
+
"id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
|
|
167
|
+
"to": "16315553601", // The WhatsApp user's phone number (callee)
|
|
168
|
+
"from": "13175551399", // The business phone number placing the call (caller)
|
|
169
|
+
"event": "terminate",
|
|
170
|
+
"direction": "USER_INITIATED",
|
|
171
|
+
"timestamp": "1749197480",
|
|
172
|
+
"status": ["Failed", "Completed"],
|
|
173
|
+
"start_time": "1671644824", // Call start UNIX timestamp
|
|
174
|
+
"end_time": "1671644944", // Call end UNIX timestamp
|
|
175
|
+
"duration": 480 // Call duration in seconds
|
|
176
|
+
}
|
|
177
|
+
]
|
|
178
|
+
},
|
|
179
|
+
"field": "calls"
|
|
180
|
+
}
|
|
181
|
+
]
|
|
182
|
+
}
|
|
183
|
+
]
|
|
184
|
+
}
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
## Pontos de extremidade para ligações iniciadas pelo usuário
|
|
188
|
+
|
|
189
|
+
### Pré-aceitar ligação
|
|
190
|
+
|
|
191
|
+
Basicamente, aceitando previamente uma ligação recebida, você permite que a conexão de mídia seja estabelecida antes de tentar enviar a mídia da ligação por meio da conexão.
|
|
192
|
+
|
|
193
|
+
Quando você chamar o ponto de extremidade de aceitação de ligação, a mídia começará a fluir imediatamente, já que a conexão já foi estabelecida.
|
|
194
|
+
|
|
195
|
+
Recomendamos aceitar as ligações previamente, pois isso facilita o contato mais rápido e evita [problemas de clipe de áudio](/documentation/business-messaging/whatsapp/calling/troubleshooting#audio-clipping-issue-and-solution).
|
|
196
|
+
|
|
197
|
+
Após o envio do [webhook de conexão de ligação](/documentation/business-messaging/whatsapp/calling/user-initiated-calls#call-connect-webhook), a empresa terá de 30 a 60 segundos para aceitar a ligação telefônica. Se a empresa não atender, a ligação será encerrada para o usuário do WhatsApp com uma notificação "Não atendida", e você receberá um [webhook de encerramento](/documentation/business-messaging/whatsapp/calling/user-initiated-calls#call-terminate-webhook).
|
|
198
|
+
|
|
199
|
+
**Observação:** como a conexão WebRTC é estabelecida antes da ligação ao [ponto de extremidade Aceitar Ligação](/documentation/business-messaging/whatsapp/calling/user-initiated-calls#accept-call), processe a mídia da ligação somente após receber a resposta 200 OK.
|
|
200
|
+
|
|
201
|
+
Se o fluxo de mídia da ligação começar muito cedo, a pessoa que está ligando não ouvirá as primeiras palavras. Se o fluxo de mídia da ligação começar muito tarde, a pessoa que está ligando não ouvirá nada.
|
|
202
|
+
|
|
203
|
+
#### Sintaxe da solicitação
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
POST <PHONE_NUMBER_ID/calls
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
Espaço reservado
|
|
210
|
+
|
|
211
|
+
Descrição
|
|
212
|
+
|
|
213
|
+
Exemplo de valor
|
|
214
|
+
|
|
215
|
+
`<PHONE_NUMBER_ID>`
|
|
216
|
+
|
|
217
|
+
_Número inteiro_
|
|
218
|
+
|
|
219
|
+
**Obrigatório**
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
O número de telefone comercial do qual você está usando os recursos da API de Ligações.
|
|
223
|
+
|
|
224
|
+
[Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers)
|
|
225
|
+
|
|
226
|
+
`+12784358810`
|
|
227
|
+
|
|
228
|
+
#### Corpo da solicitação
|
|
229
|
+
|
|
230
|
+
```
|
|
231
|
+
{
|
|
232
|
+
"messaging_product": "whatsapp",
|
|
233
|
+
"call_id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
|
|
234
|
+
"action": "pre_accept",
|
|
235
|
+
"session" : {
|
|
236
|
+
"sdp_type" : "answer",
|
|
237
|
+
"sdp" : "<<RFC 8866 SDP>>"
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
#### Parâmetros do corpo
|
|
243
|
+
|
|
244
|
+
Parâmetro
|
|
245
|
+
|
|
246
|
+
Descrição
|
|
247
|
+
|
|
248
|
+
Exemplo de valor
|
|
249
|
+
|
|
250
|
+
`call_id`
|
|
251
|
+
|
|
252
|
+
_String_
|
|
253
|
+
|
|
254
|
+
**Obrigatório**
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
O ID da ligação telefônica.
|
|
258
|
+
|
|
259
|
+
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/user-initiated-calls#call-connect-webhook) quando um usuário do WhatsApp inicia a ligação.
|
|
260
|
+
|
|
261
|
+
`“wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh”`
|
|
262
|
+
|
|
263
|
+
`action`
|
|
264
|
+
|
|
265
|
+
_String_
|
|
266
|
+
|
|
267
|
+
**Opcional**
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
A ação sendo realizada na ligação em questão.
|
|
271
|
+
|
|
272
|
+
Os valores podem ser `connect` | `pre_accept` | `accept` | `reject` | `terminate`
|
|
273
|
+
|
|
274
|
+
`“pre_accept”`
|
|
275
|
+
|
|
276
|
+
`session`
|
|
277
|
+
|
|
278
|
+
_Objeto JSON_
|
|
279
|
+
|
|
280
|
+
**Opcional**
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
Contém o tipo de protocolo de descrição de sessão (SDP) e a descrição do idioma.
|
|
284
|
+
|
|
285
|
+
Exige dois valores:
|
|
286
|
+
|
|
287
|
+
`sdp_type` – (_String_) **Obrigatório**
|
|
288
|
+
|
|
289
|
+
"oferta", para indicar a oferta de SDP
|
|
290
|
+
|
|
291
|
+
`sdp` – (_String_) **Obrigatório**
|
|
292
|
+
|
|
293
|
+
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=AT0OM8mYiMxeia4jgqVROfnCu2VzgtNUr4nDEdW8WxpIra6FOgQ-KNSOVim5Lm-Xb3K_XpjnswpkhXsWAathaNGH7FdZc6tfkEhRyo-tD1yvSoCRdHD0zwTDauW5vgxAq1rCCvOr71zXEeebGjpI9Yo4xnk).
|
|
294
|
+
|
|
295
|
+
[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=AT0OM8mYiMxeia4jgqVROfnCu2VzgtNUr4nDEdW8WxpIra6FOgQ-KNSOVim5Lm-Xb3K_XpjnswpkhXsWAathaNGH7FdZc6tfkEhRyo-tD1yvSoCRdHD0zwTDauW5vgxAq1rCCvOr71zXEeebGjpI9Yo4xnk)
|
|
296
|
+
|
|
297
|
+
[Exemplo de estruturas SDP](/documentation/business-messaging/whatsapp/calling/reference#sdp-overview-and-sample-sdp-structures)
|
|
298
|
+
|
|
299
|
+
```
|
|
300
|
+
"session" :
|
|
301
|
+
{
|
|
302
|
+
"sdp_type" : "offer",
|
|
303
|
+
"sdp" : "<<RFC 8866 SDP>>"
|
|
304
|
+
}
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
#### Resposta de sucesso
|
|
308
|
+
|
|
309
|
+
```
|
|
310
|
+
{
|
|
311
|
+
"messaging_product": "whatsapp",
|
|
312
|
+
"success" : true
|
|
313
|
+
}
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
#### Resposta de erro
|
|
317
|
+
|
|
318
|
+
Veja os problemas que podem ocorrer:
|
|
319
|
+
|
|
320
|
+
- `call-id` inválida- `phone-number-id` inválida- Erro relacionado à forma de pagamento- Informações de conexão inválidas, como sdp, ice- Aceitar/rejeitar uma ligação que já está em andamento/concluída/com falha- Erros de permissão/autorização
|
|
321
|
+
|
|
322
|
+
[Consulte Códigos de erro e solução de problemas da API de Ligações para saber mais](/documentation/business-messaging/whatsapp/calling/troubleshooting)
|
|
323
|
+
|
|
324
|
+
[Veja os códigos de erro gerais da API de Nuvem aqui](/documentation/business-messaging/whatsapp/support/error-codes)
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
### Aceitar ligação
|
|
329
|
+
|
|
330
|
+
Use este ponto de extremidade para se conectar a uma ligação fornecendo o SDP de um agente de ligação.
|
|
331
|
+
|
|
332
|
+
Após o envio do [Webhook de conexão de ligação](/documentation/business-messaging/whatsapp/calling/user-initiated-calls#call-connect-webhook), você terá de 30 a 60 segundos para aceitar a ligação. Se a empresa não atender, a ligação será encerrada para o usuário do WhatsApp com uma notificação "Não atendida", e você receberá um [webhook de encerramento](/documentation/business-messaging/whatsapp/calling/user-initiated-calls#call-terminate-webhook).
|
|
333
|
+
|
|
334
|
+
#### Sintaxe da solicitação
|
|
335
|
+
|
|
336
|
+
```
|
|
337
|
+
POST <PHONE_NUMBER_ID/calls
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
Espaço reservado
|
|
341
|
+
|
|
342
|
+
Descrição
|
|
343
|
+
|
|
344
|
+
Exemplo de valor
|
|
345
|
+
|
|
346
|
+
`<PHONE_NUMBER_ID>`
|
|
347
|
+
|
|
348
|
+
_Número inteiro_
|
|
349
|
+
|
|
350
|
+
**Obrigatório**
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
O número de telefone comercial do qual você está usando os recursos da API de Ligações.
|
|
354
|
+
|
|
355
|
+
[Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers)
|
|
356
|
+
|
|
357
|
+
`+12784358810`
|
|
358
|
+
|
|
359
|
+
#### Corpo da solicitação
|
|
360
|
+
|
|
361
|
+
```
|
|
362
|
+
{
|
|
363
|
+
"messaging_product": "whatsapp",
|
|
364
|
+
"call_id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
|
|
365
|
+
"action": "accept",
|
|
366
|
+
"session" : {
|
|
367
|
+
"sdp_type" : "answer",
|
|
368
|
+
"sdp" : "<<RFC 8866 SDP>>"
|
|
369
|
+
},
|
|
370
|
+
"biz_opaque_callback_data": "random_string",
|
|
371
|
+
}
|
|
372
|
+
}
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
#### Parâmetros do corpo
|
|
376
|
+
|
|
377
|
+
Parâmetro
|
|
378
|
+
|
|
379
|
+
Descrição
|
|
380
|
+
|
|
381
|
+
Exemplo de valor
|
|
382
|
+
|
|
383
|
+
`call_id`
|
|
384
|
+
|
|
385
|
+
_String_
|
|
386
|
+
|
|
387
|
+
**Obrigatório**
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
O ID da ligação telefônica.
|
|
391
|
+
|
|
392
|
+
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/user-initiated-calls#call-connect-webhook) quando um usuário do WhatsApp inicia a ligação.
|
|
393
|
+
|
|
394
|
+
`“wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh”`
|
|
395
|
+
|
|
396
|
+
`action`
|
|
397
|
+
|
|
398
|
+
_String_
|
|
399
|
+
|
|
400
|
+
**Opcional**
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
A ação sendo realizada na ligação em questão.
|
|
404
|
+
|
|
405
|
+
Os valores podem ser `connect` | `pre_accept` | `accept` | `reject` | `terminate`
|
|
406
|
+
|
|
407
|
+
`“accept”`
|
|
408
|
+
|
|
409
|
+
`session`
|
|
410
|
+
|
|
411
|
+
_Objeto JSON_
|
|
412
|
+
|
|
413
|
+
**Opcional**
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
Contém o tipo de protocolo de descrição de sessão (SDP) e a descrição do idioma.
|
|
417
|
+
|
|
418
|
+
Exige dois valores:
|
|
419
|
+
|
|
420
|
+
`sdp_type` – (_String_) **Obrigatório**
|
|
421
|
+
|
|
422
|
+
"oferta", para indicar a oferta de SDP
|
|
423
|
+
|
|
424
|
+
`sdp` – (_String_) **Obrigatório**
|
|
425
|
+
|
|
426
|
+
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=AT0OM8mYiMxeia4jgqVROfnCu2VzgtNUr4nDEdW8WxpIra6FOgQ-KNSOVim5Lm-Xb3K_XpjnswpkhXsWAathaNGH7FdZc6tfkEhRyo-tD1yvSoCRdHD0zwTDauW5vgxAq1rCCvOr71zXEeebGjpI9Yo4xnk).
|
|
427
|
+
|
|
428
|
+
[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=AT0OM8mYiMxeia4jgqVROfnCu2VzgtNUr4nDEdW8WxpIra6FOgQ-KNSOVim5Lm-Xb3K_XpjnswpkhXsWAathaNGH7FdZc6tfkEhRyo-tD1yvSoCRdHD0zwTDauW5vgxAq1rCCvOr71zXEeebGjpI9Yo4xnk)
|
|
429
|
+
|
|
430
|
+
[Exemplo de estruturas SDP](/documentation/business-messaging/whatsapp/calling/reference#sdp-overview-and-sample-sdp-structures)
|
|
431
|
+
|
|
432
|
+
```
|
|
433
|
+
"session" :
|
|
434
|
+
{
|
|
435
|
+
"sdp_type" : "offer",
|
|
436
|
+
"sdp" : "<<RFC 8866 SDP>>"
|
|
437
|
+
}
|
|
438
|
+
```
|
|
439
|
+
|
|
440
|
+
`biz_opaque_callback_data`
|
|
441
|
+
|
|
442
|
+
_String_
|
|
443
|
+
|
|
444
|
+
**Opcional**
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
Uma string arbitrária que você pode incluir e que é útil para rastreamento e registro.
|
|
448
|
+
|
|
449
|
+
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/user-initiated-calls#call-terminate-webhook).
|
|
450
|
+
|
|
451
|
+
A API de Nuvem não processa esse campo; ela apenas o retorna como parte do [webhook de encerramento](/documentation/business-messaging/whatsapp/calling/user-initiated-calls#call-terminate-webhook).
|
|
452
|
+
|
|
453
|
+
Máximo de 512 caracteres
|
|
454
|
+
|
|
455
|
+
`“8huas8d80nn”`
|
|
456
|
+
|
|
457
|
+
#### Resposta de sucesso
|
|
458
|
+
|
|
459
|
+
```
|
|
460
|
+
{
|
|
461
|
+
"messaging_product": "whatsapp",
|
|
462
|
+
"success" : true
|
|
463
|
+
}
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
#### Resposta de erro
|
|
467
|
+
|
|
468
|
+
Veja os problemas que podem ocorrer:
|
|
469
|
+
|
|
470
|
+
- `call-id` inválida- `phone-number-id` inválida- Erro relacionado à forma de pagamento- Informações de conexão inválidas, como sdp, ice etc.- Aceitar/rejeitar uma ligação que já está em andamento/concluída/com falha- Erros de permissão/autorização- A resposta de SDP fornecida na aceitação não corresponde à resposta de SDP dada no [ponto de extremidade de aceitação prévia](/documentation/business-messaging/whatsapp/calling/user-initiated-calls#pre-accept-call) para o mesmo `call-id`
|
|
471
|
+
|
|
472
|
+
[Consulte Códigos de erro e solução de problemas da API de Ligações para saber mais](/documentation/business-messaging/whatsapp/calling/troubleshooting)
|
|
473
|
+
|
|
474
|
+
[Veja os códigos de erro gerais da API de Nuvem aqui](/documentation/business-messaging/whatsapp/support/error-codes)
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
### Rejeitar ligação
|
|
479
|
+
|
|
480
|
+
Use este ponto de extremidade para rejeitar uma ligação.
|
|
481
|
+
|
|
482
|
+
Após o envio do [Webhook de conexão de ligação](/documentation/business-messaging/whatsapp/calling/user-initiated-calls#call-connect-webhook), você terá de 30 a 60 segundos para aceitar a ligação. Se a empresa não atender, a ligação será encerrada para o usuário do WhatsApp com uma notificação "Não atendida", e você receberá um [webhook de encerramento](/documentation/business-messaging/whatsapp/calling/user-initiated-calls#call-terminate-webhook).
|
|
483
|
+
|
|
484
|
+
#### Sintaxe da solicitação
|
|
485
|
+
|
|
486
|
+
```
|
|
487
|
+
POST <PHONE_NUMBER_ID/calls
|
|
488
|
+
```
|
|
489
|
+
|
|
490
|
+
Espaço reservado
|
|
491
|
+
|
|
492
|
+
Descrição
|
|
493
|
+
|
|
494
|
+
Exemplo de valor
|
|
495
|
+
|
|
496
|
+
`<PHONE_NUMBER_ID>`
|
|
497
|
+
|
|
498
|
+
_Número inteiro_
|
|
499
|
+
|
|
500
|
+
**Obrigatório**
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
O número de telefone comercial do qual você está usando os recursos da API de Ligações.
|
|
504
|
+
|
|
505
|
+
[Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers)
|
|
506
|
+
|
|
507
|
+
`+12784358810`
|
|
508
|
+
|
|
509
|
+
#### Corpo da solicitação
|
|
510
|
+
|
|
511
|
+
```
|
|
512
|
+
{
|
|
513
|
+
"messaging_product": "whatsapp",
|
|
514
|
+
"call_id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
|
|
515
|
+
"action": "reject"
|
|
516
|
+
}
|
|
517
|
+
```
|
|
518
|
+
|
|
519
|
+
#### Parâmetros do corpo
|
|
520
|
+
|
|
521
|
+
Parâmetro
|
|
522
|
+
|
|
523
|
+
Descrição
|
|
524
|
+
|
|
525
|
+
Exemplo de valor
|
|
526
|
+
|
|
527
|
+
`call_id`
|
|
528
|
+
|
|
529
|
+
_String_
|
|
530
|
+
|
|
531
|
+
**Obrigatório**
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
O ID da ligação telefônica.
|
|
535
|
+
|
|
536
|
+
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/user-initiated-calls#call-connect-webhook) quando um usuário do WhatsApp inicia a ligação.
|
|
537
|
+
|
|
538
|
+
`“wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh”`
|
|
539
|
+
|
|
540
|
+
`action`
|
|
541
|
+
|
|
542
|
+
_String_
|
|
543
|
+
|
|
544
|
+
**Opcional**
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
A ação sendo realizada na ligação em questão.
|
|
548
|
+
|
|
549
|
+
Os valores podem ser `connect` | `pre_accept` | `accept` | `reject` | `terminate`
|
|
550
|
+
|
|
551
|
+
`“reject”`
|
|
552
|
+
|
|
553
|
+
#### Resposta de sucesso
|
|
554
|
+
|
|
555
|
+
```
|
|
556
|
+
{
|
|
557
|
+
"messaging_product": "whatsapp",
|
|
558
|
+
"success" : true
|
|
559
|
+
}
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
#### Resposta de erro
|
|
563
|
+
|
|
564
|
+
Veja os problemas que podem ocorrer:
|
|
565
|
+
|
|
566
|
+
- `call-id` inválida- `phone-number-id` inválido- Aceitar/rejeitar uma ligação que já está em andamento/concluída/com falha- Erros de permissão/autorização
|
|
567
|
+
|
|
568
|
+
[Consulte Códigos de erro e solução de problemas da API de Ligações para saber mais](/documentation/business-messaging/whatsapp/calling/troubleshooting)
|
|
569
|
+
|
|
570
|
+
[Veja os códigos de erro gerais da API de Nuvem aqui](/documentation/business-messaging/whatsapp/support/error-codes)
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
### Encerrar ligação
|
|
575
|
+
|
|
576
|
+
Use este ponto de extremidade para encerrar uma ligação ativa.
|
|
577
|
+
|
|
578
|
+
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.
|
|
579
|
+
|
|
580
|
+
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/user-initiated-calls#call-terminate-webhook).
|
|
581
|
+
|
|
582
|
+
#### Sintaxe da solicitação
|
|
583
|
+
|
|
584
|
+
```
|
|
585
|
+
POST <PHONE_NUMBER_ID/calls
|
|
586
|
+
```
|
|
587
|
+
|
|
588
|
+
Espaço reservado
|
|
589
|
+
|
|
590
|
+
Descrição
|
|
591
|
+
|
|
592
|
+
Exemplo de valor
|
|
593
|
+
|
|
594
|
+
`<PHONE_NUMBER_ID>`
|
|
595
|
+
|
|
596
|
+
_Número inteiro_
|
|
597
|
+
|
|
598
|
+
**Obrigatório**
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
O número de telefone comercial do qual você está usando os recursos da API de Ligações.
|
|
602
|
+
|
|
603
|
+
[Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers)
|
|
604
|
+
|
|
605
|
+
`+12784358810`
|
|
606
|
+
|
|
607
|
+
#### Corpo da solicitação
|
|
608
|
+
|
|
609
|
+
```
|
|
610
|
+
{
|
|
611
|
+
"messaging_product": "whatsapp",
|
|
612
|
+
"call_id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
|
|
613
|
+
"action": "terminate"
|
|
614
|
+
}
|
|
615
|
+
```
|
|
616
|
+
|
|
617
|
+
#### Parâmetros do corpo
|
|
618
|
+
|
|
619
|
+
Parâmetro
|
|
620
|
+
|
|
621
|
+
Descrição
|
|
622
|
+
|
|
623
|
+
Exemplo de valor
|
|
624
|
+
|
|
625
|
+
`call_id`
|
|
626
|
+
|
|
627
|
+
_String_
|
|
628
|
+
|
|
629
|
+
**Obrigatório**
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
O ID da ligação telefônica.
|
|
633
|
+
|
|
634
|
+
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/user-initiated-calls#call-connect-webhook) quando um usuário do WhatsApp inicia a ligação.
|
|
635
|
+
|
|
636
|
+
`“wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh”`
|
|
637
|
+
|
|
638
|
+
`action`
|
|
639
|
+
|
|
640
|
+
_String_
|
|
641
|
+
|
|
642
|
+
**Opcional**
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
A ação sendo realizada na ligação em questão.
|
|
646
|
+
|
|
647
|
+
Os valores podem ser `connect` | `pre_accept` | `accept` | `reject` | `terminate`
|
|
648
|
+
|
|
649
|
+
`“terminate”`
|
|
650
|
+
|
|
651
|
+
#### Resposta de sucesso
|
|
652
|
+
|
|
653
|
+
```
|
|
654
|
+
{
|
|
655
|
+
"messaging_product": "whatsapp",
|
|
656
|
+
"success" : true
|
|
657
|
+
}
|
|
658
|
+
```
|
|
659
|
+
|
|
660
|
+
#### Resposta de erro
|
|
661
|
+
|
|
662
|
+
Veja os problemas que podem ocorrer:
|
|
663
|
+
|
|
664
|
+
- `call-id` inválida- `phone-number-id` inválido- Aceitar/rejeitar uma ligação que já está em andamento/concluída/com falha- A rejeição da ligação está em andamento- Erros de permissão/autorização
|
|
665
|
+
|
|
666
|
+
[Consulte Códigos de erro e solução de problemas da API de Ligações para saber mais](/documentation/business-messaging/whatsapp/calling/troubleshooting)
|
|
667
|
+
|
|
668
|
+
[Veja os códigos de erro gerais da API de Nuvem aqui](/documentation/business-messaging/whatsapp/support/error-codes)
|
|
669
|
+
|
|
670
|
+
## Webhooks para ligações iniciadas pelo usuário
|
|
671
|
+
|
|
672
|
+
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 recebida pela empresa.
|
|
673
|
+
|
|
674
|
+
Para receber webhooks da API de Ligações, assine o campo de webhook de ligações.
|
|
675
|
+
|
|
676
|
+
[Saiba mais sobre webhooks da API de Nuvem aqui](/documentation/business-messaging/whatsapp/webhooks/overview)
|
|
677
|
+
|
|
678
|
+
### Webhook de conexão de ligação
|
|
679
|
+
|
|
680
|
+
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`).
|
|
681
|
+
|
|
682
|
+
É importante destacar que o webhook contém informações necessárias para estabelecer uma conexão de chamada por meio do WebRTC.
|
|
683
|
+
|
|
684
|
+
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.
|
|
685
|
+
|
|
686
|
+
```
|
|
687
|
+
{
|
|
688
|
+
"object": "whatsapp_business_account",
|
|
689
|
+
"entry": [
|
|
690
|
+
{
|
|
691
|
+
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
|
|
692
|
+
"changes": [
|
|
693
|
+
{
|
|
694
|
+
"value": {
|
|
695
|
+
"messaging_product": "whatsapp",
|
|
696
|
+
"metadata": {
|
|
697
|
+
"display_phone_number": "16315553601",
|
|
698
|
+
"phone_number_id": "<PHONE_NUMBER_ID>"
|
|
699
|
+
},
|
|
700
|
+
"contacts": [
|
|
701
|
+
{
|
|
702
|
+
"profile": {
|
|
703
|
+
"name": "<CALLEE_NAME>"
|
|
704
|
+
},
|
|
705
|
+
"wa_id": "16315553602"
|
|
706
|
+
}
|
|
707
|
+
],
|
|
708
|
+
"calls": [
|
|
709
|
+
{
|
|
710
|
+
"id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
|
|
711
|
+
"to": "16315553601",
|
|
712
|
+
"from": "16315553602",
|
|
713
|
+
"event": "connect",
|
|
714
|
+
"timestamp": "1671644824",
|
|
715
|
+
"direction": "USER_INITIATED",
|
|
716
|
+
"deeplink_payload": "deeplink_payload",
|
|
717
|
+
"cta_payload": "cta_payload",
|
|
718
|
+
"session": {
|
|
719
|
+
"sdp_type": "offer",
|
|
720
|
+
"sdp": "<<RFC 8866 SDP>>"
|
|
721
|
+
}
|
|
722
|
+
}
|
|
723
|
+
]
|
|
724
|
+
},
|
|
725
|
+
"field": "calls"
|
|
726
|
+
}
|
|
727
|
+
]
|
|
728
|
+
}
|
|
729
|
+
]
|
|
730
|
+
}
|
|
731
|
+
```
|
|
732
|
+
|
|
733
|
+
#### Valores de webhook para `"calls"`
|
|
734
|
+
|
|
735
|
+
Espaço reservado
|
|
736
|
+
|
|
737
|
+
Descrição
|
|
738
|
+
|
|
739
|
+
`id`
|
|
740
|
+
|
|
741
|
+
_String_
|
|
742
|
+
|
|
743
|
+
Uma identificação única para a ligação
|
|
744
|
+
|
|
745
|
+
`to`
|
|
746
|
+
|
|
747
|
+
_Número inteiro_
|
|
748
|
+
|
|
749
|
+
O número para o qual a ligação é feita (recebedor da ligação)
|
|
750
|
+
|
|
751
|
+
`from`
|
|
752
|
+
|
|
753
|
+
_Número inteiro_
|
|
754
|
+
|
|
755
|
+
O número de telefone da pessoa realizando a ligação
|
|
756
|
+
|
|
757
|
+
`event`
|
|
758
|
+
|
|
759
|
+
_Número inteiro_
|
|
760
|
+
|
|
761
|
+
Evento de ligação sobre o qual esse webhook está notificando o assinante
|
|
762
|
+
|
|
763
|
+
`timestamp`
|
|
764
|
+
|
|
765
|
+
_Número inteiro_
|
|
766
|
+
|
|
767
|
+
O registro de data e hora UNIX do evento de webhook
|
|
768
|
+
|
|
769
|
+
`direction`
|
|
770
|
+
|
|
771
|
+
_String_
|
|
772
|
+
|
|
773
|
+
A direção da ligação que está sendo feita.
|
|
774
|
+
|
|
775
|
+
Pode conter:
|
|
776
|
+
|
|
777
|
+
`BUSINESS_INITIATED`, para ligações iniciadas pela empresa.
|
|
778
|
+
|
|
779
|
+
`USER_INITIATED`, para chamadas iniciadas por um usuário do WhatsApp.
|
|
780
|
+
|
|
781
|
+
`deeplink_payload`
|
|
782
|
+
|
|
783
|
+
_String_
|
|
784
|
+
|
|
785
|
+
Uma string arbitrária especificada no parâmetro de consulta `biz_payload` em um deep link de chamada. Só será retornado se a ligação tiver sido iniciada a partir de um link direto com esse parâmetro.
|
|
786
|
+
|
|
787
|
+
Para saber mais, consulte [Mensagens de botão de ligação e deep links](/documentation/business-messaging/whatsapp/calling/call-button-messages-deep-links#send-payload-data-in-call-deeplink).
|
|
788
|
+
|
|
789
|
+
`cta_payload`
|
|
790
|
+
|
|
791
|
+
_String_
|
|
792
|
+
|
|
793
|
+
A string arbitrária especificada no campo `payload` em um botão de chamada. Só será retornado se a ligação tiver sido iniciada em um botão de ligação com carga.
|
|
794
|
+
|
|
795
|
+
Para saber mais, consulte [Mensagens de botão de ligação e deep links](/documentation/business-messaging/whatsapp/calling/call-button-messages-deep-links#send-interactive-message-with-a-whatsapp-call-button).
|
|
796
|
+
|
|
797
|
+
`session`
|
|
798
|
+
|
|
799
|
+
_Objeto JSON_
|
|
800
|
+
|
|
801
|
+
**Opcional**
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
Contém o tipo de protocolo de descrição de sessão (SDP) e a descrição do idioma.
|
|
805
|
+
|
|
806
|
+
Exige dois valores:
|
|
807
|
+
|
|
808
|
+
`sdp_type` – (_String_) **Obrigatório**
|
|
809
|
+
|
|
810
|
+
"oferta", para indicar a oferta de SDP
|
|
811
|
+
|
|
812
|
+
`sdp` – (_String_) **Obrigatório**
|
|
813
|
+
|
|
814
|
+
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=AT0OM8mYiMxeia4jgqVROfnCu2VzgtNUr4nDEdW8WxpIra6FOgQ-KNSOVim5Lm-Xb3K_XpjnswpkhXsWAathaNGH7FdZc6tfkEhRyo-tD1yvSoCRdHD0zwTDauW5vgxAq1rCCvOr71zXEeebGjpI9Yo4xnk).
|
|
815
|
+
|
|
816
|
+
[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=AT0OM8mYiMxeia4jgqVROfnCu2VzgtNUr4nDEdW8WxpIra6FOgQ-KNSOVim5Lm-Xb3K_XpjnswpkhXsWAathaNGH7FdZc6tfkEhRyo-tD1yvSoCRdHD0zwTDauW5vgxAq1rCCvOr71zXEeebGjpI9Yo4xnk)
|
|
817
|
+
|
|
818
|
+
[Exemplo de estruturas SDP](/documentation/business-messaging/whatsapp/calling/reference#sdp-overview-and-sample-sdp-structures)
|
|
819
|
+
|
|
820
|
+
`contacts`
|
|
821
|
+
|
|
822
|
+
_Objeto JSON_
|
|
823
|
+
|
|
824
|
+
As informações de perfil do usuário que recebe a ligação.
|
|
825
|
+
|
|
826
|
+
Contém dois valores:
|
|
827
|
+
|
|
828
|
+
`name` – o nome do perfil do WhatsApp do destinatário da ligação.
|
|
829
|
+
|
|
830
|
+
`wa_id`: a identificação do WhatsApp do destinatário da ligação.
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
### Webhook de encerramento de ligação
|
|
835
|
+
|
|
836
|
+
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`.
|
|
837
|
+
|
|
838
|
+
```
|
|
839
|
+
{
|
|
840
|
+
"object": "whatsapp_business_account",
|
|
841
|
+
"entry": [
|
|
842
|
+
{
|
|
843
|
+
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
|
|
844
|
+
"changes": [
|
|
845
|
+
{
|
|
846
|
+
"value": {
|
|
847
|
+
"messaging_product": "whatsapp",
|
|
848
|
+
"metadata": {
|
|
849
|
+
"display_phone_number": "16505553602",
|
|
850
|
+
"phone_number_id": "<PHONE_NUMBER_ID>",
|
|
851
|
+
},
|
|
852
|
+
"calls": [
|
|
853
|
+
{
|
|
854
|
+
"id": "wacid.ABGGFjFVU2AfAgo6V-Hc5eCgK5Gh",
|
|
855
|
+
"to": "16315553601",
|
|
856
|
+
"from": "16315553602",
|
|
857
|
+
"event": "terminate"
|
|
858
|
+
"direction": "USER_INITIATED",
|
|
859
|
+
"deeplink_payload": "deeplink_payload",
|
|
860
|
+
"cta_payload": "cta_payload",
|
|
861
|
+
"biz_opaque_callback_data": "random_string",
|
|
862
|
+
"timestamp": "1671644824",
|
|
863
|
+
"status" : [FAILED | COMPLETED],
|
|
864
|
+
"start_time" : "1671644824",
|
|
865
|
+
"end_time" : "1671644944",
|
|
866
|
+
"duration" : 120
|
|
867
|
+
}
|
|
868
|
+
],
|
|
869
|
+
"errors": [
|
|
870
|
+
{
|
|
871
|
+
"code": INT_CODE,
|
|
872
|
+
"message": "ERROR_TITLE",
|
|
873
|
+
"href": "ERROR_HREF",
|
|
874
|
+
"error_data": {
|
|
875
|
+
"details": "ERROR_DETAILS"
|
|
876
|
+
}
|
|
877
|
+
}
|
|
878
|
+
]
|
|
879
|
+
},
|
|
880
|
+
"field": "calls"
|
|
881
|
+
}
|
|
882
|
+
]
|
|
883
|
+
}
|
|
884
|
+
]
|
|
885
|
+
}
|
|
886
|
+
```
|
|
887
|
+
|
|
888
|
+
#### Valores de webhook para `"calls"`
|
|
889
|
+
|
|
890
|
+
Espaço reservado
|
|
891
|
+
|
|
892
|
+
Descrição
|
|
893
|
+
|
|
894
|
+
`id`
|
|
895
|
+
|
|
896
|
+
_String_
|
|
897
|
+
|
|
898
|
+
Uma identificação única para a ligação
|
|
899
|
+
|
|
900
|
+
`to`
|
|
901
|
+
|
|
902
|
+
_Número inteiro_
|
|
903
|
+
|
|
904
|
+
O número que está sendo chamado (recebedor da chamada)
|
|
905
|
+
|
|
906
|
+
`from`
|
|
907
|
+
|
|
908
|
+
_Número inteiro_
|
|
909
|
+
|
|
910
|
+
O número de telefone da pessoa realizando a ligação
|
|
911
|
+
|
|
912
|
+
`event`
|
|
913
|
+
|
|
914
|
+
_Número inteiro_
|
|
915
|
+
|
|
916
|
+
Evento de ligação sobre o qual esse webhook está notificando o assinante
|
|
917
|
+
|
|
918
|
+
`timestamp`
|
|
919
|
+
|
|
920
|
+
_Número inteiro_
|
|
921
|
+
|
|
922
|
+
O registro de data e hora UNIX do evento de webhook
|
|
923
|
+
|
|
924
|
+
`direction`
|
|
925
|
+
|
|
926
|
+
_String_
|
|
927
|
+
|
|
928
|
+
A direção da ligação que está sendo feita.
|
|
929
|
+
|
|
930
|
+
Pode conter:
|
|
931
|
+
|
|
932
|
+
`BUSINESS_INITIATED`, para ligações iniciadas pela empresa.
|
|
933
|
+
|
|
934
|
+
`USER_INITIATED`, para chamadas iniciadas por um usuário do WhatsApp.
|
|
935
|
+
|
|
936
|
+
`deeplink_payload`
|
|
937
|
+
|
|
938
|
+
_String_
|
|
939
|
+
|
|
940
|
+
Uma string arbitrária especificada no parâmetro de consulta `biz_payload` em um deep link de chamada. Só será retornado se a ligação tiver sido iniciada a partir de um link direto com esse parâmetro.
|
|
941
|
+
|
|
942
|
+
Para saber mais, consulte [Mensagens de botão de ligação e deep links](/documentation/business-messaging/whatsapp/calling/call-button-messages-deep-links#send-payload-data-in-call-deeplink).
|
|
943
|
+
|
|
944
|
+
`cta_payload`
|
|
945
|
+
|
|
946
|
+
_String_
|
|
947
|
+
|
|
948
|
+
A string arbitrária especificada no campo `payload` em um botão de chamada. Só será retornado se a ligação tiver sido iniciada em um botão de ligação com carga.
|
|
949
|
+
|
|
950
|
+
Para saber mais, consulte [Mensagens de botão de ligação e deep links](/documentation/business-messaging/whatsapp/calling/call-button-messages-deep-links#send-interactive-message-with-a-whatsapp-call-button).
|
|
951
|
+
|
|
952
|
+
`start_time`
|
|
953
|
+
|
|
954
|
+
_Número inteiro_
|
|
955
|
+
|
|
956
|
+
O registro de data e hora Unix do início da ligação.
|
|
957
|
+
|
|
958
|
+
Presente apenas quando a ligação foi atendida pela outra parte.
|
|
959
|
+
|
|
960
|
+
`end_time`
|
|
961
|
+
|
|
962
|
+
_Número inteiro_
|
|
963
|
+
|
|
964
|
+
O registro de data e hora Unix do término da ligação.
|
|
965
|
+
|
|
966
|
+
Presente apenas quando a ligação foi atendida pela outra parte.
|
|
967
|
+
|
|
968
|
+
`duration`
|
|
969
|
+
|
|
970
|
+
_Número inteiro_
|
|
971
|
+
|
|
972
|
+
Duração da ligação em segundos.
|
|
973
|
+
|
|
974
|
+
Apenas quando a chamada foi atendida pela outra parte.
|
|
975
|
+
|
|
976
|
+
`biz_opaque_callback_date`
|
|
977
|
+
|
|
978
|
+
_String_
|
|
979
|
+
|
|
980
|
+
Uma string arbitrária que a empresa inclui na ligação para rastreamento e registro.
|
|
981
|
+
|
|
982
|
+
Só será retornado se fornecido por meio de uma [solicitação de início de ligação](/documentation/business-messaging/whatsapp/calling/reference#initiate-call) ou [solicitação de aceitação de ligação](/documentation/business-messaging/whatsapp/calling/user-initiated-calls#accept-call).
|
|
983
|
+
|
|
984
|
+
`errors.code`
|
|
985
|
+
|
|
986
|
+
_Número inteiro_
|
|
987
|
+
|
|
988
|
+
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).
|
|
989
|
+
|
|
990
|
+
## Suporte para DTMF (sinalização por tons múltiplos)
|
|
991
|
+
|
|
992
|
+
**O teclado de discagem fornecido pela API de Ligação só é compatível com casos de uso de DTMF.**
|
|
993
|
+
|
|
994
|
+
Não são compatíveis com ligações entre consumidores e não alteram outros comportamentos de ligação. Por exemplo, o teclado numérico não pode ser usado para discar um número e iniciar uma chamada ou mensagem no WhatsApp.
|
|
995
|
+
|
|
996
|
+
A API de Ligações Comerciais do WhatsApp é compatível com tons DTMF e permite que apps de BSP sejam compatíveis com sistemas baseados em IVR.
|
|
997
|
+
|
|
998
|
+
Os usuários do WhatsApp podem pressionar botões de tom no app do cliente, e esses tons DTMF são injetados no stream de RTP do WebRTC estabelecido como parte da conexão VoIP.
|
|
999
|
+
|
|
1000
|
+
Nosso stream WebRTC está em conformidade com o [RFC 4733](https://l.facebook.com/l.php?u=https%3A%2F%2Fdatatracker.ietf.org%2Fdoc%2Fhtml%2Frfc4733&h=AT0OM8mYiMxeia4jgqVROfnCu2VzgtNUr4nDEdW8WxpIra6FOgQ-KNSOVim5Lm-Xb3K_XpjnswpkhXsWAathaNGH7FdZc6tfkEhRyo-tD1yvSoCRdHD0zwTDauW5vgxAq1rCCvOr71zXEeebGjpI9Yo4xnk) para a transferência de dígitos DTMF por meio da carga do protocolo de transmissão em tempo real (RTP, pelas iniciais em inglês).
|
|
1001
|
+
|
|
1002
|
+
Não há webhooks para transmitir dígitos de DTMF.
|
|
1003
|
+
|
|
1004
|
+
### Taxa de bits do relógio de DTMF
|
|
1005
|
+
|
|
1006
|
+
Somente a velocidade de clock de 8.000 é compatível com nossos SDPs. Para ligações iniciadas pelo usuário, nossa oferta de SDP inclui apenas a velocidade de clock de 8.000. Para chamadas iniciadas pela sua empresa, esperamos que a velocidade de clock do SDP seja de 8.000. Mesmo que o campo esteja ausente, usaremos a velocidade de clock de 8.000 em relação ao tipo de carga 126.
|
|
1007
|
+
|
|
1008
|
+
Os pacotes RTP que representam eventos de DTMF usarão a mesma base de registro de data e hora e base de número de sequência que os pacotes de áudio normais. Por isso, não é necessário se preocupar com a diferença de velocidade de clock entre pacotes de áudio e de DTMF. O [campo de duração](https://l.facebook.com/l.php?u=https%3A%2F%2Fdatatracker.ietf.org%2Fdoc%2Fhtml%2Frfc4733%23section-2.3.5&h=AT0OM8mYiMxeia4jgqVROfnCu2VzgtNUr4nDEdW8WxpIra6FOgQ-KNSOVim5Lm-Xb3K_XpjnswpkhXsWAathaNGH7FdZc6tfkEhRyo-tD1yvSoCRdHD0zwTDauW5vgxAq1rCCvOr71zXEeebGjpI9Yo4xnk) do pacote DTMF é calculado usando 8.000 unidades de clock.
|
|
1009
|
+
|
|
1010
|
+
Não oferecemos suporte para a velocidade de clock de 48.000 para DTMF
|
|
1011
|
+
|
|
1012
|
+
### Envio de dígitos DTMF no cliente do WhatsApp para consumidores
|
|
1013
|
+
|
|
1014
|
+
Os apps de cliente do WhatsApp foram aprimorados e agora contam com um teclado numérico para ligações com os números de telefone comerciais da API de Nuvem. O usuário do WhatsApp pode pressionar os botões no teclado numérico e enviar tons DTMF.
|
|
1015
|
+
|
|
1016
|
+

|
|
1017
|
+
|
|
1018
|
+
## Visão geral e exemplos de estruturas SDP
|
|
1019
|
+
|
|
1020
|
+
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.
|
|
1021
|
+
|
|
1022
|
+
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.
|
|
1023
|
+
|
|
1024
|
+
[Ver exemplos de estruturas SDP para ligações iniciadas pelo usuário](/documentation/business-messaging/whatsapp/calling/reference#sdp-overview-and-sample-sdp-structures)
|
|
1025
|
+
|
|
1026
|
+
Você achou esta página útil?
|
|
1027
|
+
|
|
1028
|
+

|
|
1029
|
+
|
|
1030
|
+

|