Skip to main content
POST
/
user
/
campaign
Създаване на кампания
curl --request POST \
  --url https://call.aiployees.com/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": "Campaign created successfully",
  "data": {
    "id": 1,
    "name": "Product Demo Campaign",
    "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"
  }
}
Този endpoint ви позволява да създадете нова кампания за изходящи обаждания с указаната конфигурация.

Request body

name
string
required
Името на кампанията. Максимум 255 символа.
assistant_id
integer
required
ID на асистента, който да се използва за кампанията. Трябва да бъде асистент, способен за изходящи обаждания.
timezone
string
Идентификатор на часовата зона за кампанията (напр. America/New_York, Europe/London). По подразбиране е часовата зона на вашия акаунт.
max_calls_in_parallel
integer
default:"3"
Максимален брой едновременни обаждания. Минимум: 1. Максимумът зависи от лимита за паралелни обаждания на вашия план (до 10).
allowed_hours_start_time
string
default:"00:00"
Начало на разрешения прозорец за обаждания в формат H:i (напр. 09:00).
allowed_hours_end_time
string
default:"23:59"
Край на разрешения прозорец за обаждания в формат H:i (напр. 17:00).
allowed_days
array
default:"всичките 7 дни"
Масив от имена на дни от седмицата, когато са разрешени обаждания. Валидни стойности: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
max_retries
integer
default:"3"
Максимален брой опити за повторение при неуспешни обаждания. Диапазон: 1-5.
retry_interval
integer
default:"60"
Интервал в минути между опитите за повторение. Диапазон: 10-4320 (до 3 дни).
retry_on_voicemail
boolean
Дали да се повтарят обаждания, които са достигнали гласова поща.
retry_on_goal_incomplete
boolean
Дали да се повтарят обаждания, при които целта не е постигната.
goal_completion_variable
string
Име на boolean променлива от post-call схемата на вашия асистент за проследяване постигането на целта. Максимум 255 символа.
mark_complete_when_no_leads
boolean
default:"true"
Дали автоматично да се маркира кампанията като завършена, когато няма повече оставащи потенциални клиенти за обаждане.
phone_number_ids
array
Масив от ID-та на телефонни номера за използване в кампанията. Всяко ID трябва да бъде отделно цяло число.

Response

message
string
Съобщение за успех, потвърждаващо, че кампанията е създадена
data
object
Данните на създадената кампания

Error Responses

403 Forbidden
404 Not Found
422 Validation Error
{
  "message": "Campaign created successfully",
  "data": {
    "id": 1,
    "name": "Product Demo Campaign",
    "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"
  }
}