Tworzenie kampanii

POST/v1/accounts/{accountId}/campaigns

Tworzy nową kampanię w stanie Draft. Po jej utworzeniu dodaj numery do kampanii i aktywuj ją, aby rozpocząć dzwonienie.

Wszystkie pola są walidowane podczas tworzenia kampanii i ponownie podczas jej aktywacji. Niektóre kontrole są wykonywane dopiero w momencie aktywacji, na przykład czy data zakończenia nie jest w przeszłości, czy moduł Queues Monitor jest online w przypadku kampanii Predictive i Progressive lub czy kampania Static ma numery.

Parametry ścieżki

accountIduuidWymagane

ID Twojego konta SIP Caller. Zobacz ID konta.

Treść żądania

Obiekt JSON z ustawieniami kampanii. Należy wysłać wszystkie pola, z wyjątkiem pól dopuszczających null, które po pominięciu przyjmują domyślnie wartość null.

namestringWymagane

Nazwa kampanii, od 2 do 99 znaków. Musi być unikalna w obrębie konta.

tagIdsarray of stringsWymagane

ID tagów kampanii. Tylko użytkownicy posiadający co najmniej jeden z tych tagów widzą kampanię w konsoli webowej. Wyślij pustą tablicę, aby nie przypisywać tagów.

runningPriorityenumWymagane

Priorytet kampanii, na podstawie którego SIP Caller decyduje, z której kampanii pobrać kolejne numery do wybrania, gdy kilka kampanii współdzieli zasoby.

Możliwe wartości:LowNormalHigh

phoneSystemIduuidWymagane

ID systemu telefonicznego używanego do wykonywania połączeń.

extensionIdstringWymagane

ID numeru wewnętrznego systemu telefonicznego używanego do wykonywania połączeń.

dialerobjectWymagane

Tryb dialera kampanii i jego ustawienia. Pole mode określa tryb, a pozostałe pola zależą od niego.

startDatedateWymagane

Pierwszy dzień, w którym kampania może wykonywać połączenia.

endDatedateDopuszcza null

Ostatni dzień, w którym kampania może wykonywać połączenia (włącznie z tym dniem), lub null, jeśli nie ma daty zakończenia. Nie może być wcześniejszy niż startDate.

holidayGroupIduuidDopuszcza null

ID grupy dni wolnych kampanii lub null. W dni wolne obowiązują godziny pracy zdefiniowane dla niedzieli.

timeZoneIdstringWymagane

Strefa czasowa IANA kampanii, na przykład America/New_York. Daty i godziny pracy odnoszą się do tej strefy czasowej.

workingTimesobjectWymagane

Przedziały czasowe, w których można wykonywać połączenia, dla każdego dnia tygodnia. Każdy dzień musi być obecny: dla dni bez połączeń wyślij pustą tablicę.

numberProvisioningenumWymagane

Czy numery można dodawać lub usuwać po aktywacji kampanii (Dynamic), czy nie (Static). Kampania statyczna kończy się automatycznie, gdy wszystkie jej numery zostaną przetworzone.

Możliwe wartości:StaticDynamic

numberSelectionenumWymagane

Kolejność wybierania numerów: pierwszy na wejściu, pierwszy na wyjściu (Fifo) lub ostatni na wejściu, pierwszy na wyjściu (Lifo).

Możliwe wartości:FifoLifo

numberPriorityenumWymagane

Czy numery, z którymi nie było jeszcze kontaktu, są wybierane przed ponownymi próbami (NotContacted), czy odwrotnie (RetryPending).

Możliwe wartości:NotContactedRetryPending

callPrefixstringWymagane

Prefiks dodawany do każdego numeru przed wybraniem, na przykład w celu wyboru linii wychodzącej, lub "", jeśli prefiks nie jest używany. Można podać do 256 prefiksów oddzielonych przecinkami, aby je rotować: każdy o długości do 6 znaków, spośród cyfr, *, # i +.

ringTimeoutobjectWymagane

Czas oczekiwania na odebranie połączenia: od 1 do 600 sekund lub od 1 do 10 minut. W trybie Progressive dotyczy połączenia z agentem.

maxAttemptsintegerWymagane

Maksymalna liczba wybrań każdego numeru, od 1 do 9.

retryIntervalsarray of objectsWymagane

Minimalny odstęp czasu między próbami, maksymalnie 6 miesięcy. Można zdefiniować od 1 do 8 odstępów, aby stosować różne czasy oczekiwania dla kolejnych prób.

blackListIdsarray of uuidsWymagane

ID czarnych list z numerami, do których nie wolno dzwonić. Wyślij pustą tablicę, jeśli nie są używane.

callHandlingobjectDopuszcza null

Co się dzieje po odebraniu połączenia. Pole $t określa tryb obsługi połączeń, a pozostałe pola zależą od niego. Wymagane dla trybów dialera Power i Predictive; dla trybu Progressive musi mieć wartość null, ponieważ połączenie jest zawsze łączone z agentem.

webhookEndpointIduuidDopuszcza null

ID webhooka, który otrzymuje zdarzenia kampanii, lub null.

Zwraca

Zwraca nowy obiekt kampanii ze statusem 201 Created. Nagłówek Location zawiera URL nowej kampanii.

POST

/v1/accounts/ACCOUNT_ID/campaigns

