REST API. Wprowadzenie. Kampanie. Kampania zwykła. Kampania zasilana z CRM CC CRM. Kolejki. Thulium REST API. Autentykacja.

Transkrypt

1 Thulium REST API REST API Wprowadzenie Kody odpowiedzi Obsługa błędów Notyfikacje o połączeniach (adresy callback) Kampanie Zasoby Opis outbounds Zwraca listę wszystkich kampanii. outbounds/:id/statuses Zwraca listę wszystkich statusów w danej kampanii. outbounds/:id/records Zwraca listę rekordów w kampanii. Kampania zwykła Zasoby Opis outbounds/:id/records/:phone_number Zwraca informacje o rekordzie w kampanii. POST outbounds/:id/records Dodanie rekordu do kampanii. DELETE outbounds/:id/records/:phone_number Usuwanie rekordu z kampanii. PUT outbounds/:id/records/:phone_number Edycja rekordu z kampanii. Kampania zasilana z CRM Zasoby Opis crm_outbounds/:id/records/:customer_id Zwraca informacje o rekordzie w kampanii zasilanej z CRM. POST crm_outbounds/:id/records Dodanie rekordu do kampanii zasilanej z CRM. DELETE crm_outbounds/:id/records/:customer_id Usuwanie rekordu z kampanii zasilanej z CRM. PUT crm_outbounds/:id/records/:customer_id Edycja rekordu z kampanii zasilanej z CRM. CC CRM Zasoby Opis companies Zwraca listę firm zawężoną o podane kryteria wyszukiwania. POST companies Dodanie firmy do CC CRM. PUT companies Edycja firmy w CC CRM. customers Zwraca listę klientów zawężonych o podane kryteria wyszukiwania. POST customers Dodanie klienta do CC CRM. PUT customers Edycja klienta w CC CRM. Kolejki Zasoby Opis queues Zwraca listę kolejek.

2 Zasoby Opis queues/:id/waiting_stats Zwraca liczbę osób oczekujących w kolejce, IVR oraz przewidywany czas oczekiwania na połączenie. queues/:id/waiting_list Zwraca listę numerów telefonów oczekujących w kolejce. queues/:id/topics Zwraca listę aktywnych grup tematów (wraz z tematami) dla danej kolejki. Połączenia Zasoby Opis POST connections/topic Dodaje temat rozmowy dla połaczenia. Agenci Zasoby Opis agents Zwraca listę agentów. POST agents Dodanie agenta. agents/:login Zwraca informacje o agencie. POST agents/:login/call Zestawia połączenie dla agenta na podany numer. agents/:login/last_queue_connection Zwraca informacje na temat ostatniej rozmowy agenta w kolejce. agents/:login/status Zwraca status agenta. POST agents/:login/pause Pauzowanie agenta. POST agents/:login/free Odpauzowanie agenta. POST agents/:login/logout Wylogowanie agenta. POST agents/:login/hangup Zakończenie połączeń agenta. POST agents/:login/screenshot Wykonuje zrzut ekranu agenta. Zgłoszenia Zasoby Opis tickets Zwraca listę zgłoszeń. POST tickets Dodanie zgłoszenia. tickets/:id Zwraca informacje o zgłoszeniu. tickets/today_stats Zwraca statystyki zgłoszeń dla obecnego dnia. Pliki Zasoby Opis POST uploads Wgranie pliku na serwer. Nagrania Zasoby Opis recordings Pobranie listy nagrań. recordings/download Pobranie pliku nagrania. recordings/stream Strumieniowanie pliku nagrania. System Zasoby Opis system/pauses Pobranie listy pauz. system/transfer_shortcuts Zwraca skrótów do przekierowań.

3 Wprowadzenie Dokumentacja / Wprowadzenie / Dla metod, które wymagają autentykacji należy dodać odpowiednie nagłówki do requestu HTTP. odbywa się przez nagłowek Authorize (więcej informacji). Przykład Dla użytkownika "user" i hasła "password" należy wysłać w nagłówku typ autoryzacji Basic oraz Base64 w formacie "użytkownik:hasło". Authorization: Basic dxnlcjpwyxnzd29yzao= Pomoc Jeśli nie posiadasz nazwy użytkownika i hasła do API skontaktuj się z serwisem Thulium.

