Skip to main content
POST
Criar campanha
Este endpoint permite criar uma nova campanha de chamadas de saída com a configuração especificada.

Corpo da Requisição

string
required
O nome da campanha. Máximo de 255 caracteres.
integer
required
O ID do assistente a ser usado para a campanha. Deve ser um assistente capaz de fazer chamadas de saída.
string
Identificador de fuso horário para a campanha (ex.: America/Sao_Paulo, Europe/London). Padrão para o fuso horário da sua conta.
integer
default:"3"
Número máximo de chamadas simultâneas. Mínimo: 1. Máximo depende do limite de chamadas paralelas do seu plano (até 10).
string
default:"00:00"
Início da janela de horário permitido para chamadas no formato H:i (ex.: 09:00).
string
default:"23:59"
Fim da janela de horário permitido para chamadas no formato H:i (ex.: 17:00).
array
default:"todos os 7 dias"
Array de nomes dos dias da semana quando as chamadas são permitidas. Valores válidos: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
integer
default:"3"
Número máximo de tentativas de reenvio para chamadas falhadas. Faixa: 1-5.
integer
default:"60"
Intervalo em minutos entre tentativas de reenvio. Faixa: 10-4320 (até 3 dias).
boolean
Se deve tentar novamente chamadas que alcançaram a caixa postal.
boolean
Se deve tentar novamente chamadas onde o objetivo não foi completado.
string
Nome de uma variável booleana do esquema pós-chamada do seu assistente para rastrear a conclusão do objetivo. Máximo de 255 caracteres.
boolean
default:"true"
Se deve marcar automaticamente a campanha como concluída quando não há mais leads para ligar.
array
Array de IDs de números de telefone para usar na campanha. Cada ID deve ser um número inteiro distinto.

Resposta

string
Mensagem de sucesso confirmando que a campanha foi criada
object
Os dados da campanha criada

Respostas de Erro