Получить список тегов

POST https://api.usedesk.ru/tags

Внимание. Если вы используете коробочную версию Юздеска на собственном сервере, URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.

Метод возвращает список тегов.

В методе реализована постраничная разбивка. В ответе максимум 100 записей, для смещения используется параметр offset.

* — обязательные поля

api_token* Токен API канала
offset

Смещение

Не принимает значение null

Смещение на 1 покажет следующие 100 записей

query Поисковая строка
Поиск осуществляется по тексту тега.

Пример запроса на PHP
$data = array(
    'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
    'offset'=>0,
);
$mch_api = curl_init(); // initialize cURL connection
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/tags');
curl_setopt($mch_api, CURLOPT_RETURNTRANSFER, true);
curl_setopt($mch_api, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($mch_api, CURLOPT_TIMEOUT, 10);
curl_setopt($mch_api, CURLOPT_POST, true);
curl_setopt($mch_api, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($mch_api, CURLOPT_POSTFIELDS, $data);
$result = curl_exec($mch_api);
return $result;
                                                

Пример ответа от сервера
[
    {
        "ticket_tag_id":130,
        "tag_company_id":153909,
        "name":"tag1",
        "ticket_count":2
    },
    {
        "ticket_tag_id":374,
        "tag_company_id":153909,
        "name":"example",
        "ticket_count":25
    }
]
                                                

Параметры ответа от сервера

ПараметрЗначение
ticket_tag_idID тега
tag_company_idID компании
nameЗначение тега
ticket_countКоличество запросов с соответствующим тегом