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

WhatsApp: campanhas

Mensagens em massa por WhatsApp: público, campanhas, envio e templates da Meta.

Campanhas são mensagens em massa por WhatsApp: a loja escolhe um template aprovado pela Meta, define o público e a plataforma envia a todos, respeitando consentimento e pedidos de descadastro. Esta seção cobre as campanhas e os templates que elas usam.

Pontos-chave
  • Exige o módulo whatsapp-commerce e o privilégio manage_settings.
  • Toda campanha usa um template aprovado; a mesma variável vale para todos (sem personalização por pessoa).
  • Quem respondeu PARAR nunca recebe. Se a loja exige consentimento de marketing, quem não consentiu também fica de fora.
  • Campanha e template guardam o estado como letra (R, P, A, D...).
  • Enviar uma campanha dispara mensagens reais e cobradas pela Meta.

Como funciona

Rascunho→Enviando→Concluída

Uma campanha pode ainda ser Cancelada enquanto não termina.

statusSignificado
RRascunho: criada, ainda não enviada.
PEnviando (ou na fila de envio).
AConcluída: todos os destinatários chegaram a um estado final.
DCancelada.
  1. Ter um template aprovado

    Crie em Templates gerenciados (ou na Meta) e espere o status A. Sincronize para atualizar.

  2. Pré-visualizar o público

    POST /broadcasts/preview mostra quantos casam e quantos receberão.

  3. Criar a campanha

    POST /broadcasts grava o rascunho com os destinatários já resolvidos.

  4. Enviar e acompanhar

    POST /broadcasts/{id}/send, depois GET /broadcasts/{id} para ver os contadores subirem.

Conceitos-chave

Template e janela de 24 horas

O WhatsApp só permite texto livre até 24 horas após a última mensagem do cliente. Campanhas, por definição, falam com quem não escreveu agora, então usam templates.

Categorias e custo

UTILITY (avisos de pedido), MARKETING (promoções, mais caro) e AUTHENTICATION (códigos). A Meta pode reclassificar um template; a categoria final fica no registro.

Público

Cinco formas de escolher: todos os clientes ativos com telefone, um grupo de usuários, uma lista de ids de clientes, uma lista de telefones ou filtros (grupo por nome, comprou nos últimos N dias, mínimo de pedidos).

Consentimento e descadastro

Duas barreiras. PARAR (descadastro) vale sempre. O consentimento de marketing (whatsapp_opt_in) só é exigido se a loja ativou essa regra. Os dois cortes entram em skipped_count. A regra de consentimento é reaplicada no momento do envio.

Variáveis do template

As variáveis são numeradas e, na campanha, iguais para todos: {"1":"30%","2":"30/11"}.

Endpoints

MétodoCaminhoPara que servePágina
POST/api/v1/admin/whatsapp/broadcasts/previewConta quantas pessoas o público alcança e quantas receberãoCriar campanha
POST/api/v1/admin/whatsapp/broadcastsCria uma campanha como rascunho, ou já a coloca em envioCriar campanha
GET/api/v1/admin/whatsapp/broadcastsLista as campanhas, as mais novas primeiroGerenciar campanhas
GET/api/v1/admin/whatsapp/broadcasts/{id}Devolve a campanha com a contagem de destinatários por situaçãoGerenciar campanhas
POST/api/v1/admin/whatsapp/broadcasts/{id}/sendColoca a campanha em envioGerenciar campanhas
POST/api/v1/admin/whatsapp/broadcasts/{id}/cancelCancela uma campanha que ainda não terminouGerenciar campanhas
GET/api/v1/admin/whatsapp/templatesLista os templates da conta WhatsApp Business da lojaTemplates da Meta
GET/api/v1/admin/whatsapp/templates/modelsLista modelos prontos de template e as variáveis disponíveisTemplates da Meta
GET/api/v1/admin/whatsapp/templates/managedLista os templates gerenciadosTemplates gerenciados
POST/api/v1/admin/whatsapp/templates/managedCria um template na Meta e o registra na lojaTemplates gerenciados
PUT/api/v1/admin/whatsapp/templates/managed/{id}Altera as configurações de um template gerenciadoTemplates gerenciados
DELETE/api/v1/admin/whatsapp/templates/managed/{id}Exclui o template na Meta e na lojaTemplates gerenciados
POST/api/v1/admin/whatsapp/templates/managed/syncAtualiza status e estrutura dos templates a partir da MetaTemplates gerenciados

Erros comuns

  • Filtrar a lista por status=draft: o filtro compara a letra (R). O resultado vem vazio sem erro.
  • Usar um template ainda pendente: a Meta recusa as mensagens. Espere A e sincronize.
  • Combinar send_immediately com scheduled_at: 400. E lembrar que scheduled_at só tem efeito depois do envio.
  • Esperar personalização por destinatário: as variáveis são fixas para todos.
  • Testar com all_customers: use phone_list com o seu número primeiro.
  • Ler a entrega em recipient_counts: use delivered_count e read_count da campanha.

Próximos passos

Criar campanha
Público, template e envio.
Templates gerenciados
Criar e acompanhar aprovação.
Mensagens enviadas
Histórico e reenvio.
Anterior
Ligações
Próxima
Criar e pré-visualizar campanha
Nesta página
  • Como funciona
  • Conceitos-chave
  • Template e janela de 24 horas
  • Categorias e custo
  • Público
  • Consentimento e descadastro
  • Variáveis do template
  • Endpoints
  • Erros comuns
  • Próximos passos