Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP GET

GET chats

Ostatnia modyfikacja 2018-12-06 15:52:34

Zwraca listę czatów.

Parametr count zwraca całkowitą liczbę znalezionych czatów (bez uwzględnienia limitu).

URL

https://api.thulium.pl/api/chats

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 rozpoczęcia czata. Przykładowa wartość: 2014-07-04
date_to

opcjonalny

Maksymalna data rozpoczęcia czata. Przykładowa wartość: 2014-07-14 12:34
status

opcjonalny

Status czata. Przykładowa wartość: CLOSED
chat_queue_id

opcjonalny

Identyfikator kolejki czata. Przykładowa wartość: 3

Uwagi

Pole status może przyjmować następujące wartości:
  • CREATED - czat został rozpoczęty przez klienta
  • IN_PROGRESS - czat jest w trakcie (co oznacza, że agent odpisał na czat)
  • CLOSED - czat został zakończony

Przykładowy request

GET https://api.thulium.pl/api/chats?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&status=CLOSED

Przykładowy response

{
   "count": 3,
   "result": [
       {
            "chat_queue_id": 3,
            "client_email": "andrzej.nowak@company.bar",
            "client_name": "Andrzej Nowak",
            "customer_id": 2,
            "conversation_id": "6ed7c941-2c8a-411e-95d2-338a9f64800a",
            "created_at": "2017-12-11 10:23:04.318",
            "status": "CLOSED",
            "user_login": "jkowalski"
       }
   ]
}

Przykładowe wywołanie


PHP

<?php
$request 
curl_init('https://api.thulium.pl/api/chats?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&status=CLOSED');
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://api.thulium.pl/api/chats?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&status=CLOSED");
        System.out.println(response);
    }
}

CURL

curl -u api_user:api_pass -k -X GET -H "Accept: application/json" "https://api.thulium.pl/api/chats?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&status=CLOSED"