Отдельный запрос

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

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

Метод возвращает запрос по указанному id. Принимает один id запроса.

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

Параметр Значение
api_token* Токен api канала
ticket_id* Идентификатор запроса
accessible_for_agent_id

Фильтрация по id агента

Учитывает права сотрудника.

Сервер возвращает переменную rights:

  • write — если есть доступ работы с запросом в текущем канале;
  • read — если есть доступ просмотра запроса в текущем канале.
properties

Передача времени до наступления SLA

"properties": ["sla"]

  • first_reply — время первого ответа;
  • next_reply — время следующего ответа;
  • close — время до выполнения.

Если SLA не заданы в запросе, то SLA не возвращается в ответе

Пример запроса
$data = array(
        'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
        'accessible_for_agent_id'=>'6339',
        'ticket_id'=>'2261648'
);
$mch_api = curl_init(); 
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/ticket');
curl_setopt($mch_api, CURLOPT_USERAGENT, 'PHP-MCAPI/2.0');
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":{
        "id": 2265179,
        "status_id": 1,
        "priority": "medium",
        "type": "problem",
        "subject": "Ошибка с доп полями",
        "client_id": 261702,
        "assignee_id": 2,
        "group": 0,
        "last_updated_at": "2017-03-01 14:30:49",
        "email": "vlasch@gmail.com",
        "published_at": "2017-03-01 14:30:49",
        "company_id": 153561,
        "channel_id": 22
        "additional_id": "32"
        "client_name": "Лащук Василий",
        "active_sla": [
            {
            "type": "close",
            "date": "2021-04-29 10:35:04"
            },
            {
            "type": "first_reply",
            "date": "2021-04-28 18:01:08"
            }
         ],
        "comments":[
           {
            "id": 2658287,
            "message": "доп поля",
            "from": "client",
            "type": "public",
            "user_id": null,
            "client_id": 261702,
            "client_name": "Василий Лащук",
            "ticket_id": 2265179,
            "is_first": 0,
            "delivered": 0,
            "readed": 0,
            "published_at": "2017-03-01 14:30:49",
            "file": 129169,
            "files": [
                {
                    "name": "44029855d283e98131fc.jpg",
                    "type": "image/jpeg",
                    "file": "https://devsecure.usedesk.ru/files/153561/3403684/get-url-comment-files/YmxwdGVHcFRkMVp4VjFoNFVVcEZVVEY2YzA4elp6MDlPanEybDlWVkhNNU1vTS8zWWliNzZqeEY="
                 }
            ]
            "bcc": [
                    "shy@usedesk.ru",
                    "test@usedesk.ru"
            ]
            "cc": [
                    "shy123@usedesk.ru",
                    "test123@usedesk.ru"
            ]
        }
    ],
    "changes": [
        {
            "id": 213671,
            "trigger_id": 1260,
            "user_id": null,
            "ticket_id": 2265179,
            "data":[
                {
                    "target": "assignee",
                    "value": "2"
                }
            ],
            "changed_at": "2017-03-01 14:30:49",
            "old_status": 0,
            "new_status": 2,
            "company_id": 153561
        },
        {
            "id": 213669,
            "trigger_id": null,
            "user_id": null,
            "ticket_id": 2265179,
            "data": [],
            "changed_at": "2017-03-01 14:30:49",
            "old_status": 0,
            "new_status": 1,
            "company_id": 153561
        }
    ],
    "tags": [
        "Важный",
        "Холодный лид"
    ],
    "custom_fields": [
        {
            "id": 143,
            "ticket_id": 2265179,
            "ticket_field_id": 10,
            "value": "134"
        },
        {
            "id": 145,
            "ticket_id": 2265179,
            "ticket_field_id": 7,
            "value": "1"
        },
        {
            "id": 147,
            "ticket_id": 2265179,
            "ticket_field_id": 9,
            "value": "9"
        }
    ]
            "rights": "write",
}
            

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

ПараметрОписание
id
ID запроса
status_id ID статуса запроса
priority Приоритет запроса
type Тип запроса
subject Тема запроса
client_id ID клиента
assignee_id ID ответственного агента
group ID группы
last_updated_at Дата и время последнего обновления запроса
Часовая зона UTC+0
email Email, по которому пришел запрос
Указан, если запрос был создан в почтовом канале
published_at Дата и время создания запроса
Часовая зона UTC+0
company_id ID компании
channel_id ID канала
additional_id Дополнительный идентификатор
Служебное поле
client_name Имя клиента
active_sla Массив текущих SLA у запроса
  • type — тип;
    • close — SLA до закрытия;
    • first_reply — SLA первого ответа;
  • date — Дата и время истечения SLA
comments Массив комментариев запроса

ПараметрОписание
idID комментария
messageТекст комментария
fromОт чьего лица был на писан комментарий


  • user — агент;
  • client — клиент
typeТип запроса
user_idID агента, который оставил комментарий
client_idID клиента, который оставил комментарий
client_nameИмя клиента
ticket_idID запроса
is_firstФлаг, обозначающий первый комментарий в запросе
deliveredФлаг, обозначающий доставку комментария
readedФлаг, обозначающий прочитанность комментария
published_atДата и время создания комментария
Временная зона UTC+0
fileID файла
filesМассив вложенных файлов


  • name — имя файла
  • type — тип файла
  • file — ссылка на загрузку
bccМассив адресов скрытых копий
ccМассив адресов открытых копий
changes Массив изменений запроса

ПараметрОписание
idID изменения
trigger_idID правила, которое вызвало изменение запроса
user_idID пользователя, который вызвал изменение запроса
ticket_idID запроса
dataСодержимое изменения


  • target — цель изменения
  • old_value — старое значение
  • value — новое значение
changed_atДата и время изменения,
Временная зона UTC+0
old_statusID статуса запроса до изменения
new_statusID статуса запроса после изменения
company_idID компании
tags Массив тегов запроса
custom_fields Массив со значениями дополнительных полей в запросе
  • ticket_field_id — ID дополнительного поля запроса;
  • ticket_id — ID запроса;
  • value — значение дополнительного поля.
rights Права указанного сотрудника
  • write — если есть доступ работы с запросом в текущем канале;
  • read — если есть доступ просмотра запроса в текущем канале.