Uwierzytelnianie | wymagane |
Format odpowiedzi | json |
Metoda HTTP | GET |
Zwraca listę zgłoszeń. Domyślnie posortowana po dacie modyfikacji od najnowszych.
Parametr count
zwraca całkowitą ilość znalezionych zgłoszeń (bez uwzględnienia limitu).
https://your-system-name.thulium.com/api/tickets
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 modyfikacji zgłoszenia.
Przykładowa wartość: 2014-07-04
|
date_to
opcjonalny |
Maksymalna data modyfikacji zgłoszenia.
Przykładowa wartość: 2014-07-14 12:34
|
create_date_from
opcjonalny |
Minimalna data utworzenia zgłoszenia.
Przykładowa wartość: 2014-07-04
|
create_date_to
opcjonalny |
Maksymalna data utworzenia zgłoszenia.
Przykładowa wartość: 2014-07-14 12:34
|
company_id
opcjonalny |
Identyfikator firmy, do której przypisane są zgłoszenia. Jeśli firma nie istnieje zgłoszenie nie zostanie znalezione.
Przykładowa wartość: 21
|
customer_id
opcjonalny |
Identyfikator klienta z CRM.
Przykładowa wartość: 32122
|
user_login
opcjonalny |
Login przypisanego użytkownika.
Przykładowa wartość: akowalski
|
source
opcjonalny |
Źródło zgłoszenia.
Przykładowa wartość: www
|
ticket_queue_id
opcjonalny |
Identyfikator kolejki zgłoszeń.
Przykładowa wartość: 2
|
category_id
opcjonalny |
Identyfikator kategorii zgłoszeń.
Przykładowa wartość: 2
|
message_id
opcjonalny |
Identyfikator wiadomości w zgłoszeniu.
Przykładowa wartość: 432
|
status_id[]
opcjonalny |
Identyfikator statusu zgłoszenia (jeden lub wiele).
Przykładowa wartość: [1, 2]
|
custom_fields
opcjonalny |
Wyszukiwanie po wartościach pól specjalnych.
Można wyszukiwać po wielu polach specjalnych na raz. Dla każdego pola można podać kilka alternatywnych wartości. Na przykład: ["custom_fields" => [ "ID" => ["1", "2"], "Uwagi" => "information" ]];Przykładowa wartość: custom_fields[ID][0]=1&custom_fields[ID][1]=2&custom_fields[Uwagi]=information
|
include_custom_fields
opcjonalny |
Czy zwracać pola specjalne zgłoszenia.
Przykładowa wartość: true
|
order
opcjonalny |
Lista pól, po których będą posortowane rezultaty. Prefiks '-' oznacza sortowanie malejące, brak prefiksu rosnące. Możliwe jest sortowanie po polach: create_date, update_date.
Przykładowa wartość: name,-customer_id,nip
|
W celu rozróżnienia typu wiadomości w zgłoszeniu, pole type jest ustawione na jedną z wartości:
|
GET | https://your-system-name.thulium.com/api/tickets?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&company_id=21&user_login=akowalski&include_custom_fields=true |
{ "count": 3, "result": [ { "ticket_id": "23962", "user_login": "akowalski", "from": "bob@test.pl", "ticket_queue_name": "help@thulium.com", "ticket_queue_id": 32, "subject": "subject", "category_id": 2, "source": "email", "status_id": "2", "substatus_id": "2", "tags": ["abc", "xyz"], "customer_id": 32122, "full_status_name": "some status - some sub status", "created_at": "2013-08-02 09:47", "updated_at": "2014-07-04 16:15", "closed_at": "2014-09-04 17:33", "close_time": "123:33:44", "first_agent_responded_at": "2014-07-04 15:15", "first_agent_response_time": "01:00:12", "messages": [ { "message_id": 432, "user_login": "", "type": "MAIL", "body": "hello", "comment": "", "system_comment": "", "created_at": "2013-08-02 09:47", "attachments": [], "ratings": [] }, { "message_id": 433, "user_login": "", "type": "MAIL", "body": "hello2", "comment": "", "system_comment": "", "created_at": "2014-07-04 16:15", "attachments": ["1175982115cb861c810534", "85734759348c94a5983b12], "ratings": [2, 3] } ], "custom_fields": { "ID": null, "Uwagi": "information" } }] }
<?php
$request = curl_init('https://your-system-name.thulium.com/api/tickets?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&company_id=21&user_login=akowalski&include_custom_fields=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);
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/tickets?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&company_id=21&user_login=akowalski&include_custom_fields=true");
System.out.println(response);
}
}
curl -u api_user:api_pass -k -X GET -H "Accept: application/json" "https://your-system-name.thulium.com/api/tickets?limit=1&offset=0&date_from=2014-07-04&date_to=2014-07-05&company_id=21&user_login=akowalski&include_custom_fields=true"
http -a api_user:api_pass GET https://your-system-name.thulium.com/api/tickets limit==1 offset==0 date_from==2014-07-04 date_to==2014-07-05 company_id==21 user_login==akowalski include_custom_fields==true Accept:application/json