Agenci

HTTP	Zasób	Opis
GET	agents	Zwraca listę agentów.
GET	agents/:login	Zwraca informacje o agencie.
GET	agents/:login/last_queue_call	Zwraca ostatnią rozmowę z kolejki.
GET	agents/:login/status	Zwraca status agenta.
GET	agents_groups	Zwraca grupy agentów.
GET	agents_statuses	Zwraca statusy agentów.
GET	agents_work_report	Zwraca raport pracy agentów.
POST	agents	Dodanie agenta.
POST	agents/:login/answer	Odbiera telefon agenta jeśli korzysta on z Thulium Softphone.
POST	agents/:login/call	Zestawia połączenie dla agenta na podany numer.
POST	agents/:login/call_preview	Dzwoni w kampanii preview.
POST	agents/:login/free	Odpauzowuje agenta.
POST	agents/:login/hangup	Rozłącza połączenia agenta.
POST	agents/:login/hold	Pauzuje telefon agenta jeśli korzysta on z Thulium Softphone.
POST	agents/:login/login	Loguje agenta.
POST	agents/:login/logout	Wylogowuje agenta.
POST	agents/:login/mute	Wycisza telefon agenta jeśli korzysta on z Thulium Softphone.
POST	agents/:login/pause	Pauzuje agenta.
POST	agents/:login/stop_recording	Zatrzymuje nagrywanie bieżącej rozmowy agenta.
POST	agents/:login/transfer	Transferuje połaczenie agenta jeśli korzysta on z Thulium Softphone.
POST	agents/:login/unhold	Wyłacza pauze telefonu agenta jeśli korzysta on z Thulium Softphone.
POST	agents/:login/unmute	Wyłącza wyciszenie telefonu agenta jeśli korzysta on z Thulium Softphone.

Czaty

HTTP	Zasób	Opis
DELETE	chat_conversations/:id	Usuwanie konwersacji czatu.
DELETE	chat_conversations/content/:id/:participant	Usuwanie treści wiadomości danej konwersacji.
GET	chats	Zwraca listę czatów.
GET	chats/queues	Zwraca listę kolejek czatów.
GET	chats/reports/summary	Zwraca raport czatów.
POST	chat_conversations/:id/message	Wysyła wiadomość na czacie.
POST	chat_conversations/:id/stop	Zakańcza konwersację na czacie.
POST	chat_conversations/start	Rozpoczyna konwersację na czacie.

CRM

HTTP	Zasób	Opis
DELETE	companies/:id	Usuwanie firmy.
DELETE	customers/:id	Usuwanie klienta.
GET	companies	Zwraca listę firm zawężoną o podane kryteria wyszukiwania.
GET	companies/:id	Zwraca firmę o podanym identyfikatorze firmy.
GET	customer_id_by_outbound_status	Zwraca listę identyfikatorów klientów zawężoną o aktualny status rekordu w kampanii.
GET	customers	Zwraca listę klientów zawężonych o podane kryteria wyszukiwania.
GET	customers/:id	Zwraca klienta o podanym identyfikatorze klienta.
POST	companies	Dodanie firmy do CRM.
POST	customers	Dodanie klienta do CRM.
POST	customers/:id/feed_records	Dodanie wpisu do historii kontaktu.
POST	customers/:id/notes	Dodanie notatki dla klienta w CRM.
PUT	companies/:id	Edycja firmy.
PUT	customers/:id	Edycja klienta.

CRM (seria)

HTTP	Zasób	Opis
DELETE	batch/customers	Usuwanie wielu klientów.
POST	batch/customers	Dodanie wielu klientów.
PUT	batch/customers	Edycja wielu klientów.

Kampanie

HTTP	Zasób	Opis
DELETE	outbounds/:id	Usuwa kampanię wraz ze wszystkimi rekordami.
GET	outbounds	Zwraca listę wszystkich kampanii.
GET	outbounds/:id/agents	Zwraca listę wszystkich agentów w danej kampanii.
GET	outbounds/:id/stats	Zwraca statystykę rekordów dla kampanii.
GET	outbounds/:id/statuses	Zwraca listę wszystkich statusów w danej kampanii.
GET	outbounds/stats	Zwraca statystykę rekordów dla wszystkich aktywnych kampanii.
POST	outbounds	Dodaje kampanie.
POST	outbounds/:id/add_agents	Dodaje listę agentów do kampanii.
POST	outbounds/:id/clone	Klonuje kampanię.
POST	outbounds/:id/remove_agents	Usuwa agentów z kampanii.
POST	outbounds/:id/set_agents	Dodaje i usuwa agentów z kampanii.
PUT	outbounds/:id	Aktualizuje kampanie.

