Cria uma nova campanha de disparo de mensagens via WhatsApp. Suporta texto, mídia (imagem, vídeo, áudio, documento), enquetes e agendamento.
Você precisa de um access token válido no header X-Access-Token para usar este endpoint.
Filtro Automático de Contatos Bloqueados: Os contatos que estão na lista de bloqueados serão automaticamente removidos da campanha antes do envio. O campo
blockedContactsRemoved
no response indica quantos contatos foram filtrados.Headers
application/json
Token de acesso obtido no login
Body
Informações Básicas
Nome da campanha (obrigatório)
Se true, marca a campanha como teste
Se true, salva a campanha como rascunho sem enviar
Configuração Evolution API
URL completa da sua Evolution API (ex: https://evolution-api.exemplo.com)
API Key da sua Evolution API
Nome da instância do WhatsApp conectada
ID de uma configuração Evolution salva (alternativa aos campos acima)
Contatos
Lista de contatos que receberão a mensagem
Conteúdo da Mensagem
Conteúdo da mensagem. Obrigatório exceto quando usando enquetes ou salvando como rascunho.Suporta variáveis:
{PrimeiroNome}
- Primeiro nome do contato{NomeCompleto}
- Nome completo do contato
Mídia (Opcional)
URL do arquivo de mídia ou dados em base64URL: https://exemplo.com/imagem.jpgBase64: data:image/jpeg;base64,/9j/4AAQSkZJRg…
Tipo de mídia. Se não fornecido, será detectado automaticamente.
image
: JPG, PNG, GIFvideo
: MP4, 3GPaudio
: MP3, OGG, AACdocument
: PDF, DOC, XLS, etc
Nome do arquivo (recomendado para base64 e documentos)
Legenda para imagens e vídeos (máximo 1024 caracteres)
Enquete (Opcional)
Dados da enquete. Quando fornecido, substitui a necessidade de
message
.Agendamento (Opcional)
Data e hora para agendamento no formato: YYYY-MM-DDTHH:mmExemplos:
2024-12-25T10:00
(formato aceito)2024-12-25T10:00:00
(também aceito)
Configurações de Envio
Intervalo mínimo entre mensagens em segundos
Intervalo máximo entre mensagens em segundos
Número para receber notificação quando a campanha for concluída
Configurações Avançadas
ID da configuração de banco de dados para variáveis personalizadas
JavaScript
Python
PHP
Response
Campos Principais
ID único da campanha criada
Nome da campanha
Descrição da campanha
Status atual da campanha
DRAFT
- RascunhoSCHEDULED
- AgendadaACTIVE
- Em execuçãoPAUSED
- PausadaCOMPLETED
- ConcluídaCANCELLED
- CanceladaFAILED
- Falhou
Tipo da campanha (TEXT, MEDIA, POLL)
Data/hora de criação
Data/hora de agendamento (se aplicável)
Estatísticas
Total de contatos na campanha
Quantidade de mensagens já enviadas
Quantidade de envios que falharam
Quantidade de contatos pendentes
Percentual de progresso (0-100)
Taxa de sucesso em percentual
Dados da Campanha
Conteúdo da mensagem da campanha
Tipo de mídia anexada (se houver)
URL da mídia anexada
Nome do arquivo de mídia
Instância Evolution usada
Intervalo mínimo entre mensagens
Intervalo máximo entre mensagens
Telefone para notificação
Dados da enquete (quando aplicável)
Configuração Evolution completa usada
Mensagem de erro (apenas em caso de falha)
Validações
- Nome: Obrigatório
- Mensagem: Obrigatória (exceto para enquetes ou rascunhos)
- Contatos: Pelo menos 1 contato válido
- Enquete: 2-10 opções únicas, máximo 100 caracteres cada
- Agendamento: Mínimo 5 minutos no futuro
- Evolution API: Credenciais válidas e instância conectada
Limites
- Contatos por campanha: Sem limite definido (recomendado até 10.000)
- Tamanho da mensagem: 4096 caracteres
- Tamanho da legenda: 1024 caracteres
- Nome da enquete: 280 caracteres
- Opções de enquete: 2-10 opções, máximo 100 caracteres cada
- Arquivo de mídia: Depende dos limites do WhatsApp
Variáveis de Personalização
Você pode usar as seguintes variáveis nas mensagens:{PrimeiroNome}
- Primeiro nome do contato{NomeCompleto}
- Nome completo do contato
Suporta variáveis de personalização:
Webhooks
A campanha enviará notificações via webhook nos seguintes eventos:- campaign.started - Quando a campanha iniciar
- campaign.progress - A cada 10% de progresso
- campaign.completed - Quando finalizar
- campaign.failed - Se falhar