Wprowadzenie

System Thulium posiada możliwość wysyłania informacji o połączeniach telefonicznych i czatach na podany adres zwrotny (tzw. callback lub webhook).

Aby skonfigurować taki adres należy w Panelu Thulium w zakładce Administracja -> Parametry API, ustawić adres skryptu, który będzie odpowiedzialny za odbieranie danych. Dane przesyłane są do skryptu metodą POST (przez HTTP lub HTTPS). Dodatkowo w zakładce tej można ustawić czy podczas wywołania skryptu mają się wysyłać dane autoryzacyjne (Auth Basic).

Przypisanie agenta do rozmowy

action Akcja rozróżniająca typ żądania Przykładowa wartość: CHAT_AGENT_ASSIGNED
conversation_id Unikalny identyfikator rozmowy Przykładowa wartość: 83a3f676-e831-47d0-bba7-beda6c0bde88
agent_login Login agenta Przykładowa wartość: jkowalski
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24
chat_queue_id Identyfikator kolejki Przykładowa wartość: 1

Zakończenie rozmowy

action Akcja rozróżniająca typ żądania Przykładowa wartość: CHAT_CONVERSATION_CLOSED
conversation_id Unikalny identyfikator rozmowy Przykładowa wartość: 83a3f676-e831-47d0-bba7-beda6c0bde88
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24
chat_queue_id Identyfikator kolejki Przykładowa wartość: 1

Stworzenie nowej rozmowy

action Akcja rozróżniająca typ żądania Przykładowa wartość: CHAT_CONVERSATION_CREATED
conversation_id Unikalny identyfikator rozmowy Przykładowa wartość: 83a3f676-e831-47d0-bba7-beda6c0bde88
client_name Nazwa klienta Przykładowa wartość: John Smith
client_email E-mail klienta Przykładowa wartość: john.smith@foo.bar
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24
chat_queue_id Identyfikator kolejki Przykładowa wartość: 1

Zakończenie połączenia

action Akcja rozróżniająca typ żądania Przykładowa wartość: AGENT_COMPLETED
connection_id Unikalny identyfikator połączenia Przykładowa wartość: 1416225570.341
queue_id Identyfikator kolejki Przykładowa wartość: 155
agent_login Login agenta Przykładowa wartość: jkowalski
source_number Numer dzwoniącego Przykładowa wartość: 523993855
destination_number Numer agenta Przykładowa wartość: 162
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24
duration Pełny czas połączenia (w sekundach) Przykładowa wartość: 69
billsec Czas połączenia, za który operator powinien naliczyć opłatę (w sekundach) Przykładowa wartość: 67
filename Plik z nagraniem rozmowy Przykładowa wartość: SOME-QUEUE/2014-11-17/2014-11-17_125932_1416225570.341.wav

Odebranie połączenia

action Akcja rozróżniająca typ żądania Przykładowa wartość: AGENT_CONNECTED
connection_id Unikalny identyfikator połączenia Przykładowa wartość: 1416225570.341
queue_id Identyfikator kolejki Przykładowa wartość: 155
agent_login Login agenta Przykładowa wartość: jkowalski
source_number Numer dzwoniącego Przykładowa wartość: 523993855
destination_number Numer agenta Przykładowa wartość: 162
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24

Telefon dzwoni u agenta

action Akcja rozróżniająca typ żądania Przykładowa wartość: AGENT_RINGING
connection_id Unikalny identyfikator połączenia Przykładowa wartość: 1416225570.341
queue_id Identyfikator kolejki Przykładowa wartość: 155
agent_login Login agenta Przykładowa wartość: jkowalski
source_number Numer dzwoniącego Przykładowa wartość: 523993855
destination_number Numer agenta Przykładowa wartość: 162
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24

Wejście do kolejki

action Akcja rozróżniająca typ żądania Przykładowa wartość: ENTER_QUEUE
connection_id Unikalny identyfikator połączenia Przykładowa wartość: 1416225570.341
queue_id Identyfikator kolejki Przykładowa wartość: 155
source_number Numer dzwoniącego Przykładowa wartość: 523993855
source_name Nazwa dzwoniącego Przykładowa wartość: BOK: Kowalski
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24

Wyjście z kolejki

action Akcja rozróżniająca typ żądania Przykładowa wartość: EXIT_QUEUE
connection_id Unikalny identyfikator połączenia Przykładowa wartość: 1416225570.341
queue_id Identyfikator kolejki Przykładowa wartość: 155
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24

Połączenie z klientem i zakończenie połączenia