4 Dokumentacja / Wprowadzenie / Kody odpowiedzi Kody odpowiedzi W ramach wysyłanych requestów zwracane są odpowiednie kody HTTP, które określają status wykonanej operacji. Metoda Kod HTTP Opis 200 Request poprawny, zwrócono dane. POST 201 Utworzono obiekt. PUT 204 Zaktualizowano obiekt. DELETE 204 Request poprawny, brak danych do zwrócenia. /POST/PUT/DELETE 400 Błędny request: wystąpił błąd podczas walidacji danych. /POST/PUT/DELETE 401 Błędny request: autoryzacja nie powiodła się, podano błędnego użytkownika lub hasło. /POST/PUT/DELETE 404 Błędny request: nie znaleziono szukanego zasobu (URI lub obiektu o podanym identyfikatorze). /POST/PUT/DELETE 500 Wewnętrzny błąd serwera podczas przetwarzania requestu.

5 Dokumentacja / Wprowadzenie / Obsługa błędów Obsługa błędów Dla requestów, które kończą się błędami zwracana jest dokładna informacja o błędzie. Informacja ta zawiera opis i kod błędu oraz identyfikator requestu. Może zostać zwrócony więcej niż jeden błąd. Identyfikator requestu potrzebny jest przy zgłaszaniu błędów do serwisu Thulium. Przykład "request_id": " cf", "errors": [ "message": "Wrong format of phone number.", "code": , "message": "Duplicated customer name.", "code": ] Język Język odpowiedzi jest domyślnie ustawiony na angielski. Oznacza to, że wszelkie komunikaty o błędach będą zwrócone po angielsku. Żeby wymusić inny język należy w ramach requestu wysłać nagłówek Accept-Language. Przykład Dla języka polskiego należy wysłać nagłówek: Accept-Language: pl

6 Dokumentacja / Wprowadzenie / Notyfikacje o połączeniach (adresy callback) Notyfikacje o połączeniach (adresy callback) System Thulium posiada możliwość wysyłania informacji o połączeniu w kolejce na podany adres callback. Aby skonfigurować taki adres należy w Panelu Thulium w zakładce Administracja -> Adresy callback, ustawić adres skryptu który będzie odpowiedzialny za odbieranie danych. Dane przesyłane do skryptu są przesyłane metodą POST. System Thulium wywołuje skrypt klienta, na podane akcje: wejście do kolejki, odebrania połączenia przez agenta, zakończenie połączenia Parametry wysyłane na poszczególne akcje: Wejście do kolejki - parametry action Akcja rozróżniająca typ żądania Przykładowa wartość: ENTER_QUEUE connection_id Unikalny identyfikator połączenia Przykładowa wartość: queue_id Identyfikator kolejki Przykładowa wartość: 155 source_number Numer dzwoniącego Przykładowa wartość: date Data wykonania akcji Przykładowa wartość: :59:34 Telefon dzwoni u agenta - parametry action Akcja rozróżniająca typ żądania Przykładowa wartość: AGENT_RINGING connection_id Unikalny identyfikator połączenia Przykładowa wartość: queue_id Identyfikator kolejki Przykładowa wartość: 155 agent_login Login agent, który odebrał połączenia Przykładowa wartość: jkowalski source_number Numer dzwoniącego Przykładowa wartość: destination_number Numer agenta Przykładowa wartość: 162 date Data wykonania akcji Przykładowa wartość: :59:36 Odebranie połączenia - parametry action Akcja rozróżniająca typ żądania Przykładowa wartość: AGENT_CONNECTED connection_id Unikalny identyfikator połączenia Przykładowa wartość:

7 queue_id Identyfikator kolejki Przykładowa wartość: 155 agent_login Login agent, który odebrał połączenia Przykładowa wartość: jkowalski source_number Numer dzwoniącego Przykładowa wartość: destination_number Numer agenta Przykładowa wartość: 162 date Data wykonania akcji Przykładowa wartość: :59:36 Zakończenie połączenia - parametry action Akcja rozróżniająca typ żądania Przykładowa wartość: AGENT_COMPLETED connection_id Unikalny identyfikator połączenia Przykładowa wartość: queue_id Identyfikator kolejki Przykładowa wartość: 155 agent_login Login agent, który odebrał połączenia Przykładowa wartość: jkowalski source_number Numer dzwoniącego Przykładowa wartość: destination_number Numer agenta Przykładowa wartość: 162 date Data wykonania akcji Przykładowa wartość: :00:43 duration Czas trwania połączenia od wejścia w kolejkę (w sekundach) Przykładowa wartość: 69 billsec Czas trwania rozmowy (w sekundach) Przykładowa wartość: 67 filename Plik z nagraniem rozmowy Przykładowa wartość: SOME-QUEUE/ / _125932_ wav

