Ana içeriğe atla
POST
/
user
/
campaign
Kampanya oluştur
curl --request POST \
  --url https://api.example.com/user/campaign \
  --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"
  }
}
Bu endpoint, belirtilen yapılandırmayla yeni bir giden arama kampanyası oluşturmanızı sağlar.

İstek gövdesi

name
string
gerekli
Kampanyanın adı. Maksimum 255 karakter.
assistant_id
integer
gerekli
Kampanya için kullanılacak asistanın kimliği. Giden arama yapabilir bir asistan olmalıdır.
timezone
string
Kampanya için saat dilimi tanımlayıcısı (ör. America/New_York, Europe/London). Varsayılan olarak hesap saat diliminiz kullanılır.
max_calls_in_parallel
integer
varsayılan:"3"
Maksimum eşzamanlı arama sayısı. Minimum: 1. Maksimum planınızın paralel arama limitine bağlıdır (10’a kadar).
allowed_hours_start_time
string
varsayılan:"00:00"
İzin verilen arama penceresinin başlangıcı, H:i formatında (ör. 09:00).
allowed_hours_end_time
string
varsayılan:"23:59"
İzin verilen arama penceresinin sonu, H:i formatında (ör. 17:00).
allowed_days
array
varsayılan:"all 7 days"
Aramalara izin verilen hafta içi gün adlarının dizisi. Geçerli değerler: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
max_retries
integer
varsayılan:"3"
Başarısız aramalar için maksimum yeniden deneme sayısı. Aralık: 1-5.
retry_interval
integer
varsayılan:"60"
Yeniden denemeler arasındaki dakika cinsinden süre. Aralık: 10-4320 (3 güne kadar).
retry_on_voicemail
boolean
Sesli mesaja ulaşan aramaları yeniden deneyip denemeyeceği.
retry_on_goal_incomplete
boolean
Hedefin tamamlanmadığı aramaları yeniden deneyip denemeyeceği.
goal_completion_variable
string
Hedef tamamlanmasını izlemek için asistanınızın arama sonrası şemasındaki bir boolean değişkenin adı. Maksimum 255 karakter.
mark_complete_when_no_leads
boolean
varsayılan:"true"
Aranacak müşteri kalmadığında kampanyayı otomatik olarak tamamlandı işaretleyip işaretlemeyeceği.
phone_number_ids
array
Kampanya için kullanılacak telefon numarası kimliklerinin dizisi. Her kimlik benzersiz bir tam sayı olmalıdır.

Yanıt

message
string
Kampanyanın oluşturulduğunu onaylayan başarı mesajı
data
object
Oluşturulan kampanya verileri

Hata Yanıtları

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"
  }
}