whatsapp-docs-mcp 1.0.6 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/ativos_da_conta/outros_ativos/display_names.md +9 -9
- package/docs/ativos_da_conta/outros_ativos/official_business_accounts.md +27 -27
- package/docs/ativos_da_conta/telefones_comerciais/phone_numbers.md +151 -27
- package/docs/business_profiles.md +72 -0
- package/docs/business_scoped_user_ids.md +1533 -0
- package/docs/dados_privacidade_e_politica/encryption.md +1 -1
- package/docs/flows/changelog.md +6 -6
- package/docs/flows/gettingstarted/health_insurance.md +12 -6
- package/docs/flows/gettingstarted/personalised_offer.md +6 -6
- package/docs/flows/gettingstarted/pre_approved_loan.md +6 -6
- package/docs/flows/gettingstarted/purchase_intent.md +2 -2
- package/docs/flows/gettingstarted.md +5 -5
- package/docs/flows/guias.md +1 -1
- package/docs/flows/playground.md +1 -1
- package/docs/flows/referencia.md +1 -1
- package/docs/flows/support.md +3 -3
- package/docs/flows.md +2 -2
- package/docs/insights/analytics.md +200 -66
- package/docs/ligacoes/call_settings.md +129 -57
- package/docs/ligacoes/calling.md +33 -16
- package/docs/ligacoes/integration_examples.md +526 -0
- package/docs/ligacoes/pricing.md +11 -300
- package/docs/ligacoes/sandbox.md +160 -0
- package/docs/ligacoes/video_calling.md +8 -0
- package/docs/mensagens/interactive_media_carousel_messages.md +256 -0
- package/docs/mensagens/interactive_product_carousel_messages.md +181 -0
- package/docs/mensagens/limites_de_mensagens/messaging_limits.md +16 -12
- package/docs/mensagens/recursos_adicionais/media.md +15 -16
- package/docs/mensagens/recursos_adicionais/payload_encryption.md +1 -1
- package/docs/mensagens/tipos_de_mensagens/audio_messages.md +11 -11
- package/docs/mensagens/tipos_de_mensagens/interactive_flow_messages.md +1 -1
- package/docs/mensagens/tipos_de_mensagens/message_with_link.md +1 -1
- package/docs/mensagens_de_marketing/changelog.md +299 -0
- package/docs/mensagens_de_marketing/features.md +184 -0
- package/docs/mensagens_de_marketing/implementacao/get_started.md +17 -21
- package/docs/mensagens_de_marketing/implementacao/send_marketing_messages.md +50 -45
- package/docs/mensagens_de_marketing/measure_conversion.md +132 -0
- package/docs/mensagens_de_marketing/onboarding.md +282 -0
- package/docs/mensagens_de_marketing/recursos/automatic_creative_optimization.md +1 -1
- package/docs/mensagens_de_marketing/recursos/conversion_measurement.md +1 -1
- package/docs/mensagens_de_marketing/visao_geral/overview.md +11 -9
- package/docs/messaging_limits/upcoming_changes.md +1 -1
- package/docs/modelos/authentication_templates/bulk_management.md +145 -0
- package/docs/modelos/authentication_templates/template_preview.md +109 -0
- package/docs/modelos/gerenciamento_de_modelos/components.md +23 -23
- package/docs/modelos/gerenciamento_de_modelos/template_media.md +1 -1
- package/docs/modelos/modelos_de_marketing/marketing_templates.md +20 -20
- package/docs/modelos/modelos_de_marketing/per_user_limits.md +7 -5
- package/docs/modelos/portfolio_pacing.md +30 -0
- package/docs/modelos/visao_geral/overview.md +17 -17
- package/docs/pagamentos/payments_br/cards.md +8 -0
- package/docs/parceiros/gerenciamento/suporte_ao_parceiro/transferring_wabas_to_customers.md +1 -1
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/onboarding_business_app_users.md +364 -75
- package/docs/parceiros/integracao_de_clientes/cadastro_incorporado/overview.md +34 -30
- package/docs/parceiros/migrate_existing_whatsapp_number_to_a_business_account.md +40 -0
- package/docs/parceiros/obo_model_deprecation.md +32 -0
- package/docs/parceiros/seja_um_parceiro/get_started_for_solution_partners.md +42 -42
- package/docs/parceiros/seja_um_parceiro/get_started_for_tech_providers.md +38 -142
- package/docs/recado/precos/pricing.md +82 -50
- package/docs/recado/precos/pricing_authentication_international_rates.md +16 -18
- package/docs/recado/precos/pricing_updates_to_pricing.md +1 -1
- package/docs/recado/sobre_a_plataforma/about_the_platform.md +80 -24
- package/docs/recado/sobre_a_plataforma/access_tokens.md +19 -19
- package/docs/referencia/bot_do_whatsapp_business/bot_details_api.md +4 -758
- package/docs/referencia/business/add_phone_numbers_api.md +4 -722
- package/docs/referencia/business/business_account_api.md +8 -0
- package/docs/referencia/business/client_whatsapp_business_accounts_api.md +4 -1002
- package/docs/referencia/business/owned_whatsapp_business_accounts.md +4 -798
- package/docs/referencia/business/whatsapp_business_accounts_api.md +4 -1546
- package/docs/referencia/business/whatsapp_business_partner_onboarding_to_mm_lite_api.md +4 -779
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_number_sharing_api.md +4 -786
- package/docs/referencia/business/whatsapp_business_pre_verified_phone_numbers_api.md +4 -882
- package/docs/referencia/changelog.md +1837 -3
- package/docs/referencia/conta_do_whatsapp_business/assigned_users_management_api.md +4 -2198
- package/docs/referencia/conta_do_whatsapp_business/business_account_api.md +4 -263
- package/docs/referencia/conta_do_whatsapp_business/business_account_extended_credits_api.md +4 -271
- package/docs/referencia/conta_do_whatsapp_business/conversational_automation_api.md +4 -778
- package/docs/referencia/conta_do_whatsapp_business/flows_api.md +4 -1528
- package/docs/referencia/conta_do_whatsapp_business/in_progress_on_behalf_requests_api.md +1 -1
- package/docs/referencia/conta_do_whatsapp_business/migration_intent_api.md +4 -1577
- package/docs/referencia/conta_do_whatsapp_business/obo_mobility_intent_api.md +1 -1
- package/docs/referencia/conta_do_whatsapp_business/phone_number_management_api.md +4 -1682
- package/docs/referencia/conta_do_whatsapp_business/schedules_api.md +4 -1768
- package/docs/referencia/conta_do_whatsapp_business/set_obo_mobility_intent_api.md +1 -1
- package/docs/referencia/conta_do_whatsapp_business/set_solution_migration_intent_api.md +1 -1
- package/docs/referencia/conta_do_whatsapp_business/subscribed_apps_api.md +4 -2174
- package/docs/referencia/conta_do_whatsapp_business/template_api.md +4 -972
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_activities_api.md +4 -838
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_api.md +4 -1380
- package/docs/referencia/conta_do_whatsapp_business/whatsapp_business_account_solutions_list_api.md +4 -850
- package/docs/referencia/groups/groups_invite_link_api.md +8 -0
- package/docs/referencia/groups/groups_join_requests_api.md +8 -0
- package/docs/referencia/groups/groups_participants_api.md +8 -0
- package/docs/referencia/groups/groups_query_api.md +8 -0
- package/docs/referencia/grupo/groups_invite_link_api.md +4 -300
- package/docs/referencia/grupo/groups_join_requests_api.md +4 -682
- package/docs/referencia/grupo/groups_participants_api.md +4 -270
- package/docs/referencia/grupo/groups_query_api.md +4 -432
- package/docs/referencia/historico_de_mensagens/whatsapp_business_message_history_events_api.md +4 -862
- package/docs/referencia/inscricao/application_connected_client_businesses.md +4 -808
- package/docs/referencia/inscricao/application_solutions_api.md +4 -870
- package/docs/referencia/inscricao/solution_creation_api.md +4 -820
- package/docs/referencia/intencao_de_migracao_da_conta_do_whatsapp_business/migration_intent_details_api.md +4 -720
- package/docs/referencia/midias/media_api.md +4 -338
- package/docs/referencia/midias/media_download_api.md +4 -156
- package/docs/referencia/numero_da_conta_do_whatsapp/whatsapp_account_number_api.md +4 -774
- package/docs/referencia/perfil_do_whatsapp_business/whatsapp_business_profile_node_api.md +4 -1490
- package/docs/referencia/solucao_do_whatsapp_business/accept_deactivation_request_api.md +4 -758
- package/docs/referencia/solucao_do_whatsapp_business/access_token_api.md +4 -700
- package/docs/referencia/solucao_do_whatsapp_business/reject_deactivation_request_api.md +4 -808
- package/docs/referencia/solucao_do_whatsapp_business/send_deactivation_request_api.md +4 -774
- package/docs/referencia/solucao_do_whatsapp_business/solution_accept_api.md +4 -808
- package/docs/referencia/solucao_do_whatsapp_business/solution_details_api.md +4 -764
- package/docs/referencia/solucao_do_whatsapp_business/solution_reject_api.md +4 -794
- package/docs/referencia/telefone_do_whatsapp_business/block_api.md +4 -538
- package/docs/referencia/telefone_do_whatsapp_business/business_compliance_information_api.md +4 -1604
- package/docs/referencia/telefone_do_whatsapp_business/business_encryption_api.md +4 -1398
- package/docs/referencia/telefone_do_whatsapp_business/calling_api.md +4 -594
- package/docs/referencia/telefone_do_whatsapp_business/encrypted_messages_api.md +4 -478
- package/docs/referencia/telefone_do_whatsapp_business/groups_management_api.md +4 -481
- package/docs/referencia/telefone_do_whatsapp_business/marketing_messages_lite_api.md +4 -311
- package/docs/referencia/telefone_do_whatsapp_business/media_upload_api.md +4 -184
- package/docs/referencia/telefone_do_whatsapp_business/message_api.md +4 -1794
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_api.md +4 -373
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_deregister_api.md +4 -710
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_registration.md +4 -776
- package/docs/referencia/telefone_do_whatsapp_business/phone_number_verification_request_code_api.md +4 -730
- package/docs/referencia/telefone_do_whatsapp_business/register_api.md +4 -407
- package/docs/referencia/telefone_do_whatsapp_business/settings_api.md +4 -670
- package/docs/referencia/telefone_do_whatsapp_business/verify_code_api.md +4 -742
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_message_history_api.md +4 -928
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_official_business_account_status_api.md +4 -1536
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_account_phone_number_api.md +4 -1596
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_profile_api.md +4 -1474
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_api.md +4 -1175
- package/docs/referencia/telefone_do_whatsapp_business/whatsapp_business_qr_code_management_api.md +4 -1311
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/request_verification_code_api.md +4 -774
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/verify_code_api.md +4 -764
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_api.md +4 -1378
- package/docs/referencia/telefone_pre_verificado_do_whatsapp_business/whatsapp_business_pre_verified_phone_number_partners_api.md +4 -816
- package/docs/referencia/usuario/assigned_whatsapp_business_accounts_api.md +4 -860
- package/docs/referencia/webhooks/whatsapp_incoming_webhook_payload.md +4 -1651
- package/docs/referencia/whatsapp_business_account/extended_credits_api.md +8 -0
- package/docs/referencia/whatsapp_business_phone_number/commerce_settings_api.md +8 -0
- package/docs/suporte/error_codes.md +88 -89
- package/docs/suporte/migrating_from_onprem_to_cloud.md +222 -0
- package/docs/suporte/support.md +77 -186
- package/docs/suporte.md +77 -186
- package/docs/throughput.md +60 -0
- package/docs/upcoming_messaging_limits_changes.md +132 -0
- package/docs/visao_geral/overview.md +354 -306
- package/docs/webhooks/create_webhook_endpoint.md +158 -0
- package/docs/webhooks/reference/messages/group.md +182 -0
- package/docs/webhooks/referencia/account_update.md +27 -27
- package/docs/webhooks/referencia/messages/status.md +35 -35
- package/docs/webhooks/visao_geral/message_echoes.md +1 -1
- package/docs/webhooks/visao_geral/overview.md +23 -15
- package/package.json +1 -1
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
<!-- Source: https://developers.facebook.com/documentation/business-messaging/whatsapp/analytics -->
|
|
2
|
-
<!-- Scraped:
|
|
2
|
+
<!-- Scraped: 2026-01-24T00:25:48.873Z -->
|
|
3
3
|
|
|
4
4
|
# Análise
|
|
5
5
|
|
|
6
|
-
Updated:
|
|
6
|
+
Updated: 12 de dez de 2025
|
|
7
7
|
|
|
8
|
-
A partir de 1º de dezembro de 2025, a janela máxima de retrospectiva para análises de mensagens, conversas e preços será
|
|
8
|
+
A partir de 1º de dezembro de 2025, a janela máxima de retrospectiva para análises de mensagens, conversas e preços será alterada de dez anos para um ano. A janela de retrospectiva para análises de modelos e grupos de modelos não será afetada e continuará sendo de 90 dias.
|
|
9
9
|
|
|
10
|
-
Este documento descreve como consultar análises de mensagens, conversas e modelos. Isso inclui o número de mensagens enviadas de um número de telefone comercial, o número de conversas e os respectivos custos para uma conta comercial do WhatsApp (WABA
|
|
10
|
+
Este documento descreve como consultar análises de mensagens, conversas e modelos. Isso inclui o número de mensagens enviadas de um número de telefone comercial, o número de conversas e os respectivos custos para uma conta comercial do WhatsApp (WABA) ou o número de vezes que determinado modelo foi lido.
|
|
11
11
|
|
|
12
12
|
Somente métricas de números de telefone comerciais e modelos associados à sua WABA no momento da solicitação serão incluídas nas respostas.
|
|
13
13
|
|
|
@@ -22,13 +22,13 @@ curl -g 'https://graph.facebook.com/<API_VERSION>/<WHATSAPP_BUSINESS_ACCOUNT_ID>
|
|
|
22
22
|
-H 'Authorization: Bearer <ACCESS_TOKEN>'
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
### Parâmetros
|
|
25
|
+
### Parâmetros da solicitação
|
|
26
26
|
|
|
27
27
|
Espaço reservado
|
|
28
28
|
|
|
29
29
|
Descrição
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Exemplo de valor
|
|
32
32
|
|
|
33
33
|
`<FIELD>`
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Valor de exemplo
|
|
|
36
36
|
|
|
37
37
|
Métrica. O valor pode ser um destes:
|
|
38
38
|
|
|
39
|
-
- [`analytics`](#analytics
|
|
39
|
+
- [`analytics`](#messaging-analytics)- [`conversation_analytics`](#conversation-analytics)- [`pricing_analytics`](#pricing-analytics)- [`template_analytics`](#template-analytics)- [`template_group_analytics`](#template-group-analytics)- [`call_analytics`](#call-analytics)
|
|
40
40
|
|
|
41
41
|
`analytics`
|
|
42
42
|
|
|
@@ -44,11 +44,11 @@ Métrica. O valor pode ser um destes:
|
|
|
44
44
|
|
|
45
45
|
**Obrigatório.**
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
Parâmetro de filtragem de métricas. Inclua parâmetros adicionais de filtragem usando pontos.
|
|
48
48
|
|
|
49
49
|
Consulte possíveis valores nestas seções:
|
|
50
50
|
|
|
51
|
-
- [Parâmetros de análise de mensagens](#messaging-analytics-parameters)- [Parâmetros de análise de conversas](#conversation-analytics-parameters)- [Parâmetros de análise de modelos](#template-analytics-parameters)- [Parâmetros de análise de grupo de modelos](#template-group-analytics-parameters)
|
|
51
|
+
- [Parâmetros de análise de mensagens](#messaging-analytics-parameters)- [Parâmetros de análise de conversas](#conversation-analytics-parameters)- [Parâmetros de análise de modelos](#template-analytics-parameters)- [Parâmetros de análise de grupo de modelos](#template-group-analytics-parameters)- [Parâmetros de análise de ligações](#call-analytics-parameters)
|
|
52
52
|
|
|
53
53
|
`.start(1543543200).end(1544148000).granularity(DAY)`
|
|
54
54
|
|
|
@@ -80,7 +80,7 @@ Tipo: registro de data e hora UNIX
|
|
|
80
80
|
|
|
81
81
|
`granularity`
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
Tipo: string
|
|
84
84
|
|
|
85
85
|
**Obrigatório.**
|
|
86
86
|
|
|
@@ -90,7 +90,7 @@ tipo: Cadeia de caracteres
|
|
|
90
90
|
|
|
91
91
|
`phone_numbers`
|
|
92
92
|
|
|
93
|
-
|
|
93
|
+
Tipo: matriz
|
|
94
94
|
|
|
95
95
|
**Opcional.**
|
|
96
96
|
|
|
@@ -98,15 +98,19 @@ tipo: matriz
|
|
|
98
98
|
|
|
99
99
|
`product_types`
|
|
100
100
|
|
|
101
|
-
|
|
101
|
+
Tipo: matriz
|
|
102
102
|
|
|
103
103
|
**Opcional.**
|
|
104
104
|
|
|
105
|
-
São os tipos de mensagens
|
|
105
|
+
São os tipos de mensagens (mensagens de notificação e/ou de suporte ao cliente) para os quais você quer recuperar notificações. Caso a matriz não seja fornecida, retornaremos análises para todas as mensagens.
|
|
106
|
+
|
|
107
|
+
Valores compatíveis:
|
|
108
|
+
|
|
109
|
+
- `0` – para mensagens de modelo enviadas a usuários do WhatsApp- `2` – para mensagens que não são de modelo enviadas a usuários do WhatsApp- `100` – para mensagens recebidas enviadas por usuários do WhatsApp para você
|
|
106
110
|
|
|
107
111
|
`country_codes`
|
|
108
112
|
|
|
109
|
-
|
|
113
|
+
Tipo: matriz
|
|
110
114
|
|
|
111
115
|
**Opcional.**
|
|
112
116
|
|
|
@@ -116,15 +120,15 @@ São os países referentes à análise que você quer recuperar. Forneça uma ma
|
|
|
116
120
|
|
|
117
121
|
**Cenário**: você precisa do número de mensagens enviadas e entregues por todos os números de telefone associados à sua WABA.
|
|
118
122
|
|
|
119
|
-
**Solução sugerida
|
|
123
|
+
**Solução sugerida:** use os seguintes parâmetros de filtragem: `start`, `end`, `granularity`.
|
|
120
124
|
|
|
121
125
|
```
|
|
122
126
|
curl -i -X GET "https://graph.facebook.com/v24.0/102290129340398
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
127
|
+
?fields=analytics
|
|
128
|
+
.start(1543543200)
|
|
129
|
+
.end(1544148000)
|
|
130
|
+
.granularity(DAY)
|
|
131
|
+
&access_token=BLI8lkj..."
|
|
128
132
|
```
|
|
129
133
|
|
|
130
134
|
Uma resposta bem-sucedida retornará um objeto `analytics` com os dados solicitados:
|
|
@@ -135,7 +139,7 @@ Uma resposta bem-sucedida retornará um objeto `analytics` com os dados solicita
|
|
|
135
139
|
|
|
136
140
|
## Análise de conversas
|
|
137
141
|
|
|
138
|
-
O campo `conversation_analytics` fornece [informações de custo e conversa](/documentation/business-messaging/whatsapp/pricing#conversations) para uma WABA específica. Quando você chamar `/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=conversation_analytics.{filtering-parameters}`, será possível anexar os
|
|
142
|
+
O campo `conversation_analytics` fornece [informações de custo e conversa](/documentation/business-messaging/whatsapp/pricing#conversations) para uma WABA específica. Quando você chamar `/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=conversation_analytics.{filtering-parameters}`, será possível anexar os parâmetros a seguir.
|
|
139
143
|
|
|
140
144
|
### Parâmetros de análise de conversas
|
|
141
145
|
|
|
@@ -161,7 +165,7 @@ Tipo: registro de data e hora UNIX
|
|
|
161
165
|
|
|
162
166
|
`granularity`
|
|
163
167
|
|
|
164
|
-
|
|
168
|
+
Tipo: string
|
|
165
169
|
|
|
166
170
|
**Obrigatório.**
|
|
167
171
|
|
|
@@ -171,7 +175,7 @@ tipo: Cadeia de caracteres
|
|
|
171
175
|
|
|
172
176
|
`phone_numbers`
|
|
173
177
|
|
|
174
|
-
|
|
178
|
+
Tipo: matriz
|
|
175
179
|
|
|
176
180
|
**Opcional.**
|
|
177
181
|
|
|
@@ -181,24 +185,30 @@ tipo: matriz
|
|
|
181
185
|
|
|
182
186
|
**Opcional.**
|
|
183
187
|
|
|
184
|
-
É a lista de métricas que você quer receber. Se você enviar uma lista vazia, retornaremos resultados para todos os tipos de métrica.
|
|
188
|
+
É a lista de métricas que você quer receber. Se você enviar uma lista vazia, retornaremos resultados para todos os tipos de métrica.
|
|
189
|
+
|
|
190
|
+
Opções compatíveis: {#supported}
|
|
185
191
|
|
|
186
192
|
- `COST`: inclui cobranças aproximadas para esse período, na moeda da WABA.- `CONVERSATION`: inclui a contagem de conversas para esse período.
|
|
187
193
|
|
|
188
|
-
**
|
|
194
|
+
**Exceção:**
|
|
195
|
+
|
|
196
|
+
**`COST` não será retornado para WABAs que compartilham a linha de crédito de um parceiro de solução. Caso sua WABA compartilhe a linha de crédito de um parceiro de solução, entre em contato com ele para entender as cobranças.** Saiba o que acontece se você consultar uma WABA que compartilha a linha de crédito de um parceiro de solução:
|
|
189
197
|
|
|
190
|
-
- Se nenhum `metric_types` for especificado na solicitação, somente `CONVERSATION` será retornado.- Se apenas `CONVERSATION` for especificado, somente `CONVERSATION` será retornado.- Caso somente COST seja especificado, a seguinte exceção será retornada:
|
|
198
|
+
- Se nenhum `metric_types` for especificado na solicitação, somente `CONVERSATION` será retornado.- Se apenas `CONVERSATION` for especificado, somente `CONVERSATION` será retornado.- Caso somente `COST` seja especificado, a seguinte exceção será retornada:
|
|
191
199
|
- Título: "Custo não disponível"- Mensagem: "O custo não é mais exibido para empresas que cobram por meio de um parceiro (ou seja, BSP). Para entender as cobranças, entre em contato com seu parceiro."
|
|
192
200
|
|
|
193
201
|
Se você consultar um período que inclua 1º de julho de 2023 (por exemplo, 1º de maio a 1º de agosto de 2023), a resposta incluirá a exceção acima.
|
|
194
202
|
|
|
195
|
-
|
|
203
|
+
Isso não se aplica se a consulta for sobre o ponto de extremidade `conversation_analytics`.
|
|
196
204
|
|
|
197
205
|
`conversation_categories`
|
|
198
206
|
|
|
199
207
|
**Opcional.**
|
|
200
208
|
|
|
201
|
-
Lista de [categorias de conversa](/documentation/business-messaging/whatsapp/pricing#conversation-categories). Se você enviar uma lista vazia, retornaremos resultados para todas as categorias de conversa.
|
|
209
|
+
Lista de [categorias de conversa](/documentation/business-messaging/whatsapp/pricing#conversation-categories). Se você enviar uma lista vazia, retornaremos resultados para todas as categorias de conversa.
|
|
210
|
+
|
|
211
|
+
Opções compatíveis:
|
|
202
212
|
|
|
203
213
|
- `AUTHENTICATION`- `MARKETING`- `SERVICE`- `UTILITY`
|
|
204
214
|
|
|
@@ -208,7 +218,7 @@ Lista de [categorias de conversa](/documentation/business-messaging/whatsapp/pri
|
|
|
208
218
|
|
|
209
219
|
É uma lista de tipos de conversa. Se você enviar uma lista vazia, retornaremos resultados para todos os tipos de conversa. Opções compatíveis:
|
|
210
220
|
|
|
211
|
-
- `FREE_ENTRY`: conversas que têm origem em um [ponto de entrada gratuito](/documentation/business-messaging/whatsapp/pricing#free-entry-point-windows).- `FREE_TIER`: conversas realizadas dentro do [
|
|
221
|
+
- `FREE_ENTRY`: conversas que têm origem em um [ponto de entrada gratuito](/documentation/business-messaging/whatsapp/pricing#free-entry-point-windows).- `FREE_TIER`: conversas realizadas dentro do [período gratuito](/documentation/business-messaging/whatsapp/pricing#free-entry-point-windows) mensal.- `REGULAR`: qualquer conversa que não tenha sido originada em um [ponto de entrada gratuito](/documentation/business-messaging/whatsapp/pricing#free-entry-point-windows) ou que ultrapasse a cota mensal do período gratuito.
|
|
212
222
|
|
|
213
223
|
`conversation_directions`
|
|
214
224
|
|
|
@@ -216,13 +226,13 @@ Lista de [categorias de conversa](/documentation/business-messaging/whatsapp/pri
|
|
|
216
226
|
|
|
217
227
|
É uma lista de direções de conversa. Se você enviar uma lista vazia, retornaremos resultados para todas as direções de conversa. Opções compatíveis:
|
|
218
228
|
|
|
219
|
-
- `BUSINESS_INITIATED`: conversas iniciadas pela empresa.- `USER_INITIATED`: conversas iniciadas por um usuário/cliente.- `UNKNOWN`: o sistema não consegue determinar a direção.
|
|
229
|
+
- `BUSINESS_INITIATED`: conversas iniciadas pela empresa.- `USER_INITIATED`: conversas iniciadas por um usuário final/cliente.- `UNKNOWN`: o sistema não consegue determinar a direção.
|
|
220
230
|
|
|
221
231
|
`dimensions`
|
|
222
232
|
|
|
223
233
|
**Opcional.**
|
|
224
234
|
|
|
225
|
-
É a lista de detalhamentos que você quer aplicar às suas métricas. Se você enviar uma lista vazia, retornaremos os resultados sem
|
|
235
|
+
É a lista de detalhamentos que você quer aplicar às suas métricas. Se você enviar uma lista vazia, retornaremos os resultados sem detalhamentos. Opções compatíveis:
|
|
226
236
|
|
|
227
237
|
- `CONVERSATION_CATEGORY`- `CONVERSATION_DIRECTION`- `CONVERSATION_TYPE`- `COUNTRY`- `PHONE`
|
|
228
238
|
|
|
@@ -236,9 +246,9 @@ Ao definir um período, você pode consultar informações de conversas e custos
|
|
|
236
246
|
|
|
237
247
|
**Cenário**: em um determinado mês, você quer recuperar informações de conversa e custo de todos os números de telefone associados a uma WABA.
|
|
238
248
|
|
|
239
|
-
**Solução sugerida
|
|
249
|
+
**Solução sugerida:** use os seguintes parâmetros de filtragem:
|
|
240
250
|
|
|
241
|
-
- `start`: indica o início do período. Nesse caso, é o início do mês referente às métricas que você quer ver.- `end`: indica o término do período. Nesse caso, é o
|
|
251
|
+
- `start`: indica o início do período. Nesse caso, é o início do mês referente às métricas que você quer ver.- `end`: indica o término do período. Nesse caso, é o início do mês referente às métricas que você quer ver.- `granularity`: representa o detalhamento desejado para os pontos de dados. No exemplo abaixo, usamos `MONTHLY` para que cada ponto represente o valor de um mês de dados.- `phone_numbers`: ao enviar uma matriz vazia, retornaremos informações para todos os números de telefone associados à WABA.- `dimensions`: defina todos os detalhamentos disponíveis: `"CONVERSATION_CATEGORY"`, `"CONVERSATION_TYPE"`, `"COUNTRY"` e `"PHONE"`.
|
|
242
252
|
|
|
243
253
|
Nesse caso, não é preciso especificar `country_codes`, `metric_types`, `conversation_types` nem `conversation_categories`. Se você não enviar um valor para esses campos, retornaremos todas as opções disponíveis. Depois de configurar o URL, faça uma solicitação GET:
|
|
244
254
|
|
|
@@ -261,9 +271,9 @@ Uma resposta bem-sucedida retornará um objeto `conversation_analytics` com os d
|
|
|
261
271
|
|
|
262
272
|
#### Como consultar dados de um número específico usando todos os detalhamentos e a granularidade de meia hora
|
|
263
273
|
|
|
264
|
-
**Cenário**: em um determinado período, você quer recuperar informações de
|
|
274
|
+
**Cenário**: em um determinado período, você quer recuperar informações de conversas e custos de um número de telefone específico associado a uma WABA. Sua intenção é usar todos os detalhamentos possíveis nos resultados. É preciso que cada ponto represente meia hora de dados.
|
|
265
275
|
|
|
266
|
-
**Solução sugerida**:
|
|
276
|
+
**Solução sugerida**: use os seguintes parâmetros de filtragem:
|
|
267
277
|
|
|
268
278
|
- `start`: indica o início do período.- `end`: indica o término do período.- `granularity`: representa o detalhamento desejado para os pontos de dados. No exemplo abaixo, usamos `HALF_HOUR` para que cada ponto represente o valor de meia hora de dados.- `phone_numbers`: o número de telefone sobre o qual você precisa de informações.- `dimensions`: defina todos os detalhamentos disponíveis: `CONVERSATION_CATEGORY`, `CONVERSATION_TYPE`, `COUNTRY` e `PHONE`.
|
|
269
279
|
|
|
@@ -291,7 +301,7 @@ Uma resposta bem-sucedida retornará um objeto `conversation_analytics` com os d
|
|
|
291
301
|
|
|
292
302
|
**Cenário**: em um determinado período, você quer recuperar as informações de conversa e custo de todos os números de telefone associados a uma WABA. Sua intenção é detalhar os resultados por tipo de conversa.
|
|
293
303
|
|
|
294
|
-
**Solução sugerida**:
|
|
304
|
+
**Solução sugerida**: use os seguintes parâmetros de filtragem:
|
|
295
305
|
|
|
296
306
|
- `start`: indica o início do período.- `end`: indica o término do período.- `granularity`: representa o detalhamento desejado para os pontos de dados. No exemplo abaixo, usamos `MONTHLY` para que cada ponto represente o valor de meio mês de dados.- `phone_numbers`: se você enviar uma matriz vazia, retornaremos informações sobre todos os números de telefone associados à WABA.- `dimensions`: defina como `CONVERSATION_TYPE`.
|
|
297
307
|
|
|
@@ -382,7 +392,7 @@ Filtro
|
|
|
382
392
|
|
|
383
393
|
Descrição
|
|
384
394
|
|
|
385
|
-
|
|
395
|
+
Exemplo de valor
|
|
386
396
|
|
|
387
397
|
`<COUNTRY_CODES>`
|
|
388
398
|
|
|
@@ -400,7 +410,7 @@ _Matriz de strings_
|
|
|
400
410
|
|
|
401
411
|
**Opcional.**
|
|
402
412
|
|
|
403
|
-
É a lista de detalhamentos que você quer aplicar às suas métricas. Se você enviar uma lista vazia, retornaremos os resultados sem
|
|
413
|
+
É a lista de detalhamentos que você quer aplicar às suas métricas. Se você enviar uma lista vazia, retornaremos os resultados sem detalhamentos.
|
|
404
414
|
|
|
405
415
|
Os valores podem ser os seguintes:
|
|
406
416
|
|
|
@@ -440,7 +450,9 @@ _Matriz de strings_
|
|
|
440
450
|
|
|
441
451
|
Os valores podem ser os seguintes:
|
|
442
452
|
|
|
443
|
-
- `COST`: cobranças aproximadas por mensagens entregues nesse período na moeda da WABA.- `VOLUME`: inclui o número de mensagens entregues nesse período.
|
|
453
|
+
- `COST`: cobranças aproximadas por mensagens entregues nesse período, na moeda da WABA.- `VOLUME`: inclui o número de mensagens entregues nesse período.
|
|
454
|
+
|
|
455
|
+
**Informamos que `COST` não será retornado para WABAs que compartilham a linha de crédito de um parceiro de soluções. Caso sua WABA compartilhe a linha de crédito de um parceiro de solução, entre em contato com ele para entender as cobranças.**
|
|
444
456
|
|
|
445
457
|
`[COST, VOLUME]`
|
|
446
458
|
|
|
@@ -498,7 +510,7 @@ _String_
|
|
|
498
510
|
|
|
499
511
|
**Obrigatório.**
|
|
500
512
|
|
|
501
|
-
|
|
513
|
+
Identificação da conta do WhatsApp Business.
|
|
502
514
|
|
|
503
515
|
`102290129340398`
|
|
504
516
|
|
|
@@ -528,7 +540,7 @@ O valor da propriedade `tier` representa uma concatenação dos limites inferior
|
|
|
528
540
|
|
|
529
541
|
**Observações**
|
|
530
542
|
|
|
531
|
-
- Para verificar o nível de volume atual, leia os valores `tier`, `country` e `pricing_category`. O número inteiro `<UPPER>`
|
|
543
|
+
- Para verificar o nível de volume atual, leia os valores `tier`, `country` e `pricing_category`. O número inteiro `tier` de `<UPPER>` (o número inteiro depois dos dois pontos) indica seu nível atual para `country` e `pricing_category` (por exemplo, Índia e utilidade, respectivamente).- Se quiser saber quantas mensagens você precisa enviar para atingir o próximo nível em um `country` e uma `pricing_category`, subtraia o número inteiro de `volume` do número inteiro `<UPPER>` do valor do nível.- Os níveis de volume estarão disponíveis somente para mensagens de modelo de autenticação e utilidade. Para mensagens de modelo de marketing (às quais os níveis de volume não serão aplicados), o nível será definido como `0:MAX`.- A propriedade `tier` será omitida em pontos de dados que representam mensagens gratuitas, já que elas não contribuem para a contagem dos níveis.- Os níveis de volume serão determinados exclusivamente pela Meta. Todos os dados de insights são aproximados devido a pequenas variações no processamento de dados. Não se deve depositar confiança excessiva nos dados de insights.
|
|
532
544
|
|
|
533
545
|
### Exemplo de solicitação
|
|
534
546
|
|
|
@@ -545,7 +557,7 @@ curl 'https://graph.facebook.com/v24.0/161311403722088?fields=pricing_analytics.
|
|
|
545
557
|
|
|
546
558
|
## Análise de modelos
|
|
547
559
|
|
|
548
|
-
A análise de modelos descreve o número de vezes que um modelo foi enviado, entregue e lido, além da quantidade de cliques que os botões de [URL](/documentation/business-messaging/whatsapp/templates/components#url-buttons) ou de [resposta rápida](/documentation/business-messaging/whatsapp/templates/components#quick-reply-buttons) receberam no modelo. Além disso, as empresas [
|
|
560
|
+
A análise de modelos descreve o número de vezes que um modelo foi enviado, entregue e lido, além da quantidade de cliques que os botões de [URL](/documentation/business-messaging/whatsapp/templates/components#url-buttons) ou de [resposta rápida](/documentation/business-messaging/whatsapp/templates/components#quick-reply-buttons) receberam no modelo. Além disso, as empresas [integradas à API de Mensagens de Marketing para o WhatsApp](/documentation/business-messaging/whatsapp/marketing-messages/overview) podem rastrear métricas de conversão fora do site.
|
|
549
561
|
|
|
550
562
|
Os dados são retornados com granularidade diária no fuso horário padrão UTC e no fuso horário da WABA, com uma janela de retrospectiva de até 90 dias. Para mostrar dados no fuso horário configurado da WABA, transmita o parâmetro use\_waba\_timezone com um valor true.
|
|
551
563
|
|
|
@@ -557,7 +569,7 @@ Exibir dados no fuso horário configurado da WABA transmitindo o parâmetro `use
|
|
|
557
569
|
|
|
558
570
|
### Limitações
|
|
559
571
|
|
|
560
|
-
- As análises de modelos só estarão disponíveis na API Local se a conta não estiver usando a API de Nuvem para isso.- A análise de cliques no botão está disponível apenas para modelos categorizados como `MARKETING` ou `UTILITY`.- Não há compatibilidade com WABAs pertencentes ou compartilhadas com contas empresariais da Meta na União Europeia, no Reino Unido ou no Japão, tampouco com WABAs que tenham um número de telefone comercial com código do país desses locais.- As métricas de conversão fora do site estão disponíveis apenas para empresas integradas à
|
|
572
|
+
- As análises de modelos só estarão disponíveis na API Local se a conta não estiver usando a API de Nuvem para isso.- A análise de cliques no botão está disponível apenas para modelos categorizados como `MARKETING` ou `UTILITY`.- Não há compatibilidade com WABAs pertencentes ou compartilhadas com contas empresariais da Meta na União Europeia, no Reino Unido ou no Japão, tampouco com WABAs que tenham um número de telefone comercial com código do país desses locais.- As métricas de conversão fora do site estão disponíveis apenas para empresas integradas à API de Mensagem de Marketing para o WhatsApp.- Os dados de eventos de leitura e clique em mensagens de modelo do WhatsApp estão disponíveis por até sete dias a partir da data de envio da mensagem. Depois desse período, o número de leituras/cliques correspondente será redefinido para zero e nenhuma outra atualização será registrada para essas mensagens.
|
|
561
573
|
|
|
562
574
|
### Como confirmar as análises de modelos
|
|
563
575
|
|
|
@@ -585,7 +597,7 @@ Nome
|
|
|
585
597
|
|
|
586
598
|
Descrição
|
|
587
599
|
|
|
588
|
-
|
|
600
|
+
Exemplo de valor
|
|
589
601
|
|
|
590
602
|
`start`
|
|
591
603
|
|
|
@@ -639,15 +651,15 @@ _Matriz de enumerações_
|
|
|
639
651
|
|
|
640
652
|
**Opcional.**
|
|
641
653
|
|
|
642
|
-
O nó `COST` NÃO está disponível para empresas que fazem o faturamento através de um parceiro de solução. Para entender as cobranças, entre em contato com seu parceiro.
|
|
643
|
-
|
|
644
654
|
Os tipos de métricas a serem recuperadas. Se a matriz for omitida ou estiver vazia, serão retornadas as análises de todos os tipos de métricas.
|
|
645
655
|
|
|
646
656
|
Valores possíveis:
|
|
647
657
|
|
|
648
|
-
- `COST`- `CLICKED`- `DELIVERED`- `READ`- `SENT`- `APP_ACTIVATIONS (MM
|
|
658
|
+
- `COST`- `CLICKED`- `DELIVERED`- `READ`- `SENT`- `APP_ACTIVATIONS (MM API for WhatsApp only)`- `APP_ADD_TO_CART (MM API for WhatsApp only)`- `APP_CHECKOUTS_INITIATED (MM API for WhatsApp only)`- `APP_PURCHASES (MM API for WhatsApp only)`- `APP_PURCHASES_CONVERSION_VALUE (MM API for WhatsApp only)`- `WEBSITE_ADD_TO_CART (MM API for WhatsApp only)`- `WEBSITE_CHECKOUTS_INITIATED (MM API for WhatsApp only)`- `WEBSITE_PURCHASES (MM API for WhatsApp only)`- `WEBSITE_PURCHASES_CONVERSION_VALUE (MM API for WhatsApp only)`
|
|
659
|
+
|
|
660
|
+
[Acesse este link para saber mais sobre as métricas de custo e clique](#template-analytics-cost-and-click-metrics).
|
|
649
661
|
|
|
650
|
-
|
|
662
|
+
**Informamos que `COST` não será retornado para WABAs que compartilham a linha de crédito de um parceiro de soluções. Caso sua WABA compartilhe a linha de crédito de um parceiro de solução, entre em contato com ele para entender as cobranças.**
|
|
651
663
|
|
|
652
664
|
`[SENT,DELIVERED,READ]`
|
|
653
665
|
|
|
@@ -661,9 +673,9 @@ O tipo de produto das métricas a serem recuperadas. Se omitido, serão retornad
|
|
|
661
673
|
|
|
662
674
|
Valores possíveis:
|
|
663
675
|
|
|
664
|
-
- `CLOUD_API
|
|
676
|
+
- `CLOUD_API`: para filtrar métricas de modelos enviados por meio da API de Nuvem- `MARKETING_MESSAGES_API_FOR_WHATSAPP`: para filtrar métricas de modelos enviados por meio da API de Mensagens de Marketing para WhatsApp
|
|
665
677
|
|
|
666
|
-
`
|
|
678
|
+
`MARKETING_MESSAGES_API_FOR_WHATSAPP`
|
|
667
679
|
|
|
668
680
|
`<USE_WABA_TIMEZONE>`
|
|
669
681
|
|
|
@@ -690,23 +702,23 @@ curl -g 'https://graph.facebook.com/v24.0/109259195336416/template_analytics?sta
|
|
|
690
702
|
-H 'Authorization: Bearer EAAJB...'
|
|
691
703
|
```
|
|
692
704
|
|
|
693
|
-
Exemplo de resposta
|
|
705
|
+
Exemplo de resposta
|
|
694
706
|
|
|
695
707
|
```
|
|
696
|
-
{ "data": [ { "granularity": "DAILY", "product_type": "cloud_api", // Only available to businesses in the Marketing Messages
|
|
708
|
+
{ "data": [ { "granularity": "DAILY", "product_type": "cloud_api", // Only available to businesses in the Marketing Messages API for WhatsApp alpha "data_points": [ { "template_id": "1421988012088524", "start": 1718064000, "end": 1718150400, "sent": 1, "delivered": 1, "read": 1, "cost": [ { "type": "amount_spent", "value": 0.01 }, { "type": "cost_per_delivered", "value": 0.01 } ] }, { "template_id": "2632273056924580", "start": 1718064000, "end": 1718150400, "sent": 1, "delivered": 1, "read": 1, "clicked": [ { "type": "quick_reply_button", "button_content": "Contact Support", "count": 108 }, { "type": "unique_url_button", "button_content": "Tell me more", "count": 16 } ], "cost": [ { "type": "amount_spent", "value": 0.03 }, { "type": "cost_per_delivered", "value": 0.03 }, { "type": "cost_per_url_button_click", "value": 0.03 } ] } ] } ], "paging": { "cursors": { "before": "MAZDZD", "after": "MjQZD" } }}
|
|
697
709
|
```
|
|
698
710
|
|
|
699
|
-
###
|
|
711
|
+
### Custo de análise de modelos e métricas de cliques
|
|
700
712
|
|
|
701
713
|
As **métricas de custo** são retornadas como uma matriz de objetos de custo, cada um com um tipo e valor. Os tipos podem ser:
|
|
702
714
|
|
|
703
|
-
- `amount_spent`: o valor total gasto em conversas abertas no período entre `start` e `end` como resultado do envio do modelo.
|
|
715
|
+
- `amount_spent`: o valor total gasto em conversas abertas no período entre `start` e `end` como resultado do envio do modelo. Consulte a seção [Preços baseados em conversas](/documentation/business-messaging/whatsapp/pricing#opening-conversations).- `cost_per_delivered`: o valor `amount_spent` dividido pelo número de vezes que o modelo foi entregue no período entre `start` e `end`.- `cost_per_url_button_click`: o valor `amount_spent` dividido pelo número de cliques no botão de URL do modelo no período entre `start` e `end`. Cliques no botão de resposta rápida não são incluídos. Objeto omitido se o modelo não tiver um botão de URL.
|
|
704
716
|
|
|
705
717
|
As **métricas de clique** são retornadas como uma matriz de objetos JSON, cada um com um tipo e valor. Os cliques são retornados apenas para botões de URL e de resposta rápida em modelos categorizados como `MARKETING` ou `UTILITY`.
|
|
706
718
|
|
|
707
719
|
Os tipos podem ser:
|
|
708
720
|
|
|
709
|
-
- `url_button
|
|
721
|
+
- `url_button`: o número total de cliques no botão de URL.- `unique_url_button`: cliques únicos acompanham o número de contas distintas do WhatsApp que clicaram em um botão. Essa métrica ajuda você a compreender quantos usuários individuais estão interagindo com seus CTAs, eliminando cliques duplicados do mesmo destinatário e proporcionando uma mensuração precisa do engajamento.
|
|
710
722
|
|
|
711
723
|
### Como desabilitar a análise de cliques no botão
|
|
712
724
|
|
|
@@ -720,13 +732,13 @@ POST /<TEMPLATE_ID>
|
|
|
720
732
|
&category=<TEMPLATE_CATEGORY>
|
|
721
733
|
```
|
|
722
734
|
|
|
723
|
-
#### Parâmetros
|
|
735
|
+
#### Parâmetros da solicitação
|
|
724
736
|
|
|
725
737
|
Espaço reservado
|
|
726
738
|
|
|
727
739
|
Descrição
|
|
728
740
|
|
|
729
|
-
|
|
741
|
+
Exemplo de valor
|
|
730
742
|
|
|
731
743
|
`<WHATSAPP_TEMPLATE_ID>`
|
|
732
744
|
|
|
@@ -734,7 +746,7 @@ _ID do modelo_
|
|
|
734
746
|
|
|
735
747
|
**Obrigatório.**
|
|
736
748
|
|
|
737
|
-
|
|
749
|
+
ID do modelo.
|
|
738
750
|
|
|
739
751
|
`245435364965041`
|
|
740
752
|
|
|
@@ -816,7 +828,7 @@ GET /<WHATSAPP_BUSINESS_ACCOUNT_ID>/template_group_analytics
|
|
|
816
828
|
&template_group_ids=[<TEMPLATE_GROUP_IDS>]
|
|
817
829
|
```
|
|
818
830
|
|
|
819
|
-
### Parâmetros de
|
|
831
|
+
### Parâmetros de análise de grupo de modelos
|
|
820
832
|
|
|
821
833
|
Espaço reservado
|
|
822
834
|
|
|
@@ -828,7 +840,7 @@ Valor de exemplo
|
|
|
828
840
|
|
|
829
841
|
**Obrigatório.**
|
|
830
842
|
|
|
831
|
-
|
|
843
|
+
Identificação da conta do WhatsApp Business.
|
|
832
844
|
|
|
833
845
|
`102290129340398`
|
|
834
846
|
|
|
@@ -866,15 +878,15 @@ _Matriz de strings_
|
|
|
866
878
|
|
|
867
879
|
**Opcional.**
|
|
868
880
|
|
|
869
|
-
É a matriz de métricas que você quer receber. Se você enviar uma matriz vazia, a API retornará resultados para todos os tipos de
|
|
881
|
+
É a matriz de métricas que você quer receber. Se você enviar uma matriz vazia, a API retornará resultados para todos os tipos de métricas.
|
|
870
882
|
|
|
871
883
|
Os valores podem ser os seguintes:
|
|
872
884
|
|
|
873
885
|
- `cost`- `clicked`- `delivered`- `read`- `sent`
|
|
874
886
|
|
|
875
|
-
`COST` não está disponível para clientes empresariais que recebem cobranças
|
|
887
|
+
`COST` não está disponível para clientes empresariais que recebem cobranças por meio de um parceiro de solução.
|
|
876
888
|
|
|
877
|
-
|
|
889
|
+
Consulte [Métricas de custo e clique](#template-group-cost-and-click-metrics) para saber mais sobre esses tipos de métricas.
|
|
878
890
|
|
|
879
891
|
```
|
|
880
892
|
[
|
|
@@ -921,17 +933,139 @@ O exemplo abaixo foi truncado com uma elipse (`...`) para fins de concisão.
|
|
|
921
933
|
{ "data": [ { "granularity": "DAILY", "data_points": [ { "template_group_id": "1044106240855852", "start": 1739491200, "end": 1739577600, "sent": 1460, "delivered": 1460, "read": 1399 }, { "template_group_id": "1044106240855852", "start": 1739404800, "end": 1739491200, "sent": 673, "delivered": 673, "read": 645 }, ... ] } ], "paging": { "cursors": { "before": "MAZDZD", "after": "MjQZD" } }}
|
|
922
934
|
```
|
|
923
935
|
|
|
924
|
-
###
|
|
936
|
+
### Custo de grupo de modelos e métricas de cliques
|
|
925
937
|
|
|
926
938
|
As **métricas de custo** são retornadas como uma matriz de objetos de custo, cada um com um tipo e valor. Os tipos podem ser:
|
|
927
939
|
|
|
928
|
-
- `amount_spent`: o valor total gasto em conversas abertas no período entre `start` e `end` como resultado do envio do modelo.
|
|
940
|
+
- `amount_spent`: o valor total gasto em conversas abertas no período entre `start` e `end` como resultado do envio do modelo. Consulte a seção [Preços baseados em conversas](/documentation/business-messaging/whatsapp/pricing#opening-conversations).- `cost_per_delivered`: o valor `amount_spent` dividido pelo número de vezes que o modelo foi entregue no período entre `start` e `end`.- `cost_per_url_button_click`: o valor `amount_spent` dividido pelo número de cliques no botão de URL do modelo no período entre `start` e `end`. Cliques no botão de resposta rápida não são incluídos. Objeto omitido se o modelo não tiver um botão de URL.
|
|
929
941
|
|
|
930
942
|
As **métricas de clique** são retornadas como uma matriz de objetos JSON, cada um com um tipo e valor. Os cliques são retornados apenas para botões de URL e de resposta rápida em modelos categorizados como `marketing` ou `utility`.
|
|
931
943
|
|
|
932
944
|
Os tipos podem ser:
|
|
933
945
|
|
|
934
|
-
- `url_button
|
|
946
|
+
- `url_button`: o número total de cliques no botão de URL.- `unique_url_button`: cliques únicos acompanham o número de contas distintas do WhatsApp que clicaram em um botão. Essa métrica ajuda você a compreender quantos usuários individuais estão interagindo com seus CTAs, eliminando cliques duplicados do mesmo destinatário e proporcionando uma mensuração precisa do engajamento.
|
|
947
|
+
|
|
948
|
+
## Análise das ligações
|
|
949
|
+
|
|
950
|
+
O campo `call_analytics` fornece o número e o tipo de ligações feitas e recebidas por números de telefone associados a uma WABA específica. Quando você chamar `/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=call_analytics.{filtering-parameters}`, será possível anexar os parâmetros a seguir.
|
|
951
|
+
|
|
952
|
+
### Parâmetros de análise de ligações
|
|
953
|
+
|
|
954
|
+
Nome
|
|
955
|
+
|
|
956
|
+
Descrição
|
|
957
|
+
|
|
958
|
+
Valor de exemplo
|
|
959
|
+
|
|
960
|
+
`start`
|
|
961
|
+
|
|
962
|
+
Tipo: registro de data e hora UNIX
|
|
963
|
+
|
|
964
|
+
**Obrigatório.**
|
|
965
|
+
|
|
966
|
+
A data de início do intervalo para o qual você está recuperando análises.
|
|
967
|
+
|
|
968
|
+
`1728581152`
|
|
969
|
+
|
|
970
|
+
`end`
|
|
971
|
+
|
|
972
|
+
Tipo: registro de data e hora UNIX
|
|
973
|
+
|
|
974
|
+
**Obrigatório.**
|
|
975
|
+
|
|
976
|
+
É a data de término do intervalo para o qual você está recuperando análises.
|
|
977
|
+
|
|
978
|
+
`1728581152`
|
|
979
|
+
|
|
980
|
+
`granularity`
|
|
981
|
+
|
|
982
|
+
Tipo: string
|
|
983
|
+
|
|
984
|
+
**Obrigatório.**
|
|
985
|
+
|
|
986
|
+
É o detalhamento desejado para a análise. Opções compatíveis:
|
|
987
|
+
|
|
988
|
+
- `HALF_HOUR`- `DAILY`- `MONTHLY`
|
|
989
|
+
|
|
990
|
+
`DAILY`
|
|
991
|
+
|
|
992
|
+
`phone_numbers`
|
|
993
|
+
|
|
994
|
+
Tipo: matriz
|
|
995
|
+
|
|
996
|
+
**Opcional.**
|
|
997
|
+
|
|
998
|
+
É a matriz de números de telefone referentes à análise que você quer recuperar. Caso não seja fornecida, todos os números de telefone adicionados à sua WABA serão incluídos.
|
|
999
|
+
|
|
1000
|
+
`[15550783881,15550783882]`
|
|
1001
|
+
|
|
1002
|
+
`country_codes`
|
|
1003
|
+
|
|
1004
|
+
Tipo: matriz
|
|
1005
|
+
|
|
1006
|
+
**Opcional.**
|
|
1007
|
+
|
|
1008
|
+
São os países referentes à análise que você quer recuperar. Forneça uma matriz com códigos de duas letras para os países a serem incluídos. Caso a matriz não seja fornecida, retornaremos análises para todos os países com os quais você se comunicou.
|
|
1009
|
+
|
|
1010
|
+
`[US,BR]`
|
|
1011
|
+
|
|
1012
|
+
`directions`
|
|
1013
|
+
|
|
1014
|
+
_Matriz de enumerações_
|
|
1015
|
+
|
|
1016
|
+
**Opcional.**
|
|
1017
|
+
|
|
1018
|
+
É a direção da ligação referente à análise que você quer recuperar. Opções compatíveis:
|
|
1019
|
+
|
|
1020
|
+
- `USER_INITIATED`- `BUSINESS_INITIATED`
|
|
1021
|
+
|
|
1022
|
+
`USER_INITIATED`
|
|
1023
|
+
|
|
1024
|
+
`dimensions`
|
|
1025
|
+
|
|
1026
|
+
_Matriz de enumerações_
|
|
1027
|
+
|
|
1028
|
+
**Opcional.**
|
|
1029
|
+
|
|
1030
|
+
É a lista de detalhamentos que você quer aplicar às suas métricas. Se você enviar uma lista vazia, retornaremos os resultados sem detalhamentos. Opções compatíveis:
|
|
1031
|
+
|
|
1032
|
+
- `phone`- `direction`- `country`
|
|
1033
|
+
|
|
1034
|
+
`direction`
|
|
1035
|
+
|
|
1036
|
+
`metric_types`
|
|
1037
|
+
|
|
1038
|
+
_Matriz de enumerações_
|
|
1039
|
+
|
|
1040
|
+
**Opcional.**
|
|
1041
|
+
|
|
1042
|
+
É a matriz de métricas que você quer receber. Se você enviar uma matriz vazia, a API retornará resultados para todos os tipos de métricas. Opções compatíveis:
|
|
1043
|
+
|
|
1044
|
+
- `COUNT`- `COST`- `AVERAGE_DURATION`
|
|
1045
|
+
|
|
1046
|
+
`AVERAGE_DURATION`
|
|
1047
|
+
|
|
1048
|
+
### Exemplo
|
|
1049
|
+
|
|
1050
|
+
**Cenário**: você precisa do número de ligações iniciadas pelo usuário e recebidas por todos os números de telefone associados à sua WABA com granularidade por dia.
|
|
1051
|
+
|
|
1052
|
+
**Solução sugerida:** use estes parâmetros de filtragem: `start`, `end`, `granularity`, `directions`.
|
|
1053
|
+
|
|
1054
|
+
```
|
|
1055
|
+
curl -i -X GET "https://graph.facebook.com/v24.0/102290129340398
|
|
1056
|
+
?fields=call_analytics
|
|
1057
|
+
.start(1759302000)
|
|
1058
|
+
.end(1767168000)
|
|
1059
|
+
.granularity(DAILY)
|
|
1060
|
+
.directions(USER_INITIATED)
|
|
1061
|
+
&access_token=BLI8lkj..."
|
|
1062
|
+
```
|
|
1063
|
+
|
|
1064
|
+
Uma resposta bem-sucedida retornará um objeto `call_analytics` com os dados solicitados:
|
|
1065
|
+
|
|
1066
|
+
```
|
|
1067
|
+
{ "call_analytics": { "granularity": "DAILY", "directions": "USER_INITIATED", "data_points": [ { "start": 1765958400, "end": 1766044800, "cost": 0.47795, "count": 35, "average_duration": 106 }, { "start": 1760943600, "end": 1761030000, "cost": 0, "count": 20, "average_duration": 103 }, { "start": 1760857200, "end": 1760943600, "cost": 0, "count": 24, "average_duration": 103 }, # more data points ] }, "id": "102290129340398"}
|
|
1068
|
+
```
|
|
935
1069
|
|
|
936
1070
|
## Referência
|
|
937
1071
|
|