8 Kampanie Dokumentacja / Kampanie outbounds Ostatnia aktualizacja: :17:40 Zwraca listę wszystkich kampanii. [ ] "id": "00002", "name": "API test", "crm": true $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" curl -u api_user:api_pass -k -X "

9 Dokumentacja / Kampanie outbounds/:id/statuses Ostatnia aktualizacja: :29:38 Zwraca listę wszystkich statusów w danej kampanii. Parametry id Pięcioznakowy identyfikator kampanii. Przykładowa wartość: [ "status_id": "3", "name": "Dzwonić nieobecność", "status_id": "4", "name": "Nie dzwonić nie zainteresowany" $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" ses"); curl -u api_user:api_pass -k -X "

10 Dokumentacja / Kampanie outbounds/:id/records Ostatnia aktualizacja: :29:38 Zwraca listę rekordów w kampanii wraz z podstawowymi parametrami w kolejności dodawania do kampanii. Parametr count zwraca całkowitą ilość rekordów w kampanii. Parametry id Pięcioznakowy identyfikator kampanii. Przykładowa wartość: limit Liczba rekordów, które mają być zwrócone. Domyślnie: 100. Maksymalna wartość: 100. Przykładowa wartość: 100 offset Od którego rekordu należy zwrócić rezultat (używane, gdy rekordów jest więcej, niż limit). Domyślna wartość: 0. Przykładowa wartość: 10 "count": 1, "result": [ "record_id": 228, "phone_number": "5555", "status": "Nie dzwonić", "status_id": 5, "next_call_date": "", "agent_name": "", "agent_login": "", "customer_id": 311 ]

11 $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" ds?limit=5&offset=0"); curl -u api_user:api_pass -k -X "

12 Kampania zwykła Dokumentacja / Kampania zwykła outbounds/:id/records/:phone_number Ostatnia aktualizacja: :29:38 Zwraca informacje o rekordzie w kampanii. Parametry id Pięcioznakowy identyfikator kampanii. Przykładowa wartość: phone_number Numer telefonu dodany do kampanii. Przykładowa wartość: "record_id": 228, "phone_number": " ", "status": "Nie dzwonić", "status_id": 5, "next_call_date": "", "agent_name": "", "agent_login": "", "customer_id": ""

13 $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" ds/ "); curl -u api_user:api_pass -k -X "

14 Dokumentacja / Kampania zwykła POST outbounds/:id/records Ostatnia aktualizacja: :40:38 Dodanie rekordu do kampanii. Za pomocą API nie można dodawać zduplikowanych numerów. Parametry POST id Pięcioznakowy identyfikator kampanii. Przykładowa wartość: phone_number Numer telefonu na który będą wykonywane połączenia. Przykładowa wartość: status_id Identyfikator statusu rekordu w kampanii. Tylko dla statusu systemowego Mój rekord należy uzupełnić pola agent_id i next_call_date. Przykładowa wartość: 8 agent_id Identyfikator agenta do którego zostanie przypisany rekord. Przykładowa wartość: 1020 next_call_date Data następnego kontaktu w formacie YYYY-MM-DD hh:mm. Przykładowa wartość: :24 POST Dane "phone_number":" ","status_id":"3" "record_id": "231"

15 $data = '"phone_number":" ","status_id":"3"'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" rds", "\"phone_number\":\" \",\"status_id\":\"3\""); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '"phone_number":" ","status_id ":"3"' "

16 Dokumentacja / Kampania zwykła DELETE outbounds/:id/records/:phone_number Ostatnia aktualizacja: :40:38 Usuwanie rekordu z kampanii. Za pomocą API nie można usuwać zduplikowanych numerów. Parametry DELETE id Pięcioznakowy identyfikator kampanii. Przykładowa wartość: phone_number Numer telefonu który zostanie usunięty z kampanii. Przykładowa wartość: DELETE <!-- pusty --> $data = ''; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'DELETE'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.delete(" cords/ "); curl -u api_user:api_pass -k -X DELETE "

17 Dokumentacja / Kampania zwykła PUT outbounds/:id/records/:phone_number Ostatnia aktualizacja: :40:38 Edytowanie rekordu w kampanii. Za pomocą API nie można edytować zduplikowanych numerów. Parametry PUT id Pięcioznakowy identyfikator kampanii. Przykładowa wartość: status_id Identyfikator statusu rekordu w kampanii. Tylko dla statusu systemowego Mój rekord należy uzupełnić pola agent_id i next_call_date. Przykładowa wartość: 8 agent_id Identyfikator agenta do którego zostanie przypisany rekord. Przykładowa wartość: 1020 next_call_date Data następnego kontaktu w formacie YYYY-MM-DD hh:mm. Przykładowa wartość: :24 PUT Dane "status_id":"3" <!-- pusty -->

