O que é uma campanha?
É o disparo em lote para uma audiência usando um template multicanal. O painel e a API compartilham o mesmo fluxo de fila, créditos e status. Analogia: template é o texto do correio. Segmento é a lista de endereços. Campanha é carimbar e soltar na caixa.Campanha × segmento × envio direto
Quando usar?
Funciona muito bem para newsletter, promoção para público filtrado e teste com poucos IDs antes da base inteira. Para um aviso único por script, use envio direto na API do canal ou template.Canais na campanha
channels aceita: whatsapp, sms, email, telegram.
Cada canal listado precisa estar habilitado no template. Templates podem ter RCS, Push ou Voz, campanha usa só o subconjunto dos quatro acima.
Sem telefone, e-mail ou peer, o contato é ignorado naquele canal (sem erro por pessoa).
Marketing: contato precisa
receiveMarketing e inscrição no tópico do template (quando vinculado). Quem não passa não entra na fila.Como funciona na prática
- Template com canais ativos e texto preenchido
- New campaign, nome, template, canais desta execução, audiência (segmento ou IDs)
- Roteamento: WhatsApp, Telegram, e-mail conforme tabela acima
- Opcional: agendar (
scheduledFor, mín. ~2 min à frente) → SCHEDULED - Preview do segmento (se usar segmento)
- Run ou disparo no horário → RUNNING → COMPLETED ou FAILED
Status
Variáveis globais (opcional)
JSON mesclado por cima dos dados do contato, cupom igual para todos:Na API
O Run devolve
sent e runId. Links curtos recebem utm_campaign e utm_content automaticamente.
Checklist antes do Run
- Canais da campanha ativos no template?
- Preview do segmento faz sentido?
- Telegram: peers na instância certa?
- Testou com poucos IDs?
- Créditos, instâncias e remetente de e-mail OK?
CAMPAIGN_CHANNEL_NOT_IN_TEMPLATE, CAMPAIGN_AUDIENCE_TOO_LARGE, CAMPAIGN_WHATSAPP_INSTANCE_REQUIRED. Veja Respostas de erro.