Jump to Content

Estatisticas

Webhook de Estatísticas de Campanha

Configuração: POST /whatsapp/config/ com o campo url_campaign_webhook

Este webhook envia estatísticas atualizadas de campanhas de WhatsApp em lote. As estatísticas são enviadas periodicamente contendo dados consolidados de todas as campanhas que tiveram atualizações recentes.

Payload

Campo	Tipo	Descrição
`event_id`	string (uuid)	Identificador único do evento (UUID v4).
`campaigns`	array	Lista de campanhas com suas estatísticas.

Objeto `campaigns`

Campo	Tipo	Descrição
`campaign_id`	integer	ID da campanha.
`campaign_name`	string	Nome da campanha.
`status`	string	Status atual da campanha.
`count_total`	integer	Total de mensagens na campanha.
`count_already_sent`	integer	Mensagens já enviadas anteriormente.
`count_blocked`	integer	Mensagens bloqueadas.
`count_blocklist_response`	integer	Mensagens com resposta de blocklist.
`count_does_not_exist`	integer	Números que não existem no WhatsApp.
`count_duplicated`	integer	Mensagens duplicadas.
`count_invalid_phone`	integer	Números de telefone inválidos.
`count_processed`	integer	Mensagens processadas.
`count_sent`	integer	Mensagens enviadas.
`count_failed`	integer	Mensagens que falharam.
`count_delivered`	integer	Mensagens entregues no dispositivo.
`count_read`	integer	Mensagens lidas.
`count_replied`	integer	Mensagens que receberam resposta.
`count_expired`	integer	Mensagens expiradas.
`count_remaining`	integer	Mensagens restantes.
`created_at`	string (date-time)	Data de criação da campanha (ISO 8601 UTC-3).
`datetime`	string (date-time)	Data da atualização das estatísticas.

Exemplo

{
  "event_id": "i40g1h20-rf1o-f4q7-n049-hh9988hh3333",
  "campaigns": [
    {
      "campaign_id": 20261,
      "campaign_name": "teste 03",
      "status": "RUNNING",
      "count_total": 1,
      "count_already_sent": 0,
      "count_blocked": 0,
      "count_blocklist_response": 1,
      "count_does_not_exist": 0,
      "count_duplicated": 0,
      "count_invalid_phone": 0,
      "count_processed": 1,
      "count_sent": 1,
      "count_failed": 0,
      "count_delivered": 0,
      "count_read": 0,
      "count_replied": 1,
      "count_expired": 0,
      "count_remaining": 0,
      "created_at": "2025-09-09T18:30:00.000-03:00",
      "datetime": "2025-09-09T21:36:00.603-03:00"
    }
  ]
}