18 $data = '"status_id":"3"'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'PUT'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.put(" ds/ ", "\"status_id\":\"3\""); curl -u api_user:api_pass -k -X PUT -H "Content-type: application/" -d '"status_id":"3"' " unds/00001/records/ "

19 Kampania zasilana z CRM Dokumentacja / Kampania zasilana z CRM crm_outbounds/:id/records/:customer_id Ostatnia aktualizacja: :29:38 Zwraca informacje o rekordzie w kampanii zasilanej z CRM. Parametry id Pięcioznakowy identyfikator kampanii. Przykładowa wartość: customer_id Identyfikator klienta zapisanego w CC CRM. Przykładowa wartość: "record_id": 47, "phone_number": " ", "status": "Nie dzwonić", "status_id": 6, "next_call_date": "", "agent_name": "", "agent_login": "", "customer_id": 441

20 $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" ecords/441"); curl -u api_user:api_pass -k -X "

21 Dokumentacja / Kampania zasilana z CRM POST crm_outbounds/:id/records Ostatnia aktualizacja: :29:38 Dodanie rekordu do kampanii CRM. Parametry POST id Pięcioznakowy identyfikator kampanii. Przykładowa wartość: customer_id Identyfikator klienta zapisanego w CC CRM. Przykładowa wartość: 441 status_id Identyfikator statusu rekordu w kampanii. Tylko dla statusu systemowego Mój rekord należy uzupełnić pola agent_id i next_call_date. Przykładowa wartość: 8 agent_id Identyfikator agenta do którego zostanie przypisany rekord. Przykładowa wartość: 1020 next_call_date Data następnego kontaktu w formacie YYYY-MM-DD hh:mm. Przykładowa wartość: :24 POST Dane "customer_id":441,"status_id":3 "record_id": "231"

22 $data = '"customer_id":441,"status_id":3'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" /records", "\"customer_id\":441,\"status_id\":3"); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '"customer_id":441,"status_id":3' " localhost/api/crm_outbounds/00001/records"

23 Dokumentacja / Kampania zasilana z CRM DELETE crm_outbounds/:id/records/:customer_id Ostatnia aktualizacja: :29:38 Dodanie rekordu do kampanii CRM. Parametry DELETE id Pięcioznakowy identyfikator kampanii. Przykładowa wartość: customer_id Identyfikator klienta zapisanego w CC CRM. Przykładowa wartość: 441 DELETE <!-- pusty --> $data = ''; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'DELETE'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.delete(" 01/records/441"); curl -u api_user:api_pass -k -X DELETE "

24 Dokumentacja / Kampania zasilana z CRM PUT crm_outbounds/:id/records/:customer_id Ostatnia aktualizacja: :29:38 Edycja rekordu z kampanii zasilanej z CRM. Parametry PUT id Pięcioznakowy identyfikator kampanii. Przykładowa wartość: customer_id Identyfikator klienta zapisanego w CC CRM. Przykładowa wartość: 441 status_id Identyfikator statusu rekordu w kampanii. Tylko dla statusu systemowego Mój rekord należy uzupełnić pola agent_id i next_call_date. Przykładowa wartość: 8 agent_id Identyfikator agenta do którego zostanie przypisany rekord. Przykładowa wartość: 1020 next_call_date Data następnego kontaktu w formacie YYYY-MM-DD hh:mm. Przykładowa wartość: :24 PUT Dane "status_id":"3" <!-- pusty -->

25 $data = '"status_id":"3"'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'PUT'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.put(" ecords/441", "\"status_id\":\"3\""); curl -u api_user:api_pass -k -X PUT -H "Content-type: application/" -d '"status_id":"3"' " outbounds/00001/records/441"

26 CC CRM Dokumentacja / CC CRM companies Ostatnia aktualizacja: :31:39 Zwraca listę firm zawężoną o podane kryteria wyszukiwania. Może zwrócić maksymalnie 20 firm. Parametry nip Numer NIP firmy. Przykładowa wartość: [ ] "name": "Thulium", "company_id": 28, "type": "wewnętrzny", "group": "partner", "nip": " ", "address": "street": "os. Złotej Jesieni", "building": "7", "flat": null, "postcode": "31-827", "city": "Kraków", "post_office": "Kraków", "borough": null,, "county": null, "voivodship": null, "country": "Polska", "custom_fields": "ID": null, "Dodatkowe informacje": "brak"

