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,1059 @@
|
|
|
1
|
+
<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/groups/reference -->
|
|
2
|
+
<!-- Scraped: 2025-12-20T17:42:35.220Z -->
|
|
3
|
+
|
|
4
|
+
# Gerenciamento de grupos
|
|
5
|
+
|
|
6
|
+
Updated: 14 de nov de 2025
|
|
7
|
+
|
|
8
|
+
## Visão geral
|
|
9
|
+
|
|
10
|
+
A API de Grupos oferece funções simples para controlar os grupos durante o ciclo de vida.
|
|
11
|
+
|
|
12
|
+
Ao criar um novo grupo, um link de convite é gerado para convidar participantes.
|
|
13
|
+
|
|
14
|
+
Como não é possível adicionar participantes manualmente, envie uma mensagem com o link de convite aos usuários do WhatsApp que você quer que entrem no grupo.
|
|
15
|
+
|
|
16
|
+
## Recursos de gerenciamento de grupos
|
|
17
|
+
|
|
18
|
+
- [Criar e excluir um grupo](#create-group)- [Grupos com pedidos de participação habilitados](#groups-with-join-requests)- [Obter e redefinir o link de convite para o grupo](#get-and-reset-group-invite-link)- [Enviar mensagem de modelo de link de convite para o grupo](#send-group-invite-link-template-message)- [Remover participantes do grupo](#remove-group-participants)- [Obter informações do grupo](#get-group-info)- [Obter grupos ativos](#get-active-groups)- [Atualizar as configurações do grupo](#update-group-settings)
|
|
19
|
+
|
|
20
|
+
Para saber como enviar mensagens para grupos, consulte a [referência sobre mensagens em grupo](/documentation/business-messaging/whatsapp/groups/groups-messaging).
|
|
21
|
+
|
|
22
|
+
## Assinar webhooks de metadados de grupos
|
|
23
|
+
|
|
24
|
+
Para receber notificações de webhook com metadados sobre seus grupos, assine os seguintes campos de webhook:
|
|
25
|
+
|
|
26
|
+
- `group_lifecycle_update`- `group_participants_update`- `group_settings_update`- `group_status_update`
|
|
27
|
+
|
|
28
|
+
Para ver uma referência completa de webhooks para a API de Grupos, acesse [Webhooks para a referência da API de Grupos](/documentation/business-messaging/whatsapp/groups/webhooks).
|
|
29
|
+
|
|
30
|
+
## Criar grupo
|
|
31
|
+
|
|
32
|
+
Use este ponto de extremidade para criar um novo grupo e gerar um link de convite para o grupo.
|
|
33
|
+
|
|
34
|
+
Após a criação do grupo, você receberá um webhook com um parâmetro `invite_link` que contém um link de convite para o grupo. Você pode enviar esse link de convite para usuários do WhatsApp que tenham interesse em entrar no grupo.
|
|
35
|
+
|
|
36
|
+
Você também pode criar um grupo que exija aprovação para participar. Isso significa que, se um usuário do WhatsApp quiser entrar no seu grupo, você poderá aprovar ou rejeitar o pedido.
|
|
37
|
+
|
|
38
|
+
[Saiba mais sobre grupos com pedidos de participação habilitados](#groups-with-join-requests).
|
|
39
|
+
|
|
40
|
+
### Sintaxe da solicitação
|
|
41
|
+
|
|
42
|
+
Crie um grupo com um link de convite inicial:
|
|
43
|
+
|
|
44
|
+
`POST /<BUSINESS_PHONE_NUMBER_ID>/groups`
|
|
45
|
+
|
|
46
|
+
### Corpo da solicitação
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
{
|
|
50
|
+
"messaging_product": "whatsapp",
|
|
51
|
+
"subject": "<GROUP_SUBJECT>",
|
|
52
|
+
"description": "<GROUP_DESCRIPTION>",
|
|
53
|
+
"join_approval_mode": "<JOIN_APPROVAL_MODE>"
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Parâmetros da solicitação
|
|
58
|
+
|
|
59
|
+
Espaço reservado
|
|
60
|
+
|
|
61
|
+
Descrição
|
|
62
|
+
|
|
63
|
+
Exemplo de valor
|
|
64
|
+
|
|
65
|
+
`<BUSINESS_PHONE_NUMBER_ID>`
|
|
66
|
+
|
|
67
|
+
_String_
|
|
68
|
+
|
|
69
|
+
**Obrigatório**
|
|
70
|
+
|
|
71
|
+
Identificação do número de telefone comercial.
|
|
72
|
+
|
|
73
|
+
`12784358810`
|
|
74
|
+
|
|
75
|
+
`<GROUP_SUBJECT>`
|
|
76
|
+
|
|
77
|
+
_String_
|
|
78
|
+
|
|
79
|
+
**Obrigatório**
|
|
80
|
+
|
|
81
|
+
Nome do grupo.
|
|
82
|
+
|
|
83
|
+
Máximo de 128 caracteres. Os espaços em branco serão cortados.
|
|
84
|
+
|
|
85
|
+
`New Purchase Inquiry`
|
|
86
|
+
|
|
87
|
+
`<GROUP_DESCRIPTION>`
|
|
88
|
+
|
|
89
|
+
_String_
|
|
90
|
+
|
|
91
|
+
**Opcional**
|
|
92
|
+
|
|
93
|
+
Descrição do grupo.
|
|
94
|
+
|
|
95
|
+
Máximo de 2.048 caracteres.
|
|
96
|
+
|
|
97
|
+
`Jim, an existing client, would like to learn about new car purchase options for current year models.`
|
|
98
|
+
|
|
99
|
+
`<JOIN_APPROVAL_MODE>`
|
|
100
|
+
|
|
101
|
+
_String_
|
|
102
|
+
|
|
103
|
+
**Opcional**
|
|
104
|
+
|
|
105
|
+
Indica se os usuários do WhatsApp que clicarem no link de convite poderão entrar no grupo com ou sem aprovação prévia.
|
|
106
|
+
|
|
107
|
+
Os valores podem ser os seguintes:
|
|
108
|
+
|
|
109
|
+
- `approval_required` – indica que os usuários do WhatsApp precisam ser aprovados por meio de um [pedido de participação](#groups-with-join-requests) para acessar o grupo.- `auto_approve` – indica que os usuários do WhatsApp podem entrar no grupo sem aprovação.
|
|
110
|
+
|
|
111
|
+
Em caso de omissão, `join_approval_mode` será definido como `auto_approve` por padrão.
|
|
112
|
+
|
|
113
|
+
`auto_approve`
|
|
114
|
+
|
|
115
|
+
### Webhooks
|
|
116
|
+
|
|
117
|
+
Um webhook `group_lifecycle_update` é disparado.
|
|
118
|
+
|
|
119
|
+
#### Criação do grupo concluída com sucesso
|
|
120
|
+
|
|
121
|
+
[Consulte o exemplo de webhook "Criação do grupo concluída com sucesso"](/documentation/business-messaging/whatsapp/groups/webhooks#group-create-succeed)
|
|
122
|
+
|
|
123
|
+
#### Falha na criação do grupo
|
|
124
|
+
|
|
125
|
+
[Consulte o exemplo de webhook "Falha na criação do grupo"](/documentation/business-messaging/whatsapp/groups/webhooks#group-create-fail)
|
|
126
|
+
|
|
127
|
+
#### Usuário entra no grupo usando um link de convite
|
|
128
|
+
|
|
129
|
+
[Consulte o exemplo de webhook "Usuário entra no grupo usando um link de convite"](/documentation/business-messaging/whatsapp/groups/webhooks#user-joined-group-using-invite-link-succeed)
|
|
130
|
+
|
|
131
|
+
## Grupos com pedidos de participação
|
|
132
|
+
|
|
133
|
+
Você pode criar grupos que exijam aprovação de pedidos de participação. Após habilitar essa opção, os usuários do WhatsApp que clicarem no link do convite poderão enviar um pedido para participar do grupo ou cancelar um pedido anterior:
|
|
134
|
+
|
|
135
|
+
Quando um usuário do WhatsApp entra no grupo por meio de um pedido de participação, é disparado um \[webhook `group_participants_update` para um usuário que aceitou o pedido de participação\] (/documentation/business-messaging/whatsapp/groups/webhooks#user-accepts-or-cancels-join-request). Você também pode [obter uma lista de pedidos de participação abertos na API](#get-join-requests). Use o conteúdo do webhook ou da resposta da API para aprovar ou rejeitar pedidos.
|
|
136
|
+
|
|
137
|
+
### Receber pedidos de participação
|
|
138
|
+
|
|
139
|
+
#### Sintaxe da solicitação
|
|
140
|
+
|
|
141
|
+
`GET /<GROUP_ID>/join_requests`
|
|
142
|
+
|
|
143
|
+
#### Parâmetros da solicitação
|
|
144
|
+
|
|
145
|
+
Espaço reservado
|
|
146
|
+
|
|
147
|
+
Descrição
|
|
148
|
+
|
|
149
|
+
Exemplo de valor
|
|
150
|
+
|
|
151
|
+
`<GROUP_ID>`
|
|
152
|
+
|
|
153
|
+
_String_
|
|
154
|
+
|
|
155
|
+
**Obrigatório.**
|
|
156
|
+
|
|
157
|
+
Identificação do grupo.
|
|
158
|
+
|
|
159
|
+
`Y2FwaV9ncm91cDoxNzA1NTU1MDEzOToxMjAzNjM0MDQ2OTQyMzM4MjAZD`
|
|
160
|
+
|
|
161
|
+
#### Sintaxe da resposta
|
|
162
|
+
|
|
163
|
+
Caso a solicitação seja bem-sucedida:
|
|
164
|
+
|
|
165
|
+
```
|
|
166
|
+
{
|
|
167
|
+
"data": [
|
|
168
|
+
{
|
|
169
|
+
"join_request_id": "<JOIN_REQUEST_ID>",
|
|
170
|
+
"wa_id": "<WHATSAPP_USER_ID>",
|
|
171
|
+
"creation_timestamp": "<JOIN_REQUEST_CREATION_TIMESTAMP">
|
|
172
|
+
},
|
|
173
|
+
//Additional join request objects would follow, if any
|
|
174
|
+
],
|
|
175
|
+
"paging": {
|
|
176
|
+
"cursors": {
|
|
177
|
+
"before": "<BEFORE_CURSOR>",
|
|
178
|
+
"after": "<AFTER_CURSOR>"
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
#### Parâmetros da resposta
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
Espaço reservado
|
|
189
|
+
|
|
190
|
+
Descrição
|
|
191
|
+
|
|
192
|
+
Exemplo de valor
|
|
193
|
+
|
|
194
|
+
`<JOIN_REQUEST_ID>`
|
|
195
|
+
|
|
196
|
+
_String_
|
|
197
|
+
|
|
198
|
+
Identificação do pedido de participação.
|
|
199
|
+
|
|
200
|
+
`MTY0NjcwNDM1OTU6MTIwMzYzNDA0Njk0MjMzODIw`
|
|
201
|
+
|
|
202
|
+
`<WHATSAPP_USER_ID>`
|
|
203
|
+
|
|
204
|
+
_String_
|
|
205
|
+
|
|
206
|
+
Número de identificação do usuário do WhatsApp.
|
|
207
|
+
|
|
208
|
+
`16505551234`
|
|
209
|
+
|
|
210
|
+
`<JOIN_REQUEST_CREATION_TIMESTAMP>`
|
|
211
|
+
|
|
212
|
+
_Número inteiro_
|
|
213
|
+
|
|
214
|
+
Registro de data e hora Unix que indica quando o pedido de participação foi criado.
|
|
215
|
+
|
|
216
|
+
`1755548877`
|
|
217
|
+
|
|
218
|
+
`<BEFORE_CURSOR>`
|
|
219
|
+
|
|
220
|
+
_String_
|
|
221
|
+
|
|
222
|
+
Cursor anterior. Consulte [Resultados paginados](/docs/graph-api/results).
|
|
223
|
+
|
|
224
|
+
`eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3NTU1NTM3MDUxNzUwNTQ1MTAifQZDZD`
|
|
225
|
+
|
|
226
|
+
`<AFTER_CURSOR>`
|
|
227
|
+
|
|
228
|
+
_String_
|
|
229
|
+
|
|
230
|
+
Cursor posterior. Consulte [Resultados paginados](/docs/graph-api/results).
|
|
231
|
+
|
|
232
|
+
`eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3NTU1NTM3MDUxNzUwNTQ1MTAifQZDZD`
|
|
233
|
+
|
|
234
|
+
### Aprovar pedidos de participação
|
|
235
|
+
|
|
236
|
+
#### Sintaxe da solicitação
|
|
237
|
+
|
|
238
|
+
`POST /<GROUP_ID>/join_requests`
|
|
239
|
+
|
|
240
|
+
#### Corpo da solicitação
|
|
241
|
+
|
|
242
|
+
```
|
|
243
|
+
{
|
|
244
|
+
"messaging_product": "whatsapp",
|
|
245
|
+
"join_requests": [
|
|
246
|
+
"<JOIN_REQUEST_ID>",
|
|
247
|
+
// Additional join request IDs would go here, if approving in bulk
|
|
248
|
+
]
|
|
249
|
+
}
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
#### Parâmetros da solicitação
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
Espaço reservado
|
|
257
|
+
|
|
258
|
+
Descrição
|
|
259
|
+
|
|
260
|
+
Exemplo de valor
|
|
261
|
+
|
|
262
|
+
`<GROUP_ID>`
|
|
263
|
+
|
|
264
|
+
_String_
|
|
265
|
+
|
|
266
|
+
**Obrigatório.**
|
|
267
|
+
|
|
268
|
+
Identificação do grupo.
|
|
269
|
+
|
|
270
|
+
`Y2FwaV9ncm91cDoxNzA1NTU1MDEzOToxMjAzNjM0MDQ2OTQyMzM4MjAZD`
|
|
271
|
+
|
|
272
|
+
#### Sintaxe da resposta
|
|
273
|
+
|
|
274
|
+
Em caso de sucesso, a API responderá com a seguinte carga JSON, e os usuários do WhatsApp cujos pedidos de participação foram aprovados poderão acessar o grupo tocando no link de convite.
|
|
275
|
+
|
|
276
|
+
```
|
|
277
|
+
{
|
|
278
|
+
"messaging_product": "whatsapp",
|
|
279
|
+
"approved_join_requests": [
|
|
280
|
+
"<JOIN_REQUEST_ID>",
|
|
281
|
+
// Additional join request IDs would go here, it approved in bulk
|
|
282
|
+
],
|
|
283
|
+
|
|
284
|
+
//Only included if unable to approve one or more join requests
|
|
285
|
+
|
|
286
|
+
"failed_join_requests": [
|
|
287
|
+
{
|
|
288
|
+
"join_request_id": "<JOIN_REQUEST_ID>",
|
|
289
|
+
"errors": [
|
|
290
|
+
{
|
|
291
|
+
"code": "<ERROR_CODE>",
|
|
292
|
+
"message": "<ERROR_MESSAGE>",
|
|
293
|
+
"title": "<ERROR_TITLE>",
|
|
294
|
+
"error_data": {
|
|
295
|
+
"details": "<ERROR_DETAILS>"
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
]
|
|
299
|
+
}
|
|
300
|
+
],
|
|
301
|
+
"errors": [
|
|
302
|
+
{
|
|
303
|
+
"code": "<ERROR_CODE>",
|
|
304
|
+
"message": "<ERROR_MESSAGE>",
|
|
305
|
+
"title": "<ERROR_TITLE>",
|
|
306
|
+
"error_data": {
|
|
307
|
+
"details": "<ERROR_DETAILS>"
|
|
308
|
+
}
|
|
309
|
+
}
|
|
310
|
+
]
|
|
311
|
+
}
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
#### Parâmetros da resposta
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
Espaço reservado
|
|
319
|
+
|
|
320
|
+
Descrição
|
|
321
|
+
|
|
322
|
+
Exemplo de valor
|
|
323
|
+
|
|
324
|
+
`<JOIN_REQUEST_ID>`
|
|
325
|
+
|
|
326
|
+
_String_
|
|
327
|
+
|
|
328
|
+
Identificação do pedido de participação aprovado ou, se não for possível aprovar, identificação do pedido que falhou.
|
|
329
|
+
|
|
330
|
+
`MTY0NjcwNDM1OTU6MTIwMzYzNDA0Njk0MjMzODIw`
|
|
331
|
+
|
|
332
|
+
`<ERROR_CODE>`
|
|
333
|
+
|
|
334
|
+
_Número inteiro_
|
|
335
|
+
|
|
336
|
+
Código de erro, caso não seja possível aprovar.
|
|
337
|
+
|
|
338
|
+
`131203`
|
|
339
|
+
|
|
340
|
+
`<ERROR_MESSAGE>`
|
|
341
|
+
|
|
342
|
+
_String_
|
|
343
|
+
|
|
344
|
+
Mensagem de erro, caso não seja possível aprovar.
|
|
345
|
+
|
|
346
|
+
`(#131203) Recipient has not accepted our new Terms of Service and Privacy Policy.`
|
|
347
|
+
|
|
348
|
+
`<ERROR_TITLE>`
|
|
349
|
+
|
|
350
|
+
_String_
|
|
351
|
+
|
|
352
|
+
Título do erro, caso não seja possível aprovar.
|
|
353
|
+
|
|
354
|
+
`Unable to add participant to group`
|
|
355
|
+
|
|
356
|
+
`<ERROR_DETAILS>`
|
|
357
|
+
|
|
358
|
+
_String_
|
|
359
|
+
|
|
360
|
+
Detalhes do erro, caso não seja possível aprovar.
|
|
361
|
+
|
|
362
|
+
`Recipient has not accepted our new Terms of Service and Privacy Policy.`
|
|
363
|
+
|
|
364
|
+
#### Webhook
|
|
365
|
+
|
|
366
|
+
Um webhook `group_participants_update` é disparado.
|
|
367
|
+
|
|
368
|
+
[Consulte o exemplo de webhook "Usuário aceita pedido de participação"](/documentation/business-messaging/whatsapp/groups/webhooks#user-accepts-or-cancels-join-request)
|
|
369
|
+
|
|
370
|
+
### Rejeitar pedidos de participação
|
|
371
|
+
|
|
372
|
+
#### Sintaxe da solicitação
|
|
373
|
+
|
|
374
|
+
`DELETE /<GROUP_ID>/join_requests`
|
|
375
|
+
|
|
376
|
+
#### Corpo da solicitação
|
|
377
|
+
|
|
378
|
+
```
|
|
379
|
+
{
|
|
380
|
+
"messaging_product": "whatsapp",
|
|
381
|
+
"join_requests": [
|
|
382
|
+
"<JOIN_REQUEST_ID>",
|
|
383
|
+
//Additional join request IDs would go here, it rejecting in bulk
|
|
384
|
+
]
|
|
385
|
+
}
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
#### Parâmetros da solicitação
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
Espaço reservado
|
|
393
|
+
|
|
394
|
+
Descrição
|
|
395
|
+
|
|
396
|
+
Exemplo de valor
|
|
397
|
+
|
|
398
|
+
`<GROUP_ID>`
|
|
399
|
+
|
|
400
|
+
_String_
|
|
401
|
+
|
|
402
|
+
**Obrigatório.**
|
|
403
|
+
|
|
404
|
+
Identificação do grupo.
|
|
405
|
+
|
|
406
|
+
`Y2FwaV9ncm91cDoxNzA1NTU1MDEzOToxMjAzNjM0MDQ2OTQyMzM4MjAZD`
|
|
407
|
+
|
|
408
|
+
`<JOIN_REQUEST_ID>`
|
|
409
|
+
|
|
410
|
+
_String_
|
|
411
|
+
|
|
412
|
+
**Obrigatório.**
|
|
413
|
+
|
|
414
|
+
Identificação do pedido de participação a ser rejeitado.
|
|
415
|
+
|
|
416
|
+
`MTY0NjcwNDM1OTU6MTIwMzYzNDA0Njk0MjMzODIw`
|
|
417
|
+
|
|
418
|
+
#### Sintaxe da resposta
|
|
419
|
+
|
|
420
|
+
Em caso de sucesso, a API responderá com a seguinte carga JSON, e o usuário do WhatsApp verá novamente o botão **Pedir para participar** ao acessar o link de convite para o grupo.
|
|
421
|
+
|
|
422
|
+
```
|
|
423
|
+
{
|
|
424
|
+
"messaging_product": "whatsapp",
|
|
425
|
+
"rejected_join_requests": [
|
|
426
|
+
"<JOIN_REQUEST_ID>",
|
|
427
|
+
//Additional join request IDs would go here, it rejecting in bulk
|
|
428
|
+
],
|
|
429
|
+
|
|
430
|
+
//Only included if unable to reject one or more join requests
|
|
431
|
+
"failed_join_requests": [
|
|
432
|
+
{
|
|
433
|
+
"join_request_id": "<JOIN_REQUEST_ID>",
|
|
434
|
+
"errors": [
|
|
435
|
+
{
|
|
436
|
+
"code": "<ERROR_CODE>",
|
|
437
|
+
"message": "<ERROR_MESSAGE>",
|
|
438
|
+
"title": "<ERROR_TITLE>",
|
|
439
|
+
"error_data": {
|
|
440
|
+
"details": "<ERROR_DETAILS>"
|
|
441
|
+
}
|
|
442
|
+
}
|
|
443
|
+
]
|
|
444
|
+
}
|
|
445
|
+
],
|
|
446
|
+
"errors": [
|
|
447
|
+
{
|
|
448
|
+
"code": "<ERROR_CODE>",
|
|
449
|
+
"message": "<ERROR_MESSAGE>",
|
|
450
|
+
"title": "<ERROR_TITLE>",
|
|
451
|
+
"error_data": {
|
|
452
|
+
"details": "<ERROR_DETAILS>"
|
|
453
|
+
}
|
|
454
|
+
}
|
|
455
|
+
]
|
|
456
|
+
}
|
|
457
|
+
```
|
|
458
|
+
|
|
459
|
+
#### Parâmetros da resposta
|
|
460
|
+
|
|
461
|
+
Espaço reservado
|
|
462
|
+
|
|
463
|
+
Descrição
|
|
464
|
+
|
|
465
|
+
Exemplo de valor
|
|
466
|
+
|
|
467
|
+
`<JOIN_REQUEST_ID>`
|
|
468
|
+
|
|
469
|
+
_String_
|
|
470
|
+
|
|
471
|
+
Identificação do pedido de participação rejeitado ou, se não for possível rejeitar, identificação do pedido que falhou.
|
|
472
|
+
|
|
473
|
+
`MTY0NjcwNDM1OTU6MTIwMzYzNDA0Njk0MjMzODIw`
|
|
474
|
+
|
|
475
|
+
`<ERROR_CODE>`
|
|
476
|
+
|
|
477
|
+
_Número inteiro_
|
|
478
|
+
|
|
479
|
+
Código de erro, caso não seja possível rejeitar.
|
|
480
|
+
|
|
481
|
+
`131203`
|
|
482
|
+
|
|
483
|
+
`<ERROR_MESSAGE>`
|
|
484
|
+
|
|
485
|
+
_String_
|
|
486
|
+
|
|
487
|
+
Mensagem de erro, caso não seja possível rejeitar.
|
|
488
|
+
|
|
489
|
+
`(#131203) Recipient has not accepted our new Terms of Service and Privacy Policy.`
|
|
490
|
+
|
|
491
|
+
`<ERROR_TITLE>`
|
|
492
|
+
|
|
493
|
+
_String_
|
|
494
|
+
|
|
495
|
+
Título do erro, caso não seja possível rejeitar.
|
|
496
|
+
|
|
497
|
+
`Unable to add participant to group`
|
|
498
|
+
|
|
499
|
+
`<ERROR_DETAILS>`
|
|
500
|
+
|
|
501
|
+
_String_
|
|
502
|
+
|
|
503
|
+
Detalhes do erro, caso não seja possível rejeitar.
|
|
504
|
+
|
|
505
|
+
`Recipient has not accepted our new Terms of Service and Privacy Policy.`
|
|
506
|
+
|
|
507
|
+
### Webhook
|
|
508
|
+
|
|
509
|
+
Nenhum.
|
|
510
|
+
|
|
511
|
+
## Obter e redefinir o link de convite para o grupo
|
|
512
|
+
|
|
513
|
+
Após a redefinição de um link de convite, todos os links de convite anteriores ficarão inválidos.
|
|
514
|
+
|
|
515
|
+
Um link de convite para o grupo é gerado quando o grupo é criado. Use estes pontos de extremidade para obter e redefinir links de convite para o grupo.
|
|
516
|
+
|
|
517
|
+
Para cada ponto de extremidade, você precisará da identificação do grupo a fim de obter ou redefinir um link para o grupo correto, conforme mostrado a seguir:
|
|
518
|
+
|
|
519
|
+
Espaço reservado
|
|
520
|
+
|
|
521
|
+
Descrição
|
|
522
|
+
|
|
523
|
+
Exemplo de valor
|
|
524
|
+
|
|
525
|
+
`<GROUP_ID>`
|
|
526
|
+
|
|
527
|
+
_String_
|
|
528
|
+
|
|
529
|
+
**Obrigatório**
|
|
530
|
+
|
|
531
|
+
A identificação do grupo do qual você quer obter ou redefinir um link de convite.
|
|
532
|
+
|
|
533
|
+
`Y2FwaV9ncm91cDoxOTUwNTU1MDA3OToxMjAzNjMzOTQzMjAdOTY0MTUZD`
|
|
534
|
+
|
|
535
|
+
### Obter o link de convite para o grupo
|
|
536
|
+
|
|
537
|
+
#### Sintaxe da solicitação
|
|
538
|
+
|
|
539
|
+
`GET /<GROUP_ID>/invite_link`
|
|
540
|
+
|
|
541
|
+
#### Corpo da resposta
|
|
542
|
+
|
|
543
|
+
```
|
|
544
|
+
{
|
|
545
|
+
"messaging_product": "whatsapp",
|
|
546
|
+
"invite_link": "https://chat.whatsapp.com/<LINK_ID>"
|
|
547
|
+
}
|
|
548
|
+
```
|
|
549
|
+
|
|
550
|
+
Observe que `invite_link` começa sempre com o prefixo `https://chat.whatsapp.com/`. A única parte variável é `<LINK_ID>`.
|
|
551
|
+
|
|
552
|
+
### Redefinir o link de convite para o grupo
|
|
553
|
+
|
|
554
|
+
#### Sintaxe da solicitação
|
|
555
|
+
|
|
556
|
+
`POST /<GROUP_ID>/invite_link`
|
|
557
|
+
|
|
558
|
+
#### Corpo da solicitação
|
|
559
|
+
|
|
560
|
+
```
|
|
561
|
+
{ "messaging_product": "whatsapp",}
|
|
562
|
+
```
|
|
563
|
+
|
|
564
|
+
#### Corpo da resposta
|
|
565
|
+
|
|
566
|
+
```
|
|
567
|
+
{
|
|
568
|
+
"messaging_product": "whatsapp",
|
|
569
|
+
"invite_link": "https://chat.whatsapp.com/<LINK_ID>"
|
|
570
|
+
}
|
|
571
|
+
```
|
|
572
|
+
|
|
573
|
+
## Enviar mensagem de modelo de link de convite para o grupo
|
|
574
|
+
|
|
575
|
+
A [Biblioteca de modelos](https://business.facebook.com/wa/manage/template-library) contém um modelo de mensagem de utilidade para enviar links de convite para o grupo aos usuários do WhatsApp. Use esses modelos predefinidos para enviar convites para o grupo como mensagens de utilidade.
|
|
576
|
+
|
|
577
|
+
**Para manter o modelo com a categoria `utility`, ele não pode ser modificado ao ser copiado da biblioteca de modelos para sua conta do WhatsApp Business.**
|
|
578
|
+
|
|
579
|
+
Para enviar o modelo de mensagem:
|
|
580
|
+
|
|
581
|
+
#### Etapa 1. Adicione um modelo de link de convite para o grupo da biblioteca de modelos aos modelos da sua conta:
|
|
582
|
+
|
|
583
|
+
_No Gerenciador do WhatsApp_
|
|
584
|
+
|
|
585
|
+
- Vá até [Biblioteca de modelos](https://business.facebook.com/wa/manage/template-library).- À esquerda, clique no menu suspenso **Link de convite para o grupo** e, depois, na caixa de seleção **Convite para o grupo mediante solicitação**.- Selecione o modelo que você quer usar, dê um nome a ele e clique em **Enviar**.
|
|
586
|
+
|
|
587
|
+
_Usando a API_
|
|
588
|
+
|
|
589
|
+
É possível consultar bibliotecas de modelos aplicáveis a links de convite para o grupo usando a solicitação abaixo:
|
|
590
|
+
|
|
591
|
+
`GET /message_template_library?category=utility&topic=group_invite_link&language=en`
|
|
592
|
+
|
|
593
|
+
[Leia mais sobre como encontrar e adicionar o modelo à sua conta do WhatsApp Business usando a API](/documentation/business-messaging/whatsapp/templates/template-library#using-the-api)
|
|
594
|
+
|
|
595
|
+
A aprovação do modelo pode levar até 24 horas. Você poderá enviar mensagens com esse modelo após a aprovação.
|
|
596
|
+
|
|
597
|
+
#### Etapa 2. Envie a mensagem de modelo
|
|
598
|
+
|
|
599
|
+
- Envie o modelo usando a sintaxe e o corpo da solicitação abaixo, substituindo a identificação do grupo, o nome que você deu ao modelo e outros valores aplicáveis.
|
|
600
|
+
|
|
601
|
+
Quando você fornece a identificação do grupo na solicitação da API, ela é automaticamente convertida no link de convite correspondente quando a mensagem é entregue.
|
|
602
|
+
|
|
603
|
+
### Sintaxe da solicitação
|
|
604
|
+
|
|
605
|
+
`POST /<BUSINESS_PHONE_NUMBER_ID>/messages`
|
|
606
|
+
|
|
607
|
+
### Parâmetros do ponto de extremidade
|
|
608
|
+
|
|
609
|
+
Espaço reservado
|
|
610
|
+
|
|
611
|
+
Descrição
|
|
612
|
+
|
|
613
|
+
Exemplo de valor
|
|
614
|
+
|
|
615
|
+
`<BUSINESS_PHONE_NUMBER_ID>`
|
|
616
|
+
|
|
617
|
+
_Número inteiro_
|
|
618
|
+
|
|
619
|
+
**Obrigatório**
|
|
620
|
+
|
|
621
|
+
Identificação do número de telefone comercial.
|
|
622
|
+
|
|
623
|
+
`13057863445`
|
|
624
|
+
|
|
625
|
+
### Corpo da solicitação
|
|
626
|
+
|
|
627
|
+
```
|
|
628
|
+
curl --location 'https://graph.facebook.com/<API_VERSION>/<BUSINESS_PHONE_NUMBER_ID>/messages?access_token=' \
|
|
629
|
+
--header 'Content-Type: application/json' \
|
|
630
|
+
--data '{
|
|
631
|
+
"messaging_product": "whatsapp",
|
|
632
|
+
"to": "<WHATSAPP_USER_PHONE_NUMBER>",
|
|
633
|
+
"type": "template",
|
|
634
|
+
"template": {
|
|
635
|
+
"name": "<TEMPLATE_NAME>",
|
|
636
|
+
"language": {
|
|
637
|
+
"code": "<TEMPLATE_LANGUAGE>"
|
|
638
|
+
},
|
|
639
|
+
"components": [
|
|
640
|
+
{
|
|
641
|
+
"type": "body",
|
|
642
|
+
"parameters": [
|
|
643
|
+
{
|
|
644
|
+
"type": "group_id",
|
|
645
|
+
"group_id": "<GROUP_ID>"
|
|
646
|
+
},
|
|
647
|
+
{
|
|
648
|
+
...additional parameters
|
|
649
|
+
}
|
|
650
|
+
]
|
|
651
|
+
}
|
|
652
|
+
]
|
|
653
|
+
}
|
|
654
|
+
}'
|
|
655
|
+
```
|
|
656
|
+
|
|
657
|
+
[Saiba mais sobre a biblioteca de modelos](/documentation/business-messaging/whatsapp/templates/template-library)
|
|
658
|
+
|
|
659
|
+
### Webhooks
|
|
660
|
+
|
|
661
|
+
#### Usuário entra no grupo usando um link de convite
|
|
662
|
+
|
|
663
|
+
[Consulte o exemplo de webhook "Usuário entra no grupo usando um link de convite"](/documentation/business-messaging/whatsapp/groups/webhooks#user-joined-group-using-invite-link-succeed)
|
|
664
|
+
|
|
665
|
+
## Excluir grupo
|
|
666
|
+
|
|
667
|
+
Este ponto de extremidade exclui o grupo e remove todos os participantes, incluindo a empresa. O corpo da solicitação não é necessário.
|
|
668
|
+
|
|
669
|
+
### Sintaxe da solicitação
|
|
670
|
+
|
|
671
|
+
`DELETE /<GROUP_ID>`
|
|
672
|
+
|
|
673
|
+
### Propriedades da solicitação
|
|
674
|
+
|
|
675
|
+
Espaço reservado
|
|
676
|
+
|
|
677
|
+
Descrição
|
|
678
|
+
|
|
679
|
+
Exemplo de valor
|
|
680
|
+
|
|
681
|
+
`<GROUP_ID>`
|
|
682
|
+
|
|
683
|
+
_String_
|
|
684
|
+
|
|
685
|
+
**Obrigatório**
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
A identificação do grupo que você quer excluir.
|
|
689
|
+
|
|
690
|
+
`Y2FwaV9ncm91cDoxOTUwNTU1MDA3OToxMjAzNjMzOTQzMjAdOTY0MTUZD`
|
|
691
|
+
|
|
692
|
+
### Webhooks
|
|
693
|
+
|
|
694
|
+
Um webhook `group_lifecycle_update` é disparado.
|
|
695
|
+
|
|
696
|
+
#### Exclusão de grupo concluída com sucesso
|
|
697
|
+
|
|
698
|
+
[Consulte o exemplo de webhook "Exclusão de grupo concluída com sucesso"](/documentation/business-messaging/whatsapp/groups/webhooks#delete-group-succeed)
|
|
699
|
+
|
|
700
|
+
#### Falha ao excluir grupo
|
|
701
|
+
|
|
702
|
+
[Consulte o exemplo de webhook "Falha ao excluir grupo"](/documentation/business-messaging/whatsapp/groups/webhooks#delete-group-fails)
|
|
703
|
+
|
|
704
|
+
## Remover participantes do grupo
|
|
705
|
+
|
|
706
|
+
Use este ponto de extremidade para remover participantes do grupo.
|
|
707
|
+
|
|
708
|
+
**Observação: se um participante for removido de um grupo, ele não poderá mais entrar no grupo por meio de um link de convite.**
|
|
709
|
+
|
|
710
|
+
### Sintaxe da solicitação
|
|
711
|
+
|
|
712
|
+
`DELETE /<GROUP_ID>/participants`
|
|
713
|
+
|
|
714
|
+
### Corpo da solicitação
|
|
715
|
+
|
|
716
|
+
```
|
|
717
|
+
{
|
|
718
|
+
"messaging_product": "whatsapp",
|
|
719
|
+
"participants": [
|
|
720
|
+
{ "user": "<WHATSAPP_USER_PHONE_NUMBER> or <WHATSAPP_USER_ID>" },
|
|
721
|
+
{ "user": "<WHATSAPP_USER_PHONE_NUMBER> or <WHATSAPP_USER_ID>"" },
|
|
722
|
+
...
|
|
723
|
+
]
|
|
724
|
+
}
|
|
725
|
+
```
|
|
726
|
+
|
|
727
|
+
### Propriedades da solicitação
|
|
728
|
+
|
|
729
|
+
Espaço reservado
|
|
730
|
+
|
|
731
|
+
Descrição
|
|
732
|
+
|
|
733
|
+
Exemplo de valor
|
|
734
|
+
|
|
735
|
+
`"participants": []`
|
|
736
|
+
|
|
737
|
+
_Matriz_
|
|
738
|
+
|
|
739
|
+
**Opcional**
|
|
740
|
+
|
|
741
|
+
Especifica uma matriz de números de telefone ou de identificações de contas do WhatsApp. O número de telefone comercial usado para criar o grupo é sempre adicionado como criador e administrador.
|
|
742
|
+
|
|
743
|
+
- Máximo de 8 participantes.- A matriz não pode estar vazia.
|
|
744
|
+
|
|
745
|
+
```
|
|
746
|
+
{ "user": "+17865347866" },
|
|
747
|
+
{ "user": "+7669992245" },
|
|
748
|
+
...
|
|
749
|
+
```
|
|
750
|
+
|
|
751
|
+
### Webhooks
|
|
752
|
+
|
|
753
|
+
Um webhook `group_participants_update` é disparado.
|
|
754
|
+
|
|
755
|
+
#### Saída de participantes do grupo
|
|
756
|
+
|
|
757
|
+
[Consulte o exemplo de webhook "Saída de participantes do grupo"](/documentation/business-messaging/whatsapp/groups/webhooks#delete-group-succeed)
|
|
758
|
+
|
|
759
|
+
## Obter informações do grupo
|
|
760
|
+
|
|
761
|
+
Use este ponto de extremidade para recuperar metadados sobre um único grupo.
|
|
762
|
+
|
|
763
|
+
**Observação:** se você não especificar nenhum campo nos parâmetros de consulta, o sistema retornará apenas a identificação do grupo e o produto de mensagem.
|
|
764
|
+
|
|
765
|
+
### Sintaxe da solicitação
|
|
766
|
+
|
|
767
|
+
`GET /<GROUP_ID>?fields=<FIELDS>`
|
|
768
|
+
|
|
769
|
+
### Parâmetros do ponto de extremidade
|
|
770
|
+
|
|
771
|
+
Espaço reservado
|
|
772
|
+
|
|
773
|
+
Descrição
|
|
774
|
+
|
|
775
|
+
Exemplo de valor
|
|
776
|
+
|
|
777
|
+
`<GROUP_ID>`
|
|
778
|
+
|
|
779
|
+
_String_
|
|
780
|
+
|
|
781
|
+
**Obrigatório**
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
A identificação do grupo do qual você está consultando informações.
|
|
785
|
+
|
|
786
|
+
`Y2FwaV9ncm91cDoxOTUwNTU1MDA3OToxMjAzNjMzOTQzMjAdOTY0MTUZD`
|
|
787
|
+
|
|
788
|
+
`<FIELDS>`
|
|
789
|
+
|
|
790
|
+
_String_
|
|
791
|
+
|
|
792
|
+
**Opcional**
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
Uma lista de campos a serem retornados, separada por vírgulas. Se nenhum campo for informado, apenas a identificação do grupo será retornada.
|
|
796
|
+
|
|
797
|
+
`"subject,description,participants,join_approval_mode"`
|
|
798
|
+
|
|
799
|
+
[Clique aqui para saber mais sobre os campos da Graph API](/docs/graph-api/overview#fields)
|
|
800
|
+
|
|
801
|
+
### Campos disponíveis
|
|
802
|
+
|
|
803
|
+
Campo
|
|
804
|
+
|
|
805
|
+
Descrição
|
|
806
|
+
|
|
807
|
+
Exemplo de valor de retorno
|
|
808
|
+
|
|
809
|
+
`join_approval_mode`
|
|
810
|
+
|
|
811
|
+
_String_
|
|
812
|
+
|
|
813
|
+
Indica se os usuários do WhatsApp que clicarem no link de convite poderão entrar no grupo com ou sem aprovação prévia.
|
|
814
|
+
|
|
815
|
+
Os valores podem ser os seguintes:
|
|
816
|
+
|
|
817
|
+
- `approval_required` – indica que os usuários do WhatsApp precisam ser aprovados por meio de um [pedido de participação](#groups-with-join-requests) para acessar o grupo.- `auto_approve` – indica que os usuários do WhatsApp podem entrar no grupo sem aprovação.
|
|
818
|
+
|
|
819
|
+
`auto_approve`
|
|
820
|
+
|
|
821
|
+
`subject`
|
|
822
|
+
|
|
823
|
+
_String_
|
|
824
|
+
|
|
825
|
+
O nome do grupo.
|
|
826
|
+
|
|
827
|
+
`"Artificial Intelligence Insights"`
|
|
828
|
+
|
|
829
|
+
`description`
|
|
830
|
+
|
|
831
|
+
_String_
|
|
832
|
+
|
|
833
|
+
A descrição do grupo, se tiver sido definida durante a criação.
|
|
834
|
+
|
|
835
|
+
`"Explore AI developments, share knowledge, and discuss the future of artificial intelligence with fellow enthusiasts and experts."`
|
|
836
|
+
|
|
837
|
+
`suspended`
|
|
838
|
+
|
|
839
|
+
_Booliano_
|
|
840
|
+
|
|
841
|
+
Retorna `true` se o grupo tiver sido suspenso pelo WhatsApp.
|
|
842
|
+
|
|
843
|
+
`false`
|
|
844
|
+
|
|
845
|
+
`creation_timestamp`
|
|
846
|
+
|
|
847
|
+
_Número inteiro_
|
|
848
|
+
|
|
849
|
+
Registro de data e hora Unix em segundos da criação do grupo.
|
|
850
|
+
|
|
851
|
+
`683731200`
|
|
852
|
+
|
|
853
|
+
`participants`
|
|
854
|
+
|
|
855
|
+
_Lista_
|
|
856
|
+
|
|
857
|
+
Uma lista de objetos `{"wa_id": "<WA_ID>"}`, em que `<WA_ID>` é um participante do grupo que está sendo consultado.
|
|
858
|
+
|
|
859
|
+
`[{"wa_id": "2228675309"}, {"wa_id": "7693349922"}]`
|
|
860
|
+
|
|
861
|
+
`total_participant_count`
|
|
862
|
+
|
|
863
|
+
_Número inteiro_
|
|
864
|
+
|
|
865
|
+
O número total de participantes do grupo, excluindo sua empresa.
|
|
866
|
+
|
|
867
|
+
`6`
|
|
868
|
+
|
|
869
|
+
### Exemplo de resposta
|
|
870
|
+
|
|
871
|
+
```
|
|
872
|
+
{
|
|
873
|
+
"messaging_product": "whatsapp",
|
|
874
|
+
"id": "<GROUP_ID>",
|
|
875
|
+
"subject": "<SUBJECT>",
|
|
876
|
+
"creation_timestamp": "<TIMESTAMP>",
|
|
877
|
+
"suspended": "<SUSPENDED>",
|
|
878
|
+
"description": "<DESCRIPTION>",
|
|
879
|
+
"total_participant_count": "<TOTAL_PARTICIPANT_COUNT>",
|
|
880
|
+
"participants": [
|
|
881
|
+
{
|
|
882
|
+
"wa_id": "<WA_ID>"
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"wa_id": "<WA_ID>"
|
|
886
|
+
}
|
|
887
|
+
],
|
|
888
|
+
"join_approval_mode": "<JOIN_APPROVAL_MODE>"
|
|
889
|
+
}
|
|
890
|
+
```
|
|
891
|
+
|
|
892
|
+
## Obter grupos ativos
|
|
893
|
+
|
|
894
|
+
Use este ponto de extremidade para recuperar uma lista de grupos ativos associados a determinado número de telefone comercial.
|
|
895
|
+
|
|
896
|
+
### Sintaxe da solicitação
|
|
897
|
+
|
|
898
|
+
`GET /<BUSINESS_PHONE_NUMBER_ID>/groups`
|
|
899
|
+
|
|
900
|
+
### Parâmetros da consulta
|
|
901
|
+
|
|
902
|
+
```
|
|
903
|
+
?limit=<LIMIT>, // Optional
|
|
904
|
+
&after=<AFTER_CURSOR>, // Optional
|
|
905
|
+
&before=<BEFORE_CURSOR> // Optional
|
|
906
|
+
```
|
|
907
|
+
|
|
908
|
+
Parâmetro
|
|
909
|
+
|
|
910
|
+
Descrição
|
|
911
|
+
|
|
912
|
+
`<LIMIT>`
|
|
913
|
+
|
|
914
|
+
_Opcional_
|
|
915
|
+
|
|
916
|
+
O número de grupos para buscar na solicitação.
|
|
917
|
+
|
|
918
|
+
Mínimo: 1 | Padrão: 25 | Máximo: 1.024
|
|
919
|
+
|
|
920
|
+
`<BEFORE_CURSOR>`
|
|
921
|
+
|
|
922
|
+
_Opcional_
|
|
923
|
+
|
|
924
|
+
Cursor que aponta para o início de uma página de dados. Clique [aqui](/docs/graph-api/results) para saber mais sobre resultados paginados na Graph API aqui
|
|
925
|
+
|
|
926
|
+
`<AFTER_CURSOR>`
|
|
927
|
+
|
|
928
|
+
_Opcional_
|
|
929
|
+
|
|
930
|
+
Cursor que aponta para o fim de uma página de dados. Clique [aqui](/docs/graph-api/results) para saber mais sobre resultados paginados na Graph API aqui
|
|
931
|
+
|
|
932
|
+
### Objeto de resposta
|
|
933
|
+
|
|
934
|
+
```
|
|
935
|
+
{ "data": { "groups": [ {"id": "GROUP_ID", "subject": SUBJECT, "created_at": "TIMESTAMP"}, {"id": "GROUP_ID", "subject": SUBJECT, "created_at": "TIMESTAMP"} … ] }, "paging": { "cursors": { "after": "MTAxNTExOTQ1MjAwNzI5NDE=", "before": "NDMyNzQyODI3OTQw" }, "previous": "https://graph.facebook.com/VERSION/PHONE_NUMBER_ID/groups?limit=10&before=NDMyNzQyODI3OTQw", "next": "https://graph.facebook.com/VERSION/PHONE_NUMBER_ID/groups?limit=25&after=MTAxNTExOTQ1MjAwNzI5NDE=" }}
|
|
936
|
+
```
|
|
937
|
+
|
|
938
|
+
### Parâmetros da resposta
|
|
939
|
+
|
|
940
|
+
Parâmetro
|
|
941
|
+
|
|
942
|
+
Descrição
|
|
943
|
+
|
|
944
|
+
`data[groups]`
|
|
945
|
+
|
|
946
|
+
_Lista_
|
|
947
|
+
|
|
948
|
+
Uma lista de grupos, cada um com a identificação, o nome, o registro de data e hora Unix da criação do grupo.
|
|
949
|
+
|
|
950
|
+
`paging`
|
|
951
|
+
|
|
952
|
+
_Objeto_
|
|
953
|
+
|
|
954
|
+
Um objeto de paginação.
|
|
955
|
+
|
|
956
|
+
Clique [aqui](/docs/graph-api/results) para saber mais sobre resultados paginados na Graph API aqui
|
|
957
|
+
|
|
958
|
+
## Atualizar as configurações do grupo
|
|
959
|
+
|
|
960
|
+
Use este webhook para atualizar o nome, a descrição e a foto do grupo.
|
|
961
|
+
|
|
962
|
+
### Sintaxe da solicitação
|
|
963
|
+
|
|
964
|
+
`POST /<GROUP_ID>`
|
|
965
|
+
|
|
966
|
+
### Corpo da solicitação
|
|
967
|
+
|
|
968
|
+
```
|
|
969
|
+
{
|
|
970
|
+
"messaging_product": "whatsapp",
|
|
971
|
+
"subject": "<GROUP_SUBJECT>",
|
|
972
|
+
"profile_picture_file": "<FILE_PATH>",
|
|
973
|
+
"description": "<GROUP_DESCRIPTION>",
|
|
974
|
+
}
|
|
975
|
+
```
|
|
976
|
+
|
|
977
|
+
### Propriedades da solicitação
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
**Observação**
|
|
982
|
+
|
|
983
|
+
Espaço reservado
|
|
984
|
+
|
|
985
|
+
Descrição
|
|
986
|
+
|
|
987
|
+
Exemplo de valor
|
|
988
|
+
|
|
989
|
+
`<FILE_PATH>`
|
|
990
|
+
|
|
991
|
+
_String_
|
|
992
|
+
|
|
993
|
+
**Opcional**
|
|
994
|
+
|
|
995
|
+
O caminho para um arquivo de imagem armazenado no diretório local.
|
|
996
|
+
|
|
997
|
+
**Para carregar um arquivo**: siga a mesma estrutura de solicitação do ponto de extremidade [Upload Media](/documentation/business-messaging/whatsapp/business-phone-numbers/media#upload-media).
|
|
998
|
+
|
|
999
|
+
Exemplo de carregamento de arquivo com cURL:
|
|
1000
|
+
|
|
1001
|
+
```
|
|
1002
|
+
curl 'https://graph.facebook.com/v23.0/<GROUP_ID> \
|
|
1003
|
+
-X POST \
|
|
1004
|
+
-H 'Authorization: Bearer ...' \
|
|
1005
|
+
-F 'messaging_product=whatsapp' \
|
|
1006
|
+
-F 'file=@/media/pictures/square_pic.png'
|
|
1007
|
+
```
|
|
1008
|
+
|
|
1009
|
+
Requisitos para foto do perfil do grupo:
|
|
1010
|
+
|
|
1011
|
+
- Compatível apenas com imagens do tipo mime/jpeg- Tamanho máximo: 5 MB- Imagem de formato quadrado (altura = largura)- Tamanho mínimo: 192 x 192
|
|
1012
|
+
|
|
1013
|
+
`/local/path/file.jpg`
|
|
1014
|
+
|
|
1015
|
+
`<GROUP_SUBJECT>`
|
|
1016
|
+
|
|
1017
|
+
_String_
|
|
1018
|
+
|
|
1019
|
+
**Opcional**
|
|
1020
|
+
|
|
1021
|
+
O novo nome do grupo.
|
|
1022
|
+
|
|
1023
|
+
- Tamanho máximo: 128 caracteres.- Se fornecido, não pode ficar vazio.
|
|
1024
|
+
|
|
1025
|
+
`"Watch Enthusiasts"`
|
|
1026
|
+
|
|
1027
|
+
`<GROUP_DESCRIPTION>`
|
|
1028
|
+
|
|
1029
|
+
_String_
|
|
1030
|
+
|
|
1031
|
+
**Opcional**
|
|
1032
|
+
|
|
1033
|
+
A nova descrição do grupo.
|
|
1034
|
+
|
|
1035
|
+
- Tamanho máximo: 2.048 caracteres
|
|
1036
|
+
|
|
1037
|
+
`"Join our community to discuss the latest timepieces, share watch reviews, and connect with fellow horology enthusiasts."`
|
|
1038
|
+
|
|
1039
|
+
### Webhooks
|
|
1040
|
+
|
|
1041
|
+
Um webhook `group_settings_update` é disparado.
|
|
1042
|
+
|
|
1043
|
+
#### Configurações do grupo atualizadas com sucesso
|
|
1044
|
+
|
|
1045
|
+
[Consulte o exemplo de webhook "Configurações do grupo atualizadas com sucesso"](/documentation/business-messaging/whatsapp/groups/webhooks#group-settings-update-succeed).
|
|
1046
|
+
|
|
1047
|
+
#### Falha parcial na atualização das configurações do grupo
|
|
1048
|
+
|
|
1049
|
+
[Consulte o exemplo de webhook "Falha parcial na atualização das configurações do grupo"](/documentation/business-messaging/whatsapp/groups/webhooks#group-settings-update-partial-fail).
|
|
1050
|
+
|
|
1051
|
+
#### Falha total na atualização das configurações do grupo
|
|
1052
|
+
|
|
1053
|
+
[Consulte o exemplo de webhook "Falha total na atualização das configurações do grupo"](/documentation/business-messaging/whatsapp/groups/webhooks#group-settings-update-total-fail).
|
|
1054
|
+
|
|
1055
|
+
Você achou esta página útil?
|
|
1056
|
+
|
|
1057
|
+

|
|
1058
|
+
|
|
1059
|
+

|