action Akcja rozróżniająca typ żądania Przykładowa wartość: OUTBOUND_COMPLETED
id Pięcioznakowy identyfikator kampanii Przykładowa wartość: 00001
name Nazwa kampanii Przykładowa wartość: Outbound
record_id Identyfikator rekordu Przykładowa wartość: 162
phone_number Numer, na który dzwonimy Przykładowa wartość: 523993855
connection_id Unikalny identyfikator połączenia Przykładowa wartość: 1416225570.341
agent_login Login agenta Przykładowa wartość: jkowalski
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24
duration Pełny czas połączenia (w sekundach) Przykładowa wartość: 69
billsec Czas połączenia, za który operator powinien naliczyć opłatę (w sekundach) Przykładowa wartość: 67
filename Plik z nagraniem rozmowy Przykładowa wartość: 00001/2017-07-26/2017-07-26_15.32.19-975789022-1501075938.16.wav
Uwagi:
Parametr action może przyjmować wartości:
  • OUTBOUND_CONNECTING - akcja wywołana w momencie rozpoczęcia zestawiania połączenia
  • OUTBOUND_CUSTOMER_CONNECTED - akcja wywołana w momencie odebrania telefonu przez klienta
  • OUTBOUND_COMPLETED - akcja wywołana w momencie zakończenia odebranego połączenia
  • OUTBOUND_DROP - akcja wywołana w momencie spadu rekordu
  • OUTBOUND_BUSY - akcja wywołana w momencie gdy telefon klienta jest zajęty
  • OUTBOUND_FAX - akcja wywołana w momencie gdy telefon odebrał fax
  • OUTBOUND_NO_ANSWER - akcja wywołana w momencie gdy abonent nie odbiera
  • OUTBOUND_WRONG_NUMBER - akcja wywołana w momencie gdy numer jest niepoprawny
  • OUTBOUND_VOICE_MAIL - akcja wywołana w momencie gdy odebrała automatyczna sekretarka
  • OUTBOUND_FAILURE - akcja wywołana w momencie gdy jest niezidentyfikowany problem z połączeniem
  • OUTBOUND_CONNECTION_PROBLEM - akcja wywołana w momencie gdy wystąpił problem z połączeniem po stronie operatora
  • OUTBOUND_BLACKLIST - akcja wywołana w momencie gdy numer znajduje się na czarnej liście
  • PREDICTIVE_AGENT_ANSWER - akcja wywołana w momencie gdy agent odbiera połączenie predictive

Agent zapisał rekord z kampanii

action Akcja rozróżniająca typ żądania Przykładowa wartość: OUTBOUND_RECORD_SAVED
id Pięcioznakowy identyfikator kampanii Przykładowa wartość: 00001
name Nazwa kampanii Przykładowa wartość: Outbound
record_id Identyfikator rekordu Przykładowa wartość: 162
phone_number Numer, na który dzwonimy Przykładowa wartość: 523993855
agent_login Login agenta Przykładowa wartość: jkowalski
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24
system_status Status systemowy Przykładowa wartość: MY_RECORD
status_id Identyfikator statusu rekordu w kampanii Przykładowa wartość: 8
record_id Identyfikator rekordu Przykładowa wartość: 162
connection_id Unikalny identyfikator połączenia Przykładowa wartość: 1416225570.341
Uwagi:
Pole system_status:
  • TO_CALL Do dzwonienia (świeżo dodane rekordy)
  • IN_PROGRESS Obrabiane
  • CALL Dzwonić
  • MY_RECORD Mój rekord
  • NO_CALL Nie dzwonić
  • ABANDONED_AFTER_N_TRIES Odrzucony po n próbach
  • CALL_NO_SOONER_THAN Kontakt nie wcześniej niż
  • CALL_PROGRESSIVE Dzwonić w trybie progressive (np. dla spadów w trybie predictive)

Pokazana została karta kampanii preview

action Akcja rozróżniająca typ żądania Przykładowa wartość: PREVIEW_RECORD
id Pięcioznakowy identyfikator kampanii Przykładowa wartość: 00001
name Nazwa kampanii Przykładowa wartość: Outbound
record_id Identyfikator rekordu Przykładowa wartość: 162
customer_id Identyfikator klienta Przykładowa wartość: 154
phone_number Numer, na który dzwonimy Przykładowa wartość: 523993855
agent_login Login agenta Przykładowa wartość: jkowalski
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24

Agent zalogował się do Thulium Agenta

action Akcja rozróżniająca typ żądania Przykładowa wartość: AGENT_LOGGED_IN
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24
agent_login Login agenta Przykładowa wartość: jkowalski

Agent wylogował się z Thulium Agenta

action Akcja rozróżniająca typ żądania Przykładowa wartość: AGENT_LOGGED_OUT
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24
agent_login Login agenta Przykładowa wartość: jkowalski

Agent zmienił status (pauza/wolny)

action Akcja rozróżniająca typ żądania Przykładowa wartość: AGENT_STATUS_CHANGED
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24
agent_login Login agenta Przykładowa wartość: jkowalski
pause_id Identyfikator pauzy Przykładowa wartość: 1
previous_pause_id Identyfikator poprzednio ustawionej pauzy Przykładowa wartość: NULL
Uwagi:
pause_id i previous_pause_id przyjmuje wartość NULL kiedy agent jest wolny

Odebranie zgłoszenia

action Akcja rozróżniająca typ żądania Przykładowa wartość: TICKET_MESSAGE_RECEIVED
ticket_id Identyfikator zgłoszenia Przykładowa wartość: 12
message_id Identyfikator wiadomości w zgłoszeniu Przykładowa wartość: 122
ticket_queue_id Identyfikator kolejki zgłoszeń Przykładowa wartość: 4
date Data wykonania akcji Przykładowa wartość: 2016-04-20 09:46:24