Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP GET

GET connections

Ostatnia modyfikacja 2024-03-20 13:15:19

Zwraca listę połączeń

Opis pól:
  • count - zwraca całkowitą liczbę znalezionych rekordów (bez uwzględnienia limitu),
  • disposition - zawiera rezultat połączenia. Możliwe wartości to: BUSY, FAILED, ANSWERED, NO ANSWER.
  • duration - zawiera czas rozmowy,
  • billsec - zawiera czas bilingowy,
  • src - numer źródłowy,
  • dst - numer docelowy,
  • operator - operator użyty przy połączeniu,
  • filename - nazwa pliku z nagraniem (do wykorzystania w recordings/stream i recordings/download),
  • user - imię i nazwisko użytkownika wykonującego połączenie,
  • connection_id - unikalny identyfikator połączenia,
  • type - typ połączenia: wychodzące lub przychodzące (OUTBOUND/INBOUND).
  • queue_id - identyfikator kolejki połaczenia.
  • topic_id - identyfikator tematu rozmowy.
  • customer_id - identyfikator klienta.
  • tags - załączone tagi.

URL

https://your-system-name.thulium.com/api/connections

Parametry

limit

opcjonalny

Liczba rekordów, które mają być zwrócone. Domyślnie: 100. Maksymalna wartość: 100. Przykładowa wartość: 100
offset

opcjonalny

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
date_from

opcjonalny

Minimalna data rozmowy. Przykładowa wartość: 2014-07-04
date_to

opcjonalny

Maksymalna data rozmowy. Przykładowa wartość: 2014-07-14 12:34
src

opcjonalny

Numer źródłowy. Przykładowa wartość: 123321
dst

opcjonalny

Numer docelowy. Przykładowa wartość: 123321
connection_id

opcjonalny

Unikalny identyfikator połączenia Przykładowa wartość: 1416225570.341
user_login

opcjonalny

Login dzwoniącego użytkownika Przykładowa wartość: j.doe
queue_id

opcjonalny

Identyfikator kolejki połączenia Przykładowa wartość: 542
topic_id

opcjonalny

Identyfikator tematu rozmowy Przykładowa wartość: 365
customer_id

opcjonalny

Identyfikator klienta z CRM. Przykładowa wartość: 321
tags

opcjonalny

Załączony tag dla rozmowy. Przykładowa wartość: tags[]=tag1&tags[]=tag2&tags[]=tag3
include_tags

opcjonalny

Czy zwracać załączony tag dla rozmowy. Przykładowa wartość: true
include_topics

opcjonalny

Czy zwracać temat rozmowy. Przykładowa wartość: true

Przykładowy request

GET https://your-system-name.thulium.com/api/connections?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05

Przykładowy response

{
           "count": 1,
           "result": [   {
                 "date": "2014-07-07 11:08",
                 "src": "123123",
                 "dst": "1234",
                 "disposition": "ANSWERED",
                 "duration": 129,
                 "billsec": 104,
                 "operator": "siptrunk",
                 "filename": "sprzedaz/2014-07-07/2014-07-07_093545_921063395.234.wav",
                 "user": "Bob Smith",
                 "user_login": "bob_smith",
                 "dst_user": "John Doe",
                 "dst_user_login": "john_doe",
                 "customer_id": 123456,
                 "outbound_id": "",
                 "connection_id": "1416225570.341",
                 "type": "INBOUND",
                 "rating": {
                    "type": "face",
                    "rate": "happy"
                 },
                 "queue_id": 34,
                 "tags": ["tag1", "tag2", "tag3"]
           }]
        }

Przykładowe wywołanie


PHP

<?php
$request 
curl_init('https://your-system-name.thulium.com/api/connections?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05');
curl_setopt($requestCURLOPT_HTTPHEADER, array('Content-Type: application/json; charset=utf-8'));
curl_setopt($requestCURLOPT_USERPWD"api_user:api_pass");
curl_setopt($requestCURLOPT_TIMEOUT30);
curl_setopt($requestCURLOPT_RETURNTRANSFERtrue);

$response curl_exec($request);
if (
$response) {
    
$httpCode curl_getinfo($requestCURLINFO_HTTP_CODE);
    if (
$httpCode == 200){
        
print_r(json_decode($response));
    } else {
        echo 
$response;
    }
} else {
    
trigger_error(curl_error($request), E_USER_WARNING);
}

curl_close($request);
JAVA

public class Example {
    public static void main(String[] args) throws Exception {
        ThuliumRestClient restClient = new ThuliumRestClient("api_user", "api_pass", true);

        ThuliumRestClient.ThuliumRestResponse response = restClient.get("https://your-system-name.thulium.com/api/connections?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05");
        System.out.println(response);
    }
}

CURL

curl -u api_user:api_pass -k -X GET -H "Accept: application/json" "https://your-system-name.thulium.com/api/connections?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05"

HTTPie

http -a api_user:api_pass GET https://your-system-name.thulium.com/api/connections limit==1 offset==0 date_from==2014-07-04 date_to==2014-07-05 Accept:application/json