Skip to main content
POST
/
user
/
campaign
Criar campanha
curl --request POST \
  --url https://suasofia.online/api/user/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "assistant_id": 123,
  "timezone": "<string>",
  "max_calls_in_parallel": 123,
  "allowed_hours_start_time": "<string>",
  "allowed_hours_end_time": "<string>",
  "allowed_days": [
    {}
  ],
  "max_retries": 123,
  "retry_interval": 123,
  "retry_on_voicemail": true,
  "retry_on_goal_incomplete": true,
  "goal_completion_variable": "<string>",
  "mark_complete_when_no_leads": true,
  "phone_number_ids": [
    {}
  ]
}
'
{
  "message": "Campanha criada com sucesso",
  "data": {
    "id": 1,
    "name": "Campanha de Demo do Produto",
    "status": "draft",
    "max_calls_in_parallel": 3,
    "mark_complete_when_no_leads": true,
    "allowed_hours_start_time": "09:00:00",
    "allowed_hours_end_time": "17:00:00",
    "allowed_days": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday"
    ],
    "max_retries": 3,
    "retry_interval": 60,
    "created_at": "2026-02-23T10:00:00.000000Z",
    "updated_at": "2026-02-23T10:00:00.000000Z"
  }
}
Este endpoint permite criar uma nova campanha de chamadas de saída com a configuração especificada.

​
Corpo da Requisição

​
name
string
required
O nome da campanha. Máximo de 255 caracteres.
​
assistant_id
integer
required
O ID do assistente a ser usado para a campanha. Deve ser um assistente capaz de fazer chamadas de saída.
​
timezone
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.
​
max_calls_in_parallel
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).
​
allowed_hours_start_time
string
default:"00:00"
Início da janela de horário permitido para chamadas no formato H:i (ex.: 09:00).
​
allowed_hours_end_time
string
default:"23:59"
Fim da janela de horário permitido para chamadas no formato H:i (ex.: 17:00).
​
allowed_days
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.
​
max_retries
integer
default:"3"
Número máximo de tentativas de reenvio para chamadas falhadas. Faixa: 1-5.
​
retry_interval
integer
default:"60"
Intervalo em minutos entre tentativas de reenvio. Faixa: 10-4320 (até 3 dias).
​
retry_on_voicemail
boolean
Se deve tentar novamente chamadas que alcançaram a caixa postal.
​
retry_on_goal_incomplete
boolean
Se deve tentar novamente chamadas onde o objetivo não foi completado.
​
goal_completion_variable
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.
​
mark_complete_when_no_leads
boolean
default:"true"
Se deve marcar automaticamente a campanha como concluída quando não há mais leads para ligar.
​
phone_number_ids
array
Array de IDs de números de telefone para usar na campanha. Cada ID deve ser um número inteiro distinto.

​
Resposta

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

​
Respostas de Erro

​
403 Forbidden
​
404 Not Found
​
422 Validation Error
{
  "message": "Campanha criada com sucesso",
  "data": {
    "id": 1,
    "name": "Campanha de Demo do Produto",
    "status": "draft",
    "max_calls_in_parallel": 3,
    "mark_complete_when_no_leads": true,
    "allowed_hours_start_time": "09:00:00",
    "allowed_hours_end_time": "17:00:00",
    "allowed_days": [
      "monday",
      "tuesday",
      "wednesday",
      "thursday",
      "friday"
    ],
    "max_retries": 3,
    "retry_interval": 60,
    "created_at": "2026-02-23T10:00:00.000000Z",
    "updated_at": "2026-02-23T10:00:00.000000Z"
  }
}