27 $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" 4527"); curl -u api_user:api_pass -k -X "

28 Dokumentacja / CC CRM POST companies Ostatnia aktualizacja: :15:23 Dodanie firmy do CC CRM. Parametry POST name Nazwa firmy. Nazwa jest unikatowa. nip type group custom_fields address street building flat postcode city country Numer NIP firmy. Jeśli jest podany, ma być unikatowy. Tekstowa nazwa typu klienta zdefiniowana w systemie. Tekstowa nazwa grupy klienta zdefiniowana w systemie. Obiekt z wartościami pól specjalnych. Adres firmy. Nazwa ulicy. Numer budynku. Numer mieszkania. Kod pocztowy. Miasto. Kraj. Uwagi Pole custom_fields musi zwawierać mapę pól specjalnych gdzie kluczem jest tekstowa nazwa pola specjalnego a wartością treść którą chcemy ustawić. W obiekcie możemy przekazać tylko te pola, których wartości chcemy ustawić. Jeśli przekazana wartość pola specjalnego będzie pusta zawartość pola zostanie usunięta. W przypadku gdy pole specjalne nie istnieje zostanie utworzone. POST Dane "name":"company","nip":" ","address":"city":"krakow","street":"zlotej Jesieni" "company_id": "21"

29 $data = '"name":"company","nip":" ","address":"city":"krakow","street":"zlotej Jesieni"'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" "\"name\ ":\"company\",\"nip\":\" \",\"address\":\"city\":\"krakow\",\"street\":\"zlotej Jesieni\""); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '"name":"company","nip":" "," address":"city":"krakow","street":"zlotej Jesieni"' "

30 Dokumentacja / CC CRM PUT companies/:id Ostatnia aktualizacja: :15:23 Edycja firmy. Parametry PUT name nip type group custom_fields address street building flat postcode city country Nazwa firmy. Nazwa jest unikatowa. Numer NIP firmy. Jeśli jest podany, ma być unikatowy. Tekstowa nazwa typu klienta zdefiniowana w systemie. Tekstowa nazwa grupy klienta zdefiniowana w systemie. Obiekt z wartościami pól specjalnych. Adres firmy. Nazwa ulicy. Numer budynku. Numer mieszkania. Kod pocztowy. Miasto. Kraj. Uwagi Pole custom_fields musi zwawierać mapę pól specjalnych gdzie kluczem jest tekstowa nazwa pola specjalnego a wartością treść którą chcemy ustawić. W obiekcie możemy przekazać tylko te pola, których wartości chcemy ustawić. Jeśli przekazana wartość pola specjalnego będzie pusta zawartość pola zostanie usunięta. W przypadku gdy pole specjalne nie istnieje zostanie utworzone. PUT Dane "name":"company","nip":" ","address":"city":"krakow","street":"zlotej Jesieni" <!-- pusty -->

31 $data = '"name":"company","nip":" ","address":"city":"krakow","street":"zlotej Jesieni"'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'PUT'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.put(" "\"nam e\":\"company\",\"nip\":\" \",\"address\":\"city\":\"krakow\",\"street\":\"zlotej Jesieni\""); curl -u api_user:api_pass -k -X PUT -H "Content-type: application/" -d '"name":"company","nip":" ","a ddress":"city":"krakow","street":"zlotej Jesieni"' "

32 Dokumentacja / CC CRM customers Ostatnia aktualizacja: :31:39 Zwraca listę klientów zawężonych o podane kryteria wyszukiwania. Może zwrócić maksymalnie 20 klientów. Parametry Adres klienta. Przykładowa wartość: jan.kowalski@foo.bar [ ] "customer_id": 273, "name": "Jan", "surname": "Kowalski", "phone_number": " ", " ": "jan.kowalski@foo.bar", "company_id": "", "identifier": "", "type": "", "group": "", "company_flag": "", "custom_fields": "ID": null, "Dodatkowe informacje": "Numer dowodu - AXX "

33 $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" owalski@foo.bar"); curl -u api_user:api_pass -k -X "

