Skip to main content
POST
Criar campanha
Este endpoint permite que você crie 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 da assistente a ser usada para a campanha. Deve ser uma assistente capaz de realizar chamadas de saída.
string
Identificador de fuso horário para a campanha (por exemplo, America/New_York, Europe/London). Padrão é o fuso horário da sua conta.
integer
default:"3"
Número máximo de chamadas simultâneas. Mínimo: 1. O máximo depende do limite de chamadas paralelas do seu plano (até 10).
string
default:"00:00"
Início da janela de chamadas permitidas no formato H:i (por exemplo, 09:00).
string
default:"23:59"
Fim da janela de chamadas permitidas no formato H:i (por exemplo, 17:00).
array
default:"todos os 7 dias"
Array de nomes dos dias da semana em que 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 reexibição para chamadas falhadas. Intervalo: 1-5.
integer
default:"60"
Intervalo em minutos entre as tentativas de reexibição. Intervalo: 10-4320 (até 3 dias).
boolean
Se deve reexibir chamadas que foram para a caixa de correio de voz.
boolean
Se deve reexibir chamadas onde o objetivo não foi concluído.
string
Nome de uma variável booleana do esquema pós-chamada da sua assistente para rastrear a conclusão do objetivo. Máximo de 255 caracteres.
boolean
default:"true"
Se deve marcar automaticamente a campanha como completa quando não houver mais leads para chamar.
array
Array de IDs de números de telefone a serem usados para a campanha. Cada ID deve ser um inteiro distinto.

Resposta

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

Respostas de Erro