Obiekt kampanii

Unikalny identyfikator kampanii.

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

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.

Stan kampanii. Nowe kampanie są tworzone w stanie Draft. Użyj endpointu Zmiana stanu kampanii, aby aktywować, wstrzymać lub anulować kampanię. Kampanie przechodzą do stanu Finished automatycznie.

Tylko dla kampanii Active, w pozostałych przypadkach null: informuje, czy kampania wykonuje połączenia (Running), lub podaje powód, dla którego ich nie wykonuje.

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

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

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

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

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

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.

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

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

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ę.

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.

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

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

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 +.

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.

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

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.

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

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.

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

Liczba numerów w kampanii.

Liczba numerów w każdym statusie.

Nazwy zmiennych, których wartości są przechowywane dla każdego numeru, lub null, jeśli kampania nie ma jeszcze numerów. Są definiowane przez pierwsze numery dodane do kampanii.

Czy kampania jest zarchiwizowana. Zarchiwizowane kampanie są domyślnie ukryte w konsoli webowej.

Interakcje kampanii, których wyniki są raportowane dla każdego połączenia, takie jak wejścia DTMF przepływów połączeń lub cele agenta AI. Służą do interpretacji pola inputResults w szczegółach połączeń.

Data i godzina utworzenia kampanii.

Data i godzina ostatniej zmiany. Wyślij tę wartość jako lastUpdatedAt podczas aktualizacji kampanii.

Zawsze null, z wyjątkiem odpowiedzi endpointu Usuwanie kampanii, w której zawiera datę i godzinę usunięcia kampanii.

Data i godzina, w której kampania zaczęła wykonywać połączenia, lub null.

Data i godzina anulowania lub zakończenia kampanii, lub null.