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

CampoTipoDescrição
event_idstring (uuid)Identificador único do evento (UUID v4).
campaignsarrayLista de campanhas com suas estatísticas.

Objeto campaigns

CampoTipoDescrição
campaign_idintegerID da campanha.
campaign_namestringNome da campanha.
statusstringStatus atual da campanha.
count_totalintegerTotal de mensagens na campanha.
count_already_sentintegerMensagens já enviadas anteriormente.
count_blockedintegerMensagens bloqueadas.
count_blocklist_responseintegerMensagens com resposta de blocklist.
count_does_not_existintegerNúmeros que não existem no WhatsApp.
count_duplicatedintegerMensagens duplicadas.
count_invalid_phoneintegerNúmeros de telefone inválidos.
count_processedintegerMensagens processadas.
count_sentintegerMensagens enviadas.
count_failedintegerMensagens que falharam.
count_deliveredintegerMensagens entregues no dispositivo.
count_readintegerMensagens lidas.
count_repliedintegerMensagens que receberam resposta.
count_expiredintegerMensagens expiradas.
count_remainingintegerMensagens restantes.
created_atstring (date-time)Data de criação da campanha (ISO 8601 UTC-3).
datetimestring (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"
    }
  ]
}

Webhook de Estatísticas de Campanha

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

CampoTipoDescrição
event_idstring (uuid)Identificador único do evento (UUID v4).
campaignsarrayLista de campanhas com suas estatísticas.

Objeto campaigns

CampoTipoDescrição
campaign_idintegerID da campanha.
campaign_namestringNome da campanha.
statusstringStatus atual da campanha.
count_totalintegerTotal de mensagens na campanha.
count_already_sentintegerMensagens já enviadas anteriormente.
count_blockedintegerMensagens bloqueadas.
count_blocklist_responseintegerMensagens com resposta de blocklist.
count_does_not_existintegerNúmeros que não existem no WhatsApp.
count_duplicatedintegerMensagens duplicadas.
count_invalid_phoneintegerNúmeros de telefone inválidos.
count_processedintegerMensagens processadas.
count_sentintegerMensagens enviadas.
count_failedintegerMensagens que falharam.
count_deliveredintegerMensagens entregues no dispositivo.
count_readintegerMensagens lidas.
count_repliedintegerMensagens que receberam resposta.
count_expiredintegerMensagens expiradas.
count_remainingintegerMensagens restantes.
created_atstring (date-time)Data de criação da campanha (ISO 8601 UTC-3).
datetimestring (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"
    }
  ]
}