curl -X POST 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns' \
  -H 'Authorization: Bearer API_KEY_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Q4 Renewals",
  "tagIds": [],
  "runningPriority": "Normal",
  "phoneSystemId": "0199817e-52e0-7079-9585-99a655c2acb3",
  "extensionId": "93e5cdfc-6e42-4995-8263-9388a9047c29",
  "dialer": {
    "mode": "Predictive",
    "intensity": 0
  },
  "startDate": "2026-10-01",
  "endDate": null,
  "holidayGroupId": null,
  "timeZoneId": "America/New_York",
  "workingTimes": {
    "monday": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "14:00",
        "end": "18:00"
      }
    ],
    "tuesday": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "14:00",
        "end": "18:00"
      }
    ],
    "wednesday": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "14:00",
        "end": "18:00"
      }
    ],
    "thursday": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "14:00",
        "end": "18:00"
      }
    ],
    "friday": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "14:00",
        "end": "18:00"
      }
    ],
    "saturday": [],
    "sunday": []
  },
  "numberProvisioning": "Dynamic",
  "numberSelection": "Fifo",
  "numberPriority": "RetryPending",
  "callPrefix": "",
  "ringTimeout": {
    "value": 30,
    "unit": "Seconds"
  },
  "maxAttempts": 3,
  "retryIntervals": [
    {
      "value": 1,
      "unit": "Hours"
    },
    {
      "value": 1,
      "unit": "Days"
    }
  ],
  "blackListIds": [
    "01a0dedd-b9a2-729d-8e0a-4e3ad9197aea"
  ],
  "callHandling": {
    "$t": "Callflow",
    "answerTypeDetector": {
      "$t": "AmdAgent",
      "amdAgentId": "019f9cef-4a91-7c97-b7cd-edbb06a5038d",
      "unknownAnswerTreatment": "Human",
      "messageForVoicemail": {
        "$t": "OnFirstDetection",
        "callflowId": "019f81ba-a149-731a-a6cb-b47146c5f90d",
        "isCallRetryEnabled": true
      }
    },
    "callflowId": "019f9cd5-e8cd-716b-a9a6-37c9db2f97a2",
    "ttsVoiceId": "azu-en-US-AvaMultilingualNeural"
  },
  "webhookEndpointId": "019af0c3-62d6-70f2-84a1-5ab5671721bb"
}'

Odpowiedź

201 Created

{
  "id": "01a0e2b4-5c1d-7f3a-9b2e-6d8c4a1f0e27",
  "name": "Q4 Renewals",
  "tagIds": [],
  "state": "Draft",
  "activeStatus": null,
  "runningPriority": "Normal",
  "phoneSystemId": "0199817e-52e0-7079-9585-99a655c2acb3",
  "extensionId": "93e5cdfc-6e42-4995-8263-9388a9047c29",
  "dialer": {
    "mode": "Predictive",
    "intensity": 0
  },
  "startDate": "2026-10-01",
  "endDate": null,
  "holidayGroupId": null,
  "timeZoneId": "America/New_York",
  "workingTimes": {
    "monday": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "14:00",
        "end": "18:00"
      }
    ],
    "tuesday": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "14:00",
        "end": "18:00"
      }
    ],
    "wednesday": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "14:00",
        "end": "18:00"
      }
    ],
    "thursday": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "14:00",
        "end": "18:00"
      }
    ],
    "friday": [
      {
        "start": "09:00",
        "end": "13:00"
      },
      {
        "start": "14:00",
        "end": "18:00"
      }
    ],
    "saturday": [],
    "sunday": []
  },
  "numberProvisioning": "Dynamic",
  "numberSelection": "Fifo",
  "numberPriority": "RetryPending",
  "callPrefix": "",
  "ringTimeout": {
    "value": 30,
    "unit": "Seconds"
  },
  "maxAttempts": 3,
  "retryIntervals": [
    {
      "value": 1,
      "unit": "Hours"
    },
    {
      "value": 1,
      "unit": "Days"
    }
  ],
  "blackListIds": [
    "01a0dedd-b9a2-729d-8e0a-4e3ad9197aea"
  ],
  "callHandling": {
    "$t": "Callflow",
    "answerTypeDetector": {
      "$t": "AmdAgent",
      "amdAgentId": "019f9cef-4a91-7c97-b7cd-edbb06a5038d",
      "unknownAnswerTreatment": "Human",
      "messageForVoicemail": {
        "$t": "OnFirstDetection",
        "callflowId": "019f81ba-a149-731a-a6cb-b47146c5f90d",
        "isCallRetryEnabled": true
      }
    },
    "callflowId": "019f9cd5-e8cd-716b-a9a6-37c9db2f97a2",
    "ttsVoiceId": "azu-en-US-AvaMultilingualNeural"
  },
  "webhookEndpointId": "019af0c3-62d6-70f2-84a1-5ab5671721bb",
  "numbersCount": 0,
  "progress": {
    "notContacted": 0,
    "contacting": 0,
    "success": 0,
    "failure": 0,
    "retryPending": 0,
    "blacklisted": 0,
    "deleted": 0
  },
  "varNames": null,
  "isArchived": false,
  "interactionLabels": [
    {
      "id": "a6d5b2e5-6b3f-49d8-aaa3-bc7b4c693f05",
      "label": "Renewal confirmation"
    }
  ],
  "createdAt": "2026-09-28T14:02:11.482",
  "updatedAt": "2026-09-28T14:02:11.482",
  "deletedAt": null,
  "startedAt": null,
  "endedAt": null
}

Poprzednia

Pobieranie kampanii

Następna

Aktualizacja kampanii

Tworzenie kampanii

Parametry ścieżki

Treść żądania

Zwraca

Produkt

Rozwiązania

Firma

Pomoc i Dokumenty

Prawny