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,672 @@
|
|
|
1
|
+
<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/calling/user-call-permissions -->
|
|
2
|
+
<!-- Scraped: 2025-12-20T17:40:52.691Z -->
|
|
3
|
+
|
|
4
|
+
# Obter permissões para ligação do usuário
|
|
5
|
+
|
|
6
|
+
Updated: 13 de nov de 2025
|
|
7
|
+
|
|
8
|
+
Em 3 de novembro de 2025, as permissões permanentes ficaram disponíveis. Os usuários agora podem conceder permissão contínua a uma empresa para fazer ligações. Os usuários podem analisar e alterar as permissões de ligação para uma empresa a qualquer momento no perfil comercial.
|
|
9
|
+
|
|
10
|
+
Os recursos relacionados à permissão de ligação estão disponíveis apenas em regiões onde a [ligação iniciada pela empresa está disponível](/documentation/business-messaging/whatsapp/calling#availability).
|
|
11
|
+
|
|
12
|
+
## Visão geral
|
|
13
|
+
|
|
14
|
+
Para fazer uma ligação para um usuário do WhatsApp, a empresa precisa receber a permissão do usuário primeiro. Quando um usuário do WhatsApp concede permissões para ligação, elas podem ser temporárias ou permanentes.
|
|
15
|
+
|
|
16
|
+
A empresa não tem controle sobre essa permissão, pois ela é concedida apenas pelo usuário e só pode ser revogada por ele a qualquer momento. Os dados de permissão permanente serão armazenados até a revogação.
|
|
17
|
+
|
|
18
|
+
É possível obter a permissão para ligação de um usuário do WhatsApp das seguintes maneiras:
|
|
19
|
+
|
|
20
|
+
- **Envie uma solicitação de permissão para ligação ao usuário** – envie uma mensagem de formato livre ou com modelo pedindo permissão para ligação ao usuário. O usuário pode escolher entre as opções temporário ou permanente.- **A permissão de retorno de ligação é fornecida pelo usuário do WhatsApp** – o usuário do WhatsApp fornece automaticamente permissões para ligação temporárias ao fazer uma ligação para a empresa. A [configuração de retorno de ligação deve estar habilitada](/documentation/business-messaging/whatsapp/calling/call-settings#configure-update-business-phone-number-calling-settings) no número de telefone comercial.- **O usuário do WhatsApp concede permissão para ligação por meio do perfil empresarial**: o usuário do WhatsApp concede permissão para ligação à empresa por meio do próprio perfil empresarial.
|
|
21
|
+
|
|
22
|
+
### Limites (por par de empresas + usuários do WhatsApp)
|
|
23
|
+
|
|
24
|
+
- As permissões temporárias são **concedidas por sete dias corridos (168 horas)**
|
|
25
|
+
- Calculado como o número de segundos em um dia multiplicado por sete, a partir do momento de aprovação do usuário.- As permissões permanentes não expiram, mas têm o mesmo limite de ligações conectadas.- A empresa pode fazer apenas **dez ligações conectadas a cada 24 horas**- Esses limites se aplicam ao **número de telefone comercial**
|
|
26
|
+
|
|
27
|
+
Esses limites são impostos para proteger os usuários do WhatsApp contra ligações indesejadas.
|
|
28
|
+
|
|
29
|
+
Quando você testa a integração da API de Ligação do WhatsApp usando números de teste públicos (PTNs) e contas de sandbox, as restrições da API de Ligações são flexibilizadas.
|
|
30
|
+
|
|
31
|
+
[Teste a integração da API de Ligação do WhatsApp](/documentation/business-messaging/whatsapp/calling#testing-and-sandbox-accounts)
|
|
32
|
+
|
|
33
|
+
## Noções básicas sobre a solicitação de permissão para ligação
|
|
34
|
+
|
|
35
|
+
Você pode solicitar permissão para ligação de um usuário do WhatsApp de forma proativa por meio do envio de uma mensagem de solicitação de permissão como:
|
|
36
|
+
|
|
37
|
+
- Mensagem interativa de formato livre- Mensagem de modelo
|
|
38
|
+
|
|
39
|
+
O usuário do WhatsApp pode aprovar (de forma temporária ou permanente), recusar ou simplesmente não responder a uma solicitação de permissão para ligação.
|
|
40
|
+
|
|
41
|
+
**Com as permissões, o usuário do WhatsApp está no controle.** Mesmo que o usuário conceda permissão para realizar a ligação, ele pode revogá-la a qualquer momento. Por outro lado, se o usuário recusar uma solicitação, ele ainda poderá conceder permissão para fazer ligações até o vencimento da solicitação.
|
|
42
|
+
|
|
43
|
+
**Uma solicitação de permissão para ligação expira** quando ocorre um dos seguintes casos:
|
|
44
|
+
|
|
45
|
+
- O usuário do WhatsApp interage com uma nova solicitação de permissão para ligação subsequente da empresa- Sete dias após a permissão ter sido aceita ou recusada pelo consumidor- Sete dias depois da entrega da permissão, se o consumidor não responder à solicitação
|
|
46
|
+
|
|
47
|
+
[Veja o comportamento da interface do usuário do cliente em relação às solicitações de permissão expiradas](/documentation/business-messaging/whatsapp/calling/user-call-permissions#call-permission-request-expiration-scenarios)
|
|
48
|
+
|
|
49
|
+
Para garantir uma experiência do usuário ideal em ligações iniciadas pela empresa, aplicamos os seguintes limites:
|
|
50
|
+
|
|
51
|
+
- **Ao enviar uma mensagem de solicitação de permissão para ligação**
|
|
52
|
+
|
|
53
|
+
- Máximo de uma solicitação de permissão em 24 horas- Máximo de duas solicitações de permissão em sete dias
|
|
54
|
+
|
|
55
|
+
- _Esses limites são reiniciados quando uma ligação conectada (iniciada pela empresa/iniciada pelo usuário) é feita entre a empresa e o usuário do WhatsApp._- _Esses limites se aplicam a solicitações de permissão enviadas como mensagens de formato livre ou de modelo._- **Quando a empresa iniciou a ligação, mas não recebeu uma resposta ou a ligação foi recusada**
|
|
56
|
+
- Duas ligações não respondidas consecutivas resultam em uma mensagem do sistema para reconsiderar uma permissão aprovada.- Se houver quatro ligações não respondidas consecutivas, a permissão aprovada será revogada automaticamente. O usuário poderá atualizar isso novamente se quiser.
|
|
57
|
+
|
|
58
|
+
[Observe o comportamento da interface do usuário do cliente em relação a ligações não respondidas consecutivas](/documentation/business-messaging/whatsapp/calling/user-call-permissions#consecutive-unanswered-calls)
|
|
59
|
+
|
|
60
|
+
## Comparação entre mensagem de solicitação de permissão para ligação de modelo e de formato livre
|
|
61
|
+
|
|
62
|
+
As mensagens de solicitação de permissão para ligação estão sujeitas a [taxas de mensagens](/documentation/business-messaging/whatsapp/pricing)
|
|
63
|
+
|
|
64
|
+
É possível enviar uma mensagem de solicitação de permissão para ligação a usuários de uma das seguintes maneiras:
|
|
65
|
+
|
|
66
|
+
**Envie uma mensagem de formato livre**
|
|
67
|
+
|
|
68
|
+
- Quando você estiver em uma janela de atendimento ao cliente com um usuário do WhatsApp, será possível enviar uma mensagem de formato livre com uma solicitação de permissão para ligação.- Embora o corpo de texto seja opcional, envie um para criar contexto com o usuário. No caso das mensagens de solicitação de permissão para ligação de formato livre, as seções de cabeçalho e rodapé não são compatíveis.- Como a janela de atendimento ao cliente está aberta, não é preciso criar uma janela de conversa.
|
|
69
|
+
|
|
70
|
+
**Crie e envie uma mensagem de modelo**
|
|
71
|
+
|
|
72
|
+
- Com o envio de mensagem de modelo, você inicia uma conversa com o usuário por meio de uma solicitação de permissão para ligação.- O contexto (ou seja, um corpo de texto) é necessário ao enviar uma mensagem de modelo com uma solicitação de permissão para ligação.- Com as mensagens de modelo, é possível personalizar ainda mais a solicitação de permissão ao adicionar cabeçalho e rodapé.
|
|
73
|
+
|
|
74
|
+

|
|
75
|
+
|
|
76
|
+
## Experiência na interface do usuário do app do cliente
|
|
77
|
+
|
|
78
|
+
### Fluxo de solicitação de permissão para ligação e exemplos de mensagens
|
|
79
|
+
|
|
80
|
+
#### Permitir ligações
|
|
81
|
+
|
|
82
|
+

|
|
83
|
+
|
|
84
|
+
#### Permitir ligações temporariamente
|
|
85
|
+
|
|
86
|
+

|
|
87
|
+
|
|
88
|
+
### Mensagem de modelo
|
|
89
|
+
|
|
90
|
+
Com cabeçalho, rodapé e corpo 
|
|
91
|
+
|
|
92
|
+
Somente com corpo 
|
|
93
|
+
|
|
94
|
+
Sem corpo de texto 
|
|
95
|
+
|
|
96
|
+
#### Tipos de mensagens de formato livre
|
|
97
|
+
|
|
98
|
+
Sem corpo de texto 
|
|
99
|
+
|
|
100
|
+
Somente com corpo de texto 
|
|
101
|
+
|
|
102
|
+
### Atualizar a permissão para ligação no perfil empresarial
|
|
103
|
+
|
|
104
|
+
Os usuários sempre têm a opção de alterar a permissão usando uma nova opção no perfil empresarial.
|
|
105
|
+
|
|
106
|
+
Atualizar a permissão para ligação no perfil empresarial
|
|
107
|
+
|
|
108
|
+

|
|
109
|
+
|
|
110
|
+
### Ligações não respondidas consecutivas
|
|
111
|
+
|
|
112
|
+
Ligações não respondidas consecutivas
|
|
113
|
+
|
|
114
|
+
Duas ligações não respondidas consecutivas – mensagem do sistema para o usuário atualizar a permissão
|
|
115
|
+
|
|
116
|
+

|
|
117
|
+
|
|
118
|
+
Quatro ligações não respondidas consecutivas – permissões revogadas automaticamente
|
|
119
|
+
|
|
120
|
+

|
|
121
|
+
|
|
122
|
+
### Cenários de expiração da solicitação de permissão para ligação
|
|
123
|
+
|
|
124
|
+
A solicitação de permissão expira após sete dias – o usuário interage com a solicitação 
|
|
125
|
+
|
|
126
|
+
A solicitação de permissão expira após sete dias – o usuário não interage 
|
|
127
|
+
|
|
128
|
+
A permissão anterior expira imediatamente – o usuário não interage/uma nova solicitação de permissão para ligação é recebida 
|
|
129
|
+
|
|
130
|
+
A solicitação de permissão anterior expira imediatamente – o usuário permite/interage com a nova solicitação 
|
|
131
|
+
|
|
132
|
+
## Enviar mensagem de solicitação de permissão de ligação de formato livre
|
|
133
|
+
|
|
134
|
+
As mensagens de solicitação de permissão para ligação estão sujeitas a [taxas de mensagens](/documentation/business-messaging/whatsapp/pricing)
|
|
135
|
+
|
|
136
|
+
Use este ponto de extremidade para enviar uma mensagem interativa em formato livre com uma solicitação de permissão de ligação durante uma [janela de atendimento ao cliente](/documentation/business-messaging/whatsapp/messages/send-messages#customer-service-windows). Um [webhook de status de mensagem](/documentation/business-messaging/whatsapp/webhooks/reference/messages/status) padrão será enviado em resposta a essa mensagem.
|
|
137
|
+
|
|
138
|
+
**Observação:** o objeto interativo de solicitação de permissão para ligação não pode ser editado pela empresa. Apenas o corpo da mensagem pode ser personalizado.
|
|
139
|
+
|
|
140
|
+
[Veja como a mensagem é renderizada no cliente do WhatsApp](/documentation/business-messaging/whatsapp/calling/user-call-permissions#call-permission-request-flow-and-sample-messages)
|
|
141
|
+
|
|
142
|
+
#### Sintaxe da solicitação
|
|
143
|
+
|
|
144
|
+
```
|
|
145
|
+
POST <PHONE_NUMBER_ID>/messages
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Parâmetro
|
|
149
|
+
|
|
150
|
+
Descrição
|
|
151
|
+
|
|
152
|
+
Exemplo de valor
|
|
153
|
+
|
|
154
|
+
`<PHONE_NUMBER_ID>`
|
|
155
|
+
|
|
156
|
+
_Número inteiro_
|
|
157
|
+
|
|
158
|
+
**Obrigatório**
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
O número de telefone comercial do qual você está enviando mensagens.
|
|
162
|
+
|
|
163
|
+
[Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/whatsapp-business-account-phone-number-api)
|
|
164
|
+
|
|
165
|
+
`+18274459827`
|
|
166
|
+
|
|
167
|
+
#### Corpo da solicitação
|
|
168
|
+
|
|
169
|
+
```
|
|
170
|
+
{
|
|
171
|
+
"messaging_product": "whatsapp",
|
|
172
|
+
"recipient_type": "individual",
|
|
173
|
+
"to": "<PHONE_NUMBER_ID> or <WHATSAPP_ID>",
|
|
174
|
+
"type": "interactive",
|
|
175
|
+
"interactive": {
|
|
176
|
+
"type": "call_permission_request",
|
|
177
|
+
"action": {
|
|
178
|
+
"name": "call_permission_request"
|
|
179
|
+
},
|
|
180
|
+
"body": {
|
|
181
|
+
"text": "We would like to call you to help support your query on Order No: ON-12853."
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
#### Parâmetros do corpo
|
|
188
|
+
|
|
189
|
+
Parâmetro
|
|
190
|
+
|
|
191
|
+
Descrição
|
|
192
|
+
|
|
193
|
+
Exemplo de valor
|
|
194
|
+
|
|
195
|
+
`to`
|
|
196
|
+
|
|
197
|
+
_Número inteiro_
|
|
198
|
+
|
|
199
|
+
**Obrigatório**
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
O número de telefone do usuário do WhatsApp que está recebendo a mensagem.
|
|
203
|
+
|
|
204
|
+
[Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/whatsapp-business-account-phone-number-api)
|
|
205
|
+
|
|
206
|
+
`+17863476655`
|
|
207
|
+
|
|
208
|
+
`type`
|
|
209
|
+
|
|
210
|
+
_String_
|
|
211
|
+
|
|
212
|
+
**Obrigatório**
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
O tipo de mensagem interativa que você está enviando.
|
|
216
|
+
|
|
217
|
+
Nesse caso, você está enviando uma `call_permission_request`.
|
|
218
|
+
|
|
219
|
+
[Saiba mais sobre mensagens interativas](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/message-api)
|
|
220
|
+
|
|
221
|
+
`“call_permission_request”`
|
|
222
|
+
|
|
223
|
+
`action`
|
|
224
|
+
|
|
225
|
+
_String_
|
|
226
|
+
|
|
227
|
+
**Obrigatório**
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
A ação da mensagem interativa.
|
|
231
|
+
|
|
232
|
+
Deve ser `call_permission_request`.
|
|
233
|
+
|
|
234
|
+
`“call_permission_request”`
|
|
235
|
+
|
|
236
|
+
`body`
|
|
237
|
+
|
|
238
|
+
_String_
|
|
239
|
+
|
|
240
|
+
**Opcional**
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
O corpo da mensagem.
|
|
244
|
+
|
|
245
|
+
Embora o campo seja opcional, recomendamos que você informe o contexto ao usuário do WhatsApp quando solicitar permissão para fazer a ligação.
|
|
246
|
+
|
|
247
|
+
`“Allow us to call you so we can support you with your order.`
|
|
248
|
+
|
|
249
|
+
#### Resposta de sucesso
|
|
250
|
+
|
|
251
|
+
```
|
|
252
|
+
{ "messaging_product": "whatsapp", "contacts": [{ "input": "+1-408-555-1234", "wa_id": "14085551234", }] "messages": [{ "id": "wamid.gBGGFlaCmZ9plHrf2Mh-o", }]}
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
[_Saiba mais sobre respostas bem-sucedidas de mensagens_](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/message-api)
|
|
256
|
+
|
|
257
|
+
#### Resposta de erro
|
|
258
|
+
|
|
259
|
+
Veja os problemas que podem ocorrer:
|
|
260
|
+
|
|
261
|
+
- `phone-number-id` inválido- Erros de permissão/autorização- Limite de volume atingido- O envio dessa mensagem a versões mais antigas do app resultará em um webhook de erro com o código de erro [131026](/documentation/business-messaging/whatsapp/support/error-codes)- Ligações não habilitadas- Erros de restrição de ligações
|
|
262
|
+
|
|
263
|
+
[Veja os códigos de erro gerais da API de Nuvem aqui](/documentation/business-messaging/whatsapp/support/error-codes)
|
|
264
|
+
|
|
265
|
+
## Criar e enviar mensagens de modelo de solicitação de permissão para ligação
|
|
266
|
+
|
|
267
|
+
As mensagens de solicitação de permissão para ligação estão sujeitas a [taxas de mensagens](/documentation/business-messaging/whatsapp/pricing)
|
|
268
|
+
|
|
269
|
+
Use estes pontos de extremidade para criar e enviar um modelo de mensagem de solicitação de permissão para ligação.
|
|
270
|
+
|
|
271
|
+
Depois que o modelo de solicitação de permissão for criado, a empresa poderá enviá-lo ao usuário como uma solicitação de permissão para ligação fora da janela de atendimento ao cliente.
|
|
272
|
+
|
|
273
|
+
[Saiba mais sobre como criar e gerenciar modelos de mensagem](/documentation/business-messaging/whatsapp/templates/overview)
|
|
274
|
+
|
|
275
|
+
### Criar modelo de mensagem
|
|
276
|
+
|
|
277
|
+
Use este ponto de extremidade para criar um modelo de mensagem de solicitação de permissão para ligação.
|
|
278
|
+
|
|
279
|
+
#### Sintaxe da solicitação
|
|
280
|
+
|
|
281
|
+
```
|
|
282
|
+
POST/<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
Parâmetro
|
|
286
|
+
|
|
287
|
+
Descrição
|
|
288
|
+
|
|
289
|
+
Exemplo de valor
|
|
290
|
+
|
|
291
|
+
`<WHATSAPP_BUSINESS_ACCOUNT_ID>`
|
|
292
|
+
|
|
293
|
+
_String_
|
|
294
|
+
|
|
295
|
+
**Obrigatório**
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
A identificação da sua conta do WhatsApp Business.
|
|
299
|
+
|
|
300
|
+
[Saiba como encontrar a identificação da sua WABA](/documentation/business-messaging/whatsapp/reference/whatsapp-business-account/whatsapp-business-account-api)
|
|
301
|
+
|
|
302
|
+
`“waba-90172398162498126”`
|
|
303
|
+
|
|
304
|
+
#### Corpo da solicitação
|
|
305
|
+
|
|
306
|
+
```
|
|
307
|
+
{ "name": "sample_cpr_template", "language": "en", "category": "[MARKETING|UTILITY]", "components": [ { "type": "HEADER", "text": "Support of Order No: {{1}}", "example": { "body_text": [ [ "ON-12345" ] ] } }, { "type": "BODY", "text": "We would like to call you to help support your query on Order No: {{1}} for the item {{2}}.", "example": { "body_text": [ [ "ON-12345", "Avocados" ] ] } }, { "type": "FOOTER", "text": "Talk to you soon!" }, { "type": "call_permission_request" } ]}
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
#### Parâmetros do corpo
|
|
311
|
+
|
|
312
|
+
As mensagens de modelo podem ser criadas e gerenciadas por meio da API de Nuvem ou da interface do Gerenciador do WhatsApp Business.
|
|
313
|
+
|
|
314
|
+
Ao criar seu modelo de solicitação de permissão para ligação, configure `type` como `call_permission_request`.
|
|
315
|
+
|
|
316
|
+
[Saiba mais sobre como criar e gerenciar modelos de mensagem](/documentation/business-messaging/whatsapp/templates/overview)
|
|
317
|
+
|
|
318
|
+
Parâmetro
|
|
319
|
+
|
|
320
|
+
Descrição
|
|
321
|
+
|
|
322
|
+
Exemplo de valor
|
|
323
|
+
|
|
324
|
+
`type`
|
|
325
|
+
|
|
326
|
+
_String_
|
|
327
|
+
|
|
328
|
+
**Obrigatório**
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
O tipo de modelo de mensagem que você está criando.
|
|
332
|
+
|
|
333
|
+
Nesse caso, você está criando uma `call_permission_request`.
|
|
334
|
+
|
|
335
|
+
`“call_permission_request”`
|
|
336
|
+
|
|
337
|
+
#### Resposta de status do modelo
|
|
338
|
+
|
|
339
|
+
```
|
|
340
|
+
{
|
|
341
|
+
"id": "<ID>",
|
|
342
|
+
"status": "<STATUS>",
|
|
343
|
+
"category": "<CATEGORY>"
|
|
344
|
+
}
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
[_Saiba mais sobre a resposta ao status do modelo_](/documentation/business-messaging/whatsapp/templates/overview#template-status)
|
|
348
|
+
|
|
349
|
+
#### Resposta de erro
|
|
350
|
+
|
|
351
|
+
Veja os problemas que podem ocorrer:
|
|
352
|
+
|
|
353
|
+
- ID da WABA inválido- Erros de permissão/autorização- Alertas de validação de componentes/estrutura do modelo
|
|
354
|
+
|
|
355
|
+
[Veja os códigos de erro gerais da API de Nuvem aqui](/documentation/business-messaging/whatsapp/support/error-codes)
|
|
356
|
+
|
|
357
|
+
### Enviar modelo de mensagem
|
|
358
|
+
|
|
359
|
+
Use este ponto de extremidade para enviar um modelo de mensagem de solicitação de permissão para ligação
|
|
360
|
+
|
|
361
|
+
Veja a seguir um exemplo simplificado de solicitação de envio de modelo de mensagem. [Saiba mais sobre como enviar modelos de mensagem aqui.](/documentation/business-messaging/whatsapp/messages/template-messages)
|
|
362
|
+
|
|
363
|
+
#### Sintaxe da solicitação
|
|
364
|
+
|
|
365
|
+
```
|
|
366
|
+
POST/<PHONE_NUMBER_ID>/messages
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
Parâmetro
|
|
370
|
+
|
|
371
|
+
Descrição
|
|
372
|
+
|
|
373
|
+
Exemplo de valor
|
|
374
|
+
|
|
375
|
+
`<PHONE_NUMBER_ID>`
|
|
376
|
+
|
|
377
|
+
_String_
|
|
378
|
+
|
|
379
|
+
**Obrigatório**
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
O número de telefone comercial do qual você está enviando a mensagem.
|
|
383
|
+
|
|
384
|
+
[Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/whatsapp-business-account-phone-number-api)
|
|
385
|
+
|
|
386
|
+
`+18762639988`
|
|
387
|
+
|
|
388
|
+
#### Corpo da solicitação
|
|
389
|
+
|
|
390
|
+
```
|
|
391
|
+
{
|
|
392
|
+
"messaging_product": "whatsapp",
|
|
393
|
+
"recipient_type": "individual",
|
|
394
|
+
"to": "+13287759822", // The WhatsApp user who will receive the template message
|
|
395
|
+
"type": "template",
|
|
396
|
+
"template": {
|
|
397
|
+
"name": "sample_cpr_template", // The call permission request template name
|
|
398
|
+
"language": {
|
|
399
|
+
"code": "en"
|
|
400
|
+
},
|
|
401
|
+
"components": [ // Body text parameters such as customer name and order number
|
|
402
|
+
{
|
|
403
|
+
"type": "body",
|
|
404
|
+
"parameters": [
|
|
405
|
+
{
|
|
406
|
+
"type": "text",
|
|
407
|
+
"text": "John Smith"
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"type": "text",
|
|
411
|
+
"text": "order #1522"
|
|
412
|
+
}
|
|
413
|
+
]
|
|
414
|
+
}
|
|
415
|
+
]
|
|
416
|
+
}
|
|
417
|
+
}
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
[Saiba mais sobre como enviar mensagens de modelo](/documentation/business-messaging/whatsapp/messages/template-messages)
|
|
421
|
+
|
|
422
|
+
## Verificar o estado atual da permissão para ligações
|
|
423
|
+
|
|
424
|
+
Use este ponto de extremidade para verificar o estado da permissão para ligação entre um número comercial e um único número de telefone de usuário do WhatsApp.
|
|
425
|
+
|
|
426
|
+
### Sintaxe da solicitação
|
|
427
|
+
|
|
428
|
+
```
|
|
429
|
+
GET /<PHONE_NUMBER_ID>/call_permissions?user_wa_id=<CONSUMER_WHATSAPP_ID>
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
### Parâmetros de solicitação
|
|
433
|
+
|
|
434
|
+
Parâmetro
|
|
435
|
+
|
|
436
|
+
Descrição
|
|
437
|
+
|
|
438
|
+
Exemplo de valor
|
|
439
|
+
|
|
440
|
+
`<PHONE_NUMBER_ID>`
|
|
441
|
+
|
|
442
|
+
_String_
|
|
443
|
+
|
|
444
|
+
**Obrigatório**
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
O número de telefone comercial para o qual você está buscando permissões.
|
|
448
|
+
|
|
449
|
+
[Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/whatsapp-business-account-phone-number-api)
|
|
450
|
+
|
|
451
|
+
`+18762639988`
|
|
452
|
+
|
|
453
|
+
`<CONSUMER_WHATSAPP_ID>`
|
|
454
|
+
|
|
455
|
+
_Número inteiro_
|
|
456
|
+
|
|
457
|
+
**Obrigatório**
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
O número de telefone do usuário do WhatsApp de quem você está solicitando permissões para ligação.
|
|
461
|
+
|
|
462
|
+
[Saiba mais sobre a formatação de números de telefone na API de Nuvem](/documentation/business-messaging/whatsapp/reference/whatsapp-business-phone-number/whatsapp-business-account-phone-number-api)
|
|
463
|
+
|
|
464
|
+
`+13057765456`
|
|
465
|
+
|
|
466
|
+
#### Corpo da resposta
|
|
467
|
+
|
|
468
|
+
```
|
|
469
|
+
{
|
|
470
|
+
"messaging_product": "whatsapp",
|
|
471
|
+
"permission": {
|
|
472
|
+
"status": "temporary",
|
|
473
|
+
"expiration_time": 1745343479
|
|
474
|
+
},
|
|
475
|
+
"actions": [
|
|
476
|
+
{
|
|
477
|
+
"action_name": "send_call_permission_request",
|
|
478
|
+
"can_perform_action": true,
|
|
479
|
+
"limits": [
|
|
480
|
+
{
|
|
481
|
+
"time_period": "PT24H",
|
|
482
|
+
"max_allowed": 1,
|
|
483
|
+
"current_usage": 0,
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"time_period": "P7D",
|
|
487
|
+
"max_allowed": 2,
|
|
488
|
+
"current_usage": 1,
|
|
489
|
+
}
|
|
490
|
+
]
|
|
491
|
+
},
|
|
492
|
+
{
|
|
493
|
+
"action_name": "start_call",
|
|
494
|
+
"can_perform_action": false,
|
|
495
|
+
"limits": [
|
|
496
|
+
{
|
|
497
|
+
"time_period": "PT24H",
|
|
498
|
+
"max_allowed": 5,
|
|
499
|
+
"current_usage": 5,
|
|
500
|
+
"limit_expiration_time": 1745622600,
|
|
501
|
+
}
|
|
502
|
+
]
|
|
503
|
+
}
|
|
504
|
+
}
|
|
505
|
+
}
|
|
506
|
+
```
|
|
507
|
+
|
|
508
|
+
#### Parâmetros da resposta
|
|
509
|
+
|
|
510
|
+
Parâmetro
|
|
511
|
+
|
|
512
|
+
Descrição
|
|
513
|
+
|
|
514
|
+
`permission`
|
|
515
|
+
|
|
516
|
+
_Objeto JSON_
|
|
517
|
+
|
|
518
|
+
O objeto de permissão contém dois valores:
|
|
519
|
+
|
|
520
|
+
`status`_(String)_ – o status atual da permissão.
|
|
521
|
+
|
|
522
|
+
Pode ser:
|
|
523
|
+
|
|
524
|
+
- `“no_permission”`- `"temporary"`- `“permanent”`
|
|
525
|
+
|
|
526
|
+
`expiration`_(Número inteiro)_ – o horário Unix em que a permissão expirará no fuso horário UTC.
|
|
527
|
+
|
|
528
|
+
Se a permissão for permanente, o campo não aparecerá.
|
|
529
|
+
|
|
530
|
+
`actions`
|
|
531
|
+
|
|
532
|
+
_Objeto JSON_
|
|
533
|
+
|
|
534
|
+
É a lista de ações que um número de telefone comercial pode realizar para facilitar uma permissão de ligação ou uma ligação iniciada pela empresa.
|
|
535
|
+
|
|
536
|
+
As ações atuais são:
|
|
537
|
+
|
|
538
|
+
`send_call_permission_request`: representa a ação de envio de novas mensagens de solicitação de permissão de ligação para o usuário do WhatsApp.
|
|
539
|
+
|
|
540
|
+
`start_call`: representa a ação de estabelecer uma nova ligação com o usuário do WhatsApp. Estabelecer uma nova ligação indica que a ligação foi atendida pelo consumidor.
|
|
541
|
+
|
|
542
|
+
Por exemplo, se `send_call_permission_request` tiver `can_perform_action` definido como `true`, isso significa que a empresa pode enviar uma solicitação de permissão para ligação ao usuário do WhatsApp em questão.
|
|
543
|
+
|
|
544
|
+
`can_perform_action` (_Booleano_) –
|
|
545
|
+
|
|
546
|
+
uma sinalização que indica se a ação pode ser realizada agora, levando em consideração todos os limites.
|
|
547
|
+
|
|
548
|
+
`limits`
|
|
549
|
+
|
|
550
|
+
_Objeto JSON_
|
|
551
|
+
|
|
552
|
+
Uma lista de restrições com limite de tempo para determinada ação `action_name`.
|
|
553
|
+
|
|
554
|
+
Cada `action_name` tem uma ou mais restrições, dependendo do período.
|
|
555
|
+
|
|
556
|
+
Por exemplo, uma empresa só pode enviar duas solicitações de permissão em um período de 24 horas.
|
|
557
|
+
|
|
558
|
+
`limits` contém os seguintes campos:
|
|
559
|
+
|
|
560
|
+
`time_period` (_String_) – o período em que o limite se aplica, representado no formato ISO 8601.
|
|
561
|
+
|
|
562
|
+
`max_allowed` (_Número inteiro_) – o número máximo de ações permitidas no período especificado.
|
|
563
|
+
|
|
564
|
+
`current_usage` (_Número inteiro_) – o número atual de ações realizadas pela empresa no período especificado.
|
|
565
|
+
|
|
566
|
+
`limit_expiration_time` (_Número inteiro_) – o horário Unix em que o limite expirará no fuso horário UTC.
|
|
567
|
+
|
|
568
|
+
Se `current_usage` estiver abaixo do limite máximo permitido, o campo não aparecerá.
|
|
569
|
+
|
|
570
|
+
#### Resposta de erro
|
|
571
|
+
|
|
572
|
+
Veja os problemas que podem ocorrer:
|
|
573
|
+
|
|
574
|
+
- `phone-number-id` inválido- Se não for possível ligar para o número de telefone do consumidor, a resposta da API será `no_permission`.- Erros de permissão/autorização.- O limite de volume foi atingido. É possível fazer um máximo de cinco solicitações em uma janela de um segundo à API.- As ligações não estão habilitadas para o número de telefone comercial.
|
|
575
|
+
|
|
576
|
+
[Consulte Códigos de erro e solução de problemas da API de Ligações para saber mais](/documentation/business-messaging/whatsapp/calling/troubleshooting)
|
|
577
|
+
|
|
578
|
+
[Veja os códigos de erro gerais da API de Nuvem aqui](/documentation/business-messaging/whatsapp/support/error-codes)
|
|
579
|
+
|
|
580
|
+
## Webhook de solicitação de permissão para ligação do usuário
|
|
581
|
+
|
|
582
|
+
Esse webhook é retornado após solicitar as permissões para ligação do usuário.
|
|
583
|
+
|
|
584
|
+
O webhook muda dependendo do que o usuário faz:
|
|
585
|
+
|
|
586
|
+
- aceita ou rejeita a solicitação- concede permissão respondendo a uma solicitação ou ligando para a empresa
|
|
587
|
+
|
|
588
|
+
Por fim, o usuário pode conceder permissão permanente para ligação à empresa, o que é representado no parâmetro `is_permanent` abaixo.
|
|
589
|
+
|
|
590
|
+
#### Exemplo de webhook
|
|
591
|
+
|
|
592
|
+
```
|
|
593
|
+
{
|
|
594
|
+
. . .
|
|
595
|
+
|
|
596
|
+
"messages": [{
|
|
597
|
+
"from": "{customer_phone_number}",
|
|
598
|
+
"id": "wamid.sH0kFlaCGg0xcvZbgmg90lHrg2dL",
|
|
599
|
+
"timestamp": "{timestamp}",
|
|
600
|
+
"context": {
|
|
601
|
+
"from": "{customer_phone_number}",
|
|
602
|
+
"id": "wacid.gBGGFlaCmZ9plHrf2Mh-o"
|
|
603
|
+
},
|
|
604
|
+
"interactive": {
|
|
605
|
+
"type": "call_permission_reply",
|
|
606
|
+
"call_permission_reply": {
|
|
607
|
+
"response":"accept",
|
|
608
|
+
"is_permanent":false,
|
|
609
|
+
"expiration_timestamp": "{timestamp}",
|
|
610
|
+
"response_source": "[user_action|automatic]"
|
|
611
|
+
}
|
|
612
|
+
}
|
|
613
|
+
],
|
|
614
|
+
. . .
|
|
615
|
+
}
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
#### Valores de webhook
|
|
619
|
+
|
|
620
|
+
Espaço reservado
|
|
621
|
+
|
|
622
|
+
Descrição
|
|
623
|
+
|
|
624
|
+
`customer_phone_number`
|
|
625
|
+
|
|
626
|
+
_String_
|
|
627
|
+
|
|
628
|
+
O número de telefone do cliente
|
|
629
|
+
|
|
630
|
+
`context.id`
|
|
631
|
+
|
|
632
|
+
_String_
|
|
633
|
+
|
|
634
|
+
Pode ser um dos dois valores
|
|
635
|
+
|
|
636
|
+
- A identificação da mensagem de solicitação de permissão enviada pela empresa para o número do cliente. Mostra quando uma decisão de permissão é tomada pelo usuário em resposta a uma solicitação de permissão para ligação.- A identificação da ligação perdida feita pela empresa para o número do cliente. Mostra quando a permissão de retorno de ligação está habilitada nas configurações e o usuário faz uma ligação para a empresa.
|
|
637
|
+
|
|
638
|
+
`response`
|
|
639
|
+
|
|
640
|
+
_String_
|
|
641
|
+
|
|
642
|
+
A resposta dos usuários do WhatsApp à mensagem de solicitação de permissão para ligação.
|
|
643
|
+
|
|
644
|
+
Pode ser `accept` ou `reject`.
|
|
645
|
+
|
|
646
|
+
`is_permanent`
|
|
647
|
+
|
|
648
|
+
_Booliano_
|
|
649
|
+
|
|
650
|
+
Indica se a permissão é permanente ou não. Para permissão temporária, o valor será sempre "false".
|
|
651
|
+
|
|
652
|
+
`expiration_timestamp`
|
|
653
|
+
|
|
654
|
+
_Número inteiro_
|
|
655
|
+
|
|
656
|
+
Tempo, em segundos, até que a permissão desta ligação expire, caso o usuário do WhatsApp a tenha aprovado.
|
|
657
|
+
|
|
658
|
+
`response_source`
|
|
659
|
+
|
|
660
|
+
_String_
|
|
661
|
+
|
|
662
|
+
A fonte da permissão
|
|
663
|
+
|
|
664
|
+
Os valores possíveis para permissões para ligação aceitas são:
|
|
665
|
+
|
|
666
|
+
- `user_action`: o usuário aprovou ou rejeitou a permissão- `automatic`: aprovação automática de permissão devido ao usuário do WhatsApp ter iniciado a ligação
|
|
667
|
+
|
|
668
|
+
Você achou esta página útil?
|
|
669
|
+
|
|
670
|
+

|
|
671
|
+
|
|
672
|
+

|