34 Dokumentacja / CC CRM POST customers Ostatnia aktualizacja: :15:23 Dodanie klienta do CC CRM. Parametry POST name surname Imię klienta. Nazwisko klienta. phone_number Adres klienta. Numer telefonu klienta. company_id type group identifier custom_fields Identyfikator firmy, do której ma być dodany klient. Tekstowa nazwa typu klienta zdefiniowana w systemie. Tekstowa nazwa grupy klienta zdefiniowana w systemie. Identyfikator klienta. Obiekt z wartościami pól specjalnych. Uwagi Pole custom_fields musi zwawierać mapę pól specjalnych gdzie kluczem jest tekstowa nazwa pola specjalnego a wartością treść którą chcemy ustawić. W obiekcie możemy przekazać tylko te pola, których wartości chcemy ustawić. Jeśli przekazana wartość pola specjalnego będzie pusta zawartość pola zostanie usunięta. W przypadku gdy pole specjalne nie istnieje zostanie utworzone. POST Dane "surname":"kowalski","phone_number":" " "customer_id": "324"

35 $data = '"surname":"kowalski","phone_number":" "'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" "\"surna me\":\"kowalski\",\"phone_number\":\" \""); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '"surname":"kowalski","phone_number":" "' "

36 Dokumentacja / CC CRM PUT customers/:id Ostatnia aktualizacja: :15:23 Edycja klienta. Parametry PUT name surname phone_number company_id type group identifier custom_fields Imię klienta. Nazwisko klienta. Adres klienta. Numer telefonu klienta. Identyfikator firmy, do której ma być dodany klient. Tekstowa nazwa typu klienta zdefiniowana w systemie. Tekstowa nazwa grupy klienta zdefiniowana w systemie. Identyfikator klienta. Obiekt z wartościami pól specjalnych. Uwagi Pole custom_fields musi zwawierać mapę pól specjalnych gdzie kluczem jest tekstowa nazwa pola specjalnego a wartością treść którą chcemy ustawić. W obiekcie możemy przekazać tylko te pola, których wartości chcemy ustawić. Jeśli przekazana wartość pola specjalnego będzie pusta zawartość pola zostanie usunięta. W przypadku gdy pole specjalne nie istnieje zostanie utworzone. PUT Dane "surname":"kowalski","phone_number":" " <!-- pusty -->

37 $data = '"surname":"kowalski","phone_number":" "'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'PUT'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.put(" "\"surn ame\":\"kowalski\",\"phone_number\":\" \""); curl -u api_user:api_pass -k -X PUT -H "Content-type: application/" -d '"surname":"kowalski","phone_number":" "' "

38 Kolejki Dokumentacja / Kolejki queues Ostatnia aktualizacja: :16:41 Zwraca listę kolejek. [ ] "queue_id": 1, "name": "BOK", "queue_id": 2, "name": "Serwis" $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" curl -u api_user:api_pass -k -X "

39 Dokumentacja / Kolejki queues/:id/waiting_stats Ostatnia aktualizacja: :47:09 Zwraca liczbę osób oczekujących w kolejce, IVR oraz przewidywany czas oczekiwania na połączenie. Dane zwrócone z zasobu prezentują dane z ostatniej godziny. Parametry id Identyfikator kolejki. Przykładowa wartość: 2 "in_queue": 2, "approx_wait_time": "00:00:30" $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception "); ThuliumRestClient.ThuliumRestResponse response = restclient.get(" curl -u api_user:api_pass -k -X "

40 Dokumentacja / Kolejki queues/:id/waiting_list Ostatnia aktualizacja: :47:09 Zwraca numery telefonów osób oczekujących w kolejce. Jeśli numer telefonu zostanie jednoznacznie odnaleziony w CRM, to zwracany jest identyfikator i imię/nazwisko osoby lub nazwa firmy. Parametry id Identyfikator kolejki. Przykładowa wartość: 2 [ ] phone_number: " ", started_at: " :30:37", customer_id: null, customer_label: null, phone_number: " ", started_at: " :30:36", customer_id: null, customer_label: null, phone_number: " ", started_at: " :30:35", customer_id: 123, customer_label: "Jan Kowalski"

41 $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" curl -u api_user:api_pass -k -X "

42 Dokumentacja / Kolejki queues/:id/topics Ostatnia aktualizacja: :12:18 Zwraca tematy rozmów dostępnych dla danej kolejki. Tematy rozmów są pogrupowane (tak jak przy wyborze grup tematów dla danej kolejki). W ramach grupy tematy są wyświetlane jako lista par id+nazwa. Zwracane są jedynie aktywne grupy tematów a w ich ramach jedynie aktywne tematy. Jeżeli grupa tematów jest pusta także się wyświetla. Parametry id Identyfikator kolejki. Przykładowa wartość: 2 groupname: "Grupa jeden", topics: [ "id": 1, "name": "jedyny" ], groupname: "Grupa pusta", topics: [], groupname: "Grupa wiele", topics: [ "id": 2, "name": "pierwszy", "id": 3, "name": "drugi", "id": 4, "name": "trzeci" ]

