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.
PUT companies/:id Edycja firmy.
PUT customers/:id Edycja klienta.

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

Pliki tymczasowe

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

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

Grupy pól specjalnych klienta

HTTP Zasób Opis
GET customer_field_groups Zwraca listę grup 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.

Tematy rozmów

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

Wiadomości SMS

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