Skip to main content
POST
Criar e Disparar Campanha

Criar e Disparar Campanha

Crie e dispare uma nova campanha de mensagens via WhatsApp usando este endpoint.

Requisição

Headers

Parâmetros

Exemplo de Requisição

Resposta

Sucesso

Erro

Códigos de Status

  • 200: Sucesso
  • 400: Erro de validação ou dados inválidos
  • 401: Não autorizado (token inválido ou ausente)
  • 403: Proibido (sem permissão)
  • 404: Agente não encontrado
  • 500: Erro interno do servidor

Observações Importantes

  1. Provedor de WhatsApp
    • Se o preferredProvider especificado não estiver disponível, será usado o primeiro provedor conectado ao agente
    • O provedor deve estar ativo e configurado corretamente no agente
  2. Números de Telefone
    • Os números devem estar no formato internacional (ex: +5511999999999)
    • Se useAgentContacts for true, os contatos do agente serão incluídos no disparo
    • Números duplicados serão automaticamente removidos
  3. Disparo Automático
    • Se autoDispatch for false, a campanha será criada com status “DRAFT”
    • Se autoDispatch for true, a campanha será iniciada imediatamente
    • O disparo é feito de forma assíncrona com delay entre as mensagens
  4. Limitações
    • O sistema possui limites de taxa para evitar bloqueios
    • As mensagens são enviadas com delay para evitar bloqueios do WhatsApp
    • Em caso de falha, o sistema fará até 3 tentativas de envio

Exemplos de Uso

  1. Criar campanha sem disparar
  1. Disparar para números específicos
  1. Usar provedor específico

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agentId
string
required

ID do agente que fará o disparo

message
string
required

Conteúdo da mensagem a ser enviada

autoDispatch
boolean
required

Define se a campanha será disparada automaticamente ou apenas criada

name
string

Nome da campanha. Se não informado, será usado um nome padrão

useAgentContacts
boolean
default:false

Define se deve usar os contatos do agente. Padrão: false

manualPhoneNumbers
string[]

Array de números de telefone para disparo manual

preferredProvider
enum<string>

Provedor preferido para o disparo

Available options:
official,
evolution,
evolution-qr,
z-api

Response

Sucesso

id
string

ID único da campanha

name
string

Nome da campanha

status
enum<string>

Status atual da campanha

Available options:
DRAFT,
IN_PROGRESS,
COMPLETED,
FAILED
message
string

Conteúdo da mensagem

startedAt
string<date-time>

Data e hora de início da campanha

usedPhoneNumbers
string[]

Números de telefone utilizados na campanha

manualPhoneNumbers
string[]

Números de telefone fornecidos manualmente

agentId
string

ID do agente responsável pela campanha