VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: resultados

Campanhas

Lista as campanhas de mensagens em massa da loja e o desempenho e custo estimado das principais.

Uma campanha envia um template aprovado a uma lista de clientes (a audiência). Cada envio passa por estados e é contado como entregue, lido, clicado ou falho. O seller consulta as campanhas e o resultado delas; criar, agendar e cancelar campanhas é feito pelo administrador.

Listar campanhas

GET/api/v1/vendor/whatsapp-confluence/campaignsSeller

Lista as campanhas da loja

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Exemplo de requisição

Resposta

200Campanhas

Campos da resposta

campaignsarray

Campanhas da loja.

iduuid
Id da campanha.
namestring
Nome interno.
template_namestring
Template enviado.
template_languagestring
Idioma do template.
params_templateobject
Variáveis do template (valores fixos ou {{nome}}, trocado por destinatário). Omitido se não há.
cta_kindstring
NKSC
Chamada para ação: N nenhuma, K abre o carrinho na mini-loja, S abre a mini-loja, C abre o catálogo nativo.
audience_filterobject
Filtro que define a audiência. Omitido se não há.
scheduled_atstring
Quando a campanha foi agendada (RFC 3339). Omitido se não agendada.
statusstring
DQRCXE
D rascunho, Q na fila, R em envio, C concluída, X cancelada, E com erro.
totalinteger
Destinatários da audiência.
sentinteger
Enviadas.
deliveredinteger
Entregues.
readinteger
Lidas.
failedinteger
Falhas.
clickedinteger
Cliques no botão.
created_atstring
Criação (RFC 3339).

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não é um seller, ou o seller ainda está em análise de cadastro.{"error":"vendor_pending_review"}
500Falha interna ao calcular.{"error":"..."}
Campanhas são da loja

A lista não é filtrada por seller. Uma campanha em andamento pode ser pausada automaticamente (volta para Q) quando o orçamento com teto rígido se esgota; veja Orçamento.

Desempenho das campanhas

GET/api/v1/vendor/whatsapp-confluence/analytics/campaignsSeller

As 20 campanhas com mais envios e o custo estimado

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso de um usuário seller (lojista). Veja Tokens.

Exemplo de requisição

Resposta

200Desempenho

Campos da resposta

campaignsarray

Até 20 campanhas, as com mais enviadas primeiro.

iduuid
Id da campanha.
namestring
Nome.
template_namestring
Template.
template_categorystring
Categoria do template na Meta. UTILITY quando desconhecida.
totalinteger
Destinatários.
sentinteger
Enviadas.
deliveredinteger
Entregues.
readinteger
Lidas.
failedinteger
Falhas.
estimated_cost_centsinteger
total vezes a tarifa atual da categoria, em centavos.

Erros

StatusQuandoCorpo de exemplo
401Sem token ou token inválido.{"error":"missing authorization header"}
403O usuário não é um seller, ou o seller ainda está em análise de cadastro.{"error":"vendor_pending_review"}
500Falha interna ao calcular.{"error":"..."}
O custo é uma estimativa

Usa a tarifa de hoje sobre total (destinatários), não sobre as mensagens realmente enviadas. Para o custo registrado, use Custos.

Veja também

  • Orçamento mensal
  • Funil de vendas
  • Visão geral da seção
Anterior
Uso e custos
Próxima
Orçamento mensal
Nesta página
  • Listar campanhas
  • Exemplo de requisição
  • Resposta
  • Erros
  • Desempenho das campanhas
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também
bash
curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/campaigns" \
  -H "Authorization: Bearer $TOKEN"
bash
curl "$BASE_URL/api/v1/vendor/whatsapp-confluence/analytics/campaigns" \
  -H "Authorization: Bearer $TOKEN"
json
{
  "campaigns": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "Ofertas de outubro",
      "template_name": "oferta_semana",
      "template_language": "pt_BR",
      "cta_kind": "S",
      "status": "C",
      "total": 480,
      "sent": 470,
      "delivered": 455,
      "read": 310,
      "failed": 10,
      "clicked": 96,
      "created_at": "2026-10-01T12:00:00Z"
    }
  ]
}
json
{
  "campaigns": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "Ofertas de outubro",
      "template_name": "oferta_semana",
      "template_category": "MARKETING",
      "total": 480,
      "sent": 470,
      "delivered": 455,
      "read": 310,
      "failed": 10,
      "estimated_cost_cents": 17280
    }
  ]
}