43 $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" curl -u api_user:api_pass -k -X "

44 Połączenia Dokumentacja / Połączenia POST connections/topic Ostatnia aktualizacja: :20:53 Dodaje temat połączenia. Parametry POST uniqueid Unikalne ID połączenia. Przykładowa wartość: xxxxx topic_id ID wybranego tematu tematu rozmowy. Zarówno temat jak i grupa do której należy muszą być aktywne. Można je zdobyć odpytując queue/:id/topics. Przykładowa wartość: 11 comment Komentarz do połączenia. Przykładowa wartość: nic ciekawego custom_fields Lista parametrów używanych do zapisania wartości pól dodatkowych. Lista obiektów o atrybutach 'field_id', 'value'. Oba atrybuty są wymagane jeżeli taki obiekt wystąpi. Przykładowa wartość: [ "field_id": 1, "value": "pewna wartość", "field_id": 2, "value": "wartość druga" ] POST Dane "uniqueid":"xxxxx","topic_id":1,"comment":"nic ciekawego","custom_fields": ["field_id":1,"value":"pewna wartosc","field_id":2,"value":"wartosc druga"] <!-- pusty -->

45 $data = '"uniqueid":"xxxxx","topic_id":1,"comment":"nic ciekawego","custom_fields":["field_id":1,"value":"pewna war tosc","field_id":2,"value":"wartosc druga"]'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" " \"uniqueid\":\"xxxxx\",\"topic_id\":1,\"comment\":\"nic ciekawego\",\"custom_fields\":[\"field_id\":1,\"value\":\"pewna wartosc\",\"field_id\":2,\"value\":\"wartosc druga\"]"); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '"uniqueid":"xxxxx","topic_id":1,"comme nt":"nic ciekawego","custom_fields":["field_id":1,"value":"pewna wartosc","field_id":2,"value":"wartosc druga"]' "htt p://localhost/api/connections/topics"

46 Agenci Dokumentacja / Agenci agents Ostatnia aktualizacja: :16:41 Zwraca listę agentów. [ ] "agent_id": 1, "login": "", "name": "Automat", "surname": "Automat", "supervisor": "", "active": "", "number": "", "outbound_mode": "manual", "agent_id": 2, "login": "janko", "name": "Jan", "surname": "Kowalski", "supervisor": true, "active": true, "number": , "outbound_mode": "automatic" $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" curl -u api_user:api_pass -k -X "

47

48 Dokumentacja / Agenci POST agents Ostatnia aktualizacja: :54:51 Dodanie agenta. Parametry POST name Imię agenta. Przykładowa wartość: Jan surname Nazwisko agenta. Przykładowa wartość: Kowalski login Login agenta w systemie. Przykładowa wartość: jkowalski password Hasło do autoryzacji podczas logowania. Przykładowa wartość: somepass123!qaz number Numer agenta. Przykładowa wartość: Adres agenta. Przykładowa wartość: jkowalski@example.com change_password Wymuszenie zmiany hasła podczas pierwszego logowania. Domyślna wartość: false Przykładowa wartość: true false callerid Identyfikator dzwoniącego. Domyślna wartość: piersza litera imienia i nazwisko (J.Kowalski). Przykładowa wartość: jkowalski@example.com language Język panelu. Domyślna wartość: pl Przykładowa wartość: pl en supervisor Tworzony agent jest supervisor'em. Domyślna wartość: false. Przykładowa wartość: true false active Ustawienie czy konto jest aktywne. Domyślna wartość: true Przykładowa wartość: true false outbound_mode Tryb rozmów wychodzących. Domyślna wartość: manual Przykładowa wartość: manual blending auto POST Dane "name":"jan","surname":"kowalski","login":"jkowalski"," ":"jk@foo.bar","password":"pass","number":"345"

49 "agent_id": "11" $data = '"name":"jan","surname":"kowalski","login":"jkowalski"," ":"jk@foo.bar","password":"pass","number":"3 45"'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" "\"name\":\" Jan\",\"surname\":\"Kowalski\",\"login\":\"jkowalski\",\" \":\"jk@foo.bar\",\"password\":\"pass\",\"number\":\"345\" "); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '"name":"jan","surname":"kowalski","log in":"jkowalski"," ":"jk@foo.bar","password":"pass","number":"345"' "