Kampanie (seria)

HTTP	Zasób	Opis
DELETE	batch/outbounds	Usuwanie wielu kampanii wraz ze wszystkimi rekordami.

Kampanie CRM

HTTP	Zasób	Opis
DELETE	crm_outbounds/:id/records/:customer_id	Usuwanie rekordu z kampanii CRM.
GET	crm_outbounds/:id/records	Zwraca listę rekordów w kampanii wraz z podstawowymi parametrami.
GET	crm_outbounds/:id/records/:customer_id	Zwraca informacje o rekordzie w kampanii zasilanej z CRM.
POST	crm_outbounds/:id/records	Dodanie rekordu do kampanii CRM.
POST	crm_outbounds/:id/records/:customer_id/copy_notes	Kopiuje notatki z kampanii do CRM.
PUT	crm_outbounds/:id/records/:customer_id	Edycja rekordu z kampanii zasilanej z CRM.

Kampanie CRM (seria)

HTTP	Zasób	Opis
DELETE	batch/crm_outbounds/:id/records	Usuwanie wielu rekordów z kampanii CRM.
POST	batch/crm_outbounds/:id/records	Dodanie wielu rekordów do kampanii CRM.

Kampanie zwykłe

HTTP	Zasób	Opis
DELETE	outbounds/:id/records/:phone_number	Usuwanie rekordu z kampanii.
DELETE	outbounds/:id/records_by_identifier/:identifier	Usuwanie rekordu z kampanii.
GET	outbounds/:id/records	Zwraca listę rekordów w kampanii wraz z podstawowymi parametrami.
GET	outbounds/:id/records/:phone_number	Zwraca informacje o rekordzie w kampanii.
GET	outbounds/:id/records_by_identifier/:identifier	Zwraca informacje o rekordzie w kampanii.
GET	outbounds_by_phone_number/:phone_number	Zwraca listę kampanii, w których jest podany numer telefonu.
POST	outbound_status_by_phone_number	Zmiana statusu rekordów na podstawie numeru telefonu.
POST	outbounds/:id/records	Dodanie rekordu do kampanii.
PUT	outbounds/:id/records/:phone_number	Edytowanie rekordu w kampanii.
PUT	outbounds/:id/records_by_identifier/:identifier	Edytowanie rekordu w kampanii.

Kampanie zwykłe (seria)

HTTP	Zasób	Opis
DELETE	batch/outbounds/:id/records	Usuwanie wielu rekordów z kampanii.
POST	batch/outbounds/:id/records	Dodanie wielu rekordów do kampanii.
PUT	batch/outbounds/:id/records	Edytowanie wielu rekordów w kampanii.

Grupy kampani

HTTP	Zasób	Opis
GET	outbound_groups	Zwraca listę grup kampanii.
GET	outbound_groups/:id	Zwraca grupę kampanii.
POST	outbound_groups	Dodaje grupę kampanii.

Kolejki

HTTP	Zasób	Opis
GET	queues	Zwraca listę kolejek.
GET	queues/:id/topics	Zwraca tematy rozmów dostępnych dla danej kolejki.
GET	queues/:id/waiting_list	Zwraca numery telefonów osób oczekujących w kolejce.
GET	queues/:id/waiting_stats	Zwraca liczbę osób oczekujących w kolejce oraz przewidywany czas oczekiwania na połączenie.
POST	queues/:id/schedule_call	Zaplanowanie połączenia, które zostanie wykonane w kolejce.

Nagrania

HTTP	Zasób	Opis
DELETE	recordings	Umieszcza nagranie w kolejce do usunięcia.
GET	recordings	Zwraca listę nagrań.
GET	recordings/download	Zwraca plik z nagraniem.
GET	recordings/stream	Strumieniuje plik z nagraniem.

Pliki

