Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP GET

GET chats

Ostatnia modyfikacja 2024-11-20 13:20:36

Zwraca listę czatów.

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

URL

https://your-system-name.thulium.com/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
include_messages

opcjonalny

Dołącz listę wiadomości. Może przyjąć wartość true/false, domyślnie false. Przykładowa wartość: false
include_files

opcjonalny

Dołącz listę plików. Może przyjąć wartość true/false, domyślnie false. Przykładowa wartość: false
include_client_data

opcjonalny

Dołącz dane klienta (np. przeglądarka, adres IP). Może przyjąć wartość true/false, domyślnie false. Przykładowa wartość: false

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
W polu sent_by zwracany jest autor wiadomości. Przyjmuje jedną z wartości:
  • USER - wiadomość napisana przez agenta
  • CLIENT - wiadomość napisana przez klienta
  • AUTO - wiadomość systemowa

Przykładowy request

GET https://your-system-name.thulium.com/api/chats?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&status=CLOSED&include_messages=true&include_files=true&include_client_data=true

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",
            "closed_at": "2017-12-11 11:21:05.221",
            "status": "CLOSED",
            "user_login": "jkowalski",
            "rating": 1,
            "messages": [
                {
                    "date": "2020-01-01 11:02:03",
                    "message": "Dzień dobry!",
                    "sent_by": "USER",
                    "user_name": "Jan Kowalski",
                    "user_login": "jkowalski"
                },
                {
                    "date": "2020-01-01 11:02:46",
                    "message": "Dzień dobry, mam pytanie odnośnie produktu",
                    "sent_by": "CLIENT",
                    "user_name": null,
                    "user_login": null
                },
                {
                    "date": "2020-01-01 11:02:56",
                    "message": "Jakiego konkretnie?",
                    "sent_by": "USER",
                    "user_name": "Jan Kowalski",
                    "user_login": "jkowalski"
                }
            ],
            "files": [
                {
                    "date": "2023-09-06 15:33:29",
                    "token": "188164338364f87fa936e48",
                    "sent_by": "CLIENT",
                    "user_name": null,
                    "user_login": null
                }
            ],
            "client_data": {
                "browser": "Chrome 96.0.4664",
                "ip": "127.0.0.1",
                "last_visited_url": "https://thulium.com",
                "os": "Linux",
                "referrer": "",
                "resolution": "1920x1080"
            }
       }
   ]
}

Przykładowe wywołanie


PHP 

<?php
$request = curl_init('https://your-system-name.thulium.com/api/chats?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&status=CLOSED&include_messages=true&include_files=true&include_client_data=true');
curl_setopt($request, CURLOPT_HTTPHEADER, array('Content-Type: application/json; charset=utf-8'));
curl_setopt($request, CURLOPT_USERPWD, "api_user:api_pass");
curl_setopt($request, CURLOPT_TIMEOUT, 30);
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($request);
if ($response) {
    $httpCode = curl_getinfo($request, CURLINFO_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/chats?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&status=CLOSED&include_messages=true&include_files=true&include_client_data=true");
        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/chats?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&status=CLOSED&include_messages=true&include_files=true&include_client_data=true"

HTTPie 

http -a api_user:api_pass GET https://your-system-name.thulium.com/api/chats limit==1 offset==0 date_from==2014-07-04 date_to==2014-07-05 status==CLOSED include_messages==true include_files==true include_client_data==true Accept:application/json