50 Dokumentacja / Agenci agents/:login Ostatnia aktualizacja: :16:41 Zwraca informacje o agencie. Parametry login Login agenta w systemie. Przykładowa wartość: jkowalski "agent_id": 1, "login": "jkowalski", "name": "Jan", "surname": "Kowalski", "supervisor": false, "active": true, "number": , "outbound_mode": "manual" $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" curl -u api_user:api_pass -k -X "

51 Dokumentacja / Agenci POST agents/:login/call Ostatnia aktualizacja: :19:41 Zestawia połączenie dla agenta na podany numer. Aby wykonywać połączenia należy stworzyć kampanie o ID Do stworzonej kampanii należy przypisać agenta, który ma wykonywać połączenia. Parametry POST login Login agenta w systemie. Przykładowa wartość: jkowalski phone_number Numer telefonu na który zostanie zestawione połączenie. Przykładowa wartość: POST Dane "phone_number":" " "connection_id": " "

52 $data = '"phone_number":" "'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" "\"phone_number\":\" \""); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '"phone_number":" "' " calhost/api/agents/jkowalski/call"

53 Dokumentacja / Agenci agents/:login/last_queue_connection Ostatnia aktualizacja: :57:29 Zwraca informacje na temat ostatniej rozmowy agenta w kolejce. Parametry login Login agenta w systemie. Przykładowa wartość: jkowalski "queue": "BOK", "started_at": " :14", "ended_at": " :16", "phone_number": " ", "customer_id": 34114, "customer_label": "smith" $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.get(" ueue_connection"); curl -u api_user:api_pass -k -X "

54 Dokumentacja / Agenci agents/:login/status Ostatnia aktualizacja: :32:28 Zwraca status agenta. Możliwe statusy: OFF FREE PAUSED INBOUND_CALL OUTBOUND_CALL CALL Parametry login Login agenta w systemie. Przykładowa wartość: jkowalski "status":"paused", "pause_id":1, "last_change": " :30:44" $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array('content-type: application/')); curl_setopt($request, OPT_USERPWD, "api_user:api_pass"); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception "); ThuliumRestClient.ThuliumRestResponse response = restclient.get(" curl -u api_user:api_pass -k -X "

55 Dokumentacja / Agenci POST agents/:login/pause Ostatnia aktualizacja: :38:58 Pauzuje agenta. Parametry POST login Login agenta w systemie. Przykładowa wartość: jkowalski pause_id Identyfikator pauzy. Przykładowa wartość: 1 POST Dane "pause_id":"1" <!-- pusty --> $data = '"pause_id":"1"'; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" e", "\"pause_id\":\"1\""); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '"pause_id":"1"' " nts/jkowalski/pause"

56 Dokumentacja / Agenci POST agents/:login/free Ostatnia aktualizacja: :34:21 Odpauzowuje agenta. Parametry POST login Login agenta w systemie. Przykładowa wartość: jkowalski POST <!-- pusty --> $data = ''; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" ""); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '' " e"

57 Dokumentacja / Agenci POST agents/:login/logout Ostatnia aktualizacja: :34:21 Wylogowuje agenta. Parametry POST login Login agenta w systemie. Przykładowa wartość: jkowalski POST <!-- pusty --> $data = ''; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" ut", ""); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '' " out"

58 Dokumentacja / Agenci POST agents/:login/hangup Ostatnia aktualizacja: :03:35 Rozłącza połączenia agenta. Parametry POST login Login agenta w systemie. Przykładowa wartość: jkowalski POST <!-- pusty --> $data = ''; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" up", ""); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '' " ngup"

59 Dokumentacja / Agenci POST agents/:login/screenshot Ostatnia aktualizacja: :56:30 Wykonuje zrzut ekranu agenta. Parametry POST login Login agenta w systemie. Przykładowa wartość: jkowalski POST <!-- pusty --> $data = ''; $request = curl_init(' curl_setopt($request, OPT_HTTPHEADER, array( 'Content-Type: application/', 'Content-Length: '. mb_strlen($data) )); curl_setopt($request, OPT_USERPWD, 'api_user:api_pass'); curl_setopt($request, OPT_CUSTOMREQUEST, 'POST'); curl_setopt($request, OPT_POSTFIELDS, $data); print_r(_decode($response)); public class Example public static void main(string[] args) throws Exception ThuliumRestClient.ThuliumRestResponse response = restclient.post(" enshot", ""); curl -u api_user:api_pass -k -X POST -H "Content-type: application/" -d '' " reenshot"