HTTP	Zasób	Opis
GET	downloads/:id/attached_file	Pobieranie pliku załączonego do klienta.
GET	files/:token	Pobieranie pliku.

Pliki tymczasowe

HTTP	Zasób	Opis
POST	temporary_files	Tworzy na serwerze tymczasowy plik.

Połączenia

HTTP	Zasób	Opis
GET	connections	Zwraca listę połączeń.
GET	connections/:id/topic	Zwraca temat rozmowy.
POST	connections/:id/hangup	Rozłącza połączenie.
POST	connections/call	Zestawia połączenie na wskazany numer.
POST	connections/topic	Dodaje lub aktualizuje temat połączenia.

Przekierowania

HTTP	Zasób	Opis
DELETE	forwardings/:id	Usuwanie przekierowania.
GET	forwardings	Pobieranie przekierowań.
POST	forwardings	Dodawanie przekierowania.
PUT	forwardings/:id	Zmiana przekierowania.

System

HTTP	Zasób	Opis
GET	system/pauses	Zwraca listę pauz.
GET	system/transfer_shortcuts	Zwraca skróty do przekierowań.
PUT	system/announcement	Ustawia komunikat systemowy dla użytkowników.

Użytkownicy

HTTP	Zasób	Opis
GET	users/:login	Zwraca informacje o użytkowniku (przypisane konta SIP).

Zadania

HTTP	Zasób	Opis
GET	todos/:id	Zwraca informacje o zadaniu.
POST	todos	Dodaje zadanie użytkownikowi.

Zgłoszenia

HTTP	Zasób	Opis
DELETE	tickets/:id	Usuwanie zgłoszenia.
DELETE	tickets/:id/attachments/:token	Usuwanie załącznika.
GET	ticket_categories	Zwraca listę kategorii zgłoszeń.
GET	ticket_queues	Zwraca listę kolejek zgłoszeń.
GET	ticket_statuses	Zwraca listę statusów zgłoszeń.
GET	tickets	Zwraca listę zgłoszeń.
GET	tickets/:id	Zwraca informacje o zgłoszeniu.
GET	tickets/today_stats	Zwraca statystyki zgłoszeń dla obecnego dnia.
POST	tickets	Dodanie zgłoszenia.
POST	tickets/:id/agent_response	Wysłanie wiadomości do zgłoszenia klienta.
POST	tickets/:id/comment	Dodanie komentarza do zgłoszenia.
POST	tickets/:id/customer_response	Dodanie odpowiedzi od klienta do zgłoszenia.
PUT	tickets/:id	Edycja zgłoszenia.

Drzewo IVR

HTTP	Zasób	Opis
PUT	ivr/:branch/activate	Aktywuje gałąź IVR.
PUT	ivr/:branch/deactivate	Deaktywuje gałąź IVR.
PUT	ivr/:branch/prompt_file	Zmiana nagrania.

Grupy pól specjalnych klienta

HTTP	Zasób	Opis
GET	customer_field_groups	Zwraca listę grup pól specjalnych klienta

Rekordy pól specjalnych klienta

HTTP	Zasób	Opis
DELETE	customer_field_group_items/:id	Usuwanie rekordu pól specjalnych klienta.
GET	customer_field_group_items	Zwraca listę rekordów pól specjalnych klienta
POST	customer_field_group_items	Dodanie rekordu pól specjalnych dla klienta.
PUT	customer_field_group_items/:id	Edycja rekordu pól specjalnych klienta.

Elementy webhook

HTTP	Zasób	Opis
DELETE	webhooks/:id	Usuwa element webhook.
GET	webhooks	Zwraca wszystkie elementy webhook.
POST	webhooks	Dodaje element webhook.

Voicebot

HTTP	Zasób	Opis
POST	voicebots/:name/calls/:call_id/transcript	Dodaje transkrypcję połączenia z voicebotem.

Tematy rozmów

HTTP	Zasób	Opis
GET	topics	Zwraca aktywne tematy rozmów.

Tagi

HTTP	Zasób	Opis
POST	tags	Dodaje nowe tagi, duplikaty zostaną automatycznie pominięte.

Wiadomości SMS

HTTP	Zasób	Opis
POST	sms_messages	Wysłanie SMS-a.