Обновить запрос

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

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

С помощью метода можно изменить существующий запрос.

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

Параметр Значение
api_token* Токен api канала
ticket_id* id запроса
subject Тема запроса
client_id Id клиента
Если установлен, то запрос привяжется к указанному клиенту
group_id

Id группы

  • Если указан, то запрос будет назначен на указанную группу
  • Если в group_id передан "null", будет присвоено значение "Не назначена"
assignee_id

Id юзера, который будет назначен исполнителем

Варианты использования:

  • передан group_id и агент есть в этой группе — назначение будет в рамках указанной группы
  • указан неверный id — система вернёт ошибку
  • если в assignee_id передан "null", будет присвоено значение "Не назначен"
user_id Id юзера, от лица которого будут произведены изменения
tag

Теги

Строка (255 символов), которая содержит теги, разделенные запятыми с пробелом

priority Приоритет запроса
Строка (10 символов)
Возможные значения:


  • low — низкий;
  • medium — средний;
  • urgent — высокий;
  • extreme — экстремальный.
По умолчанию: medium

status

Статус запроса

Принимает число, которое соответствует идентификатору статуса в системе.

Возможные значения указаны тут

silent

Параметр, который позволяет указать, должно ли выполнение текущего API-запроса автоматически поменять статус запроса.

По умолчанию, если запрос находится в статусе «Новый», любое действие с ним автоматически меняет статус на «Открыт», чтобы показать, что он был каким-то образом обработан и уже не является новым.

Для отмены автоматической смены статуса в параметре «silent» укажите значение «true» или «1».

Чтобы вернуть поведение по умолчанию, параметр можно не указывать в запросе, либо передать в нём значения «false», «0» или пробел

type Тип запроса
Строка (10 символов)
Возможные значения:


  • question — вопрос;
  • task — задача;
  • problem — проблема;
  • incident — инцидент.
field_id

Строка, которая содержит идентификаторы дополнительных полей

Идентификаторы дополнительных полей можно получить двумя способами:

1) В Юздеске перейти в Настройки → Дополнительные поля. ID будет указан рядом с названием поля;

2) С помощью API, метод «Получить список дополнительных полей».

Строка (255 символов), разделяются точкой с запятой(;).

field_value

Строка, которая содержит значения дополнительных полей, разделенные точкой с запятой (;)

  • Для текстовых полей значение не должно превышать 255 символов
  • Для чекбокс полей – true/false
  • Для лист полей – id варианта

Возможные значения чекбокс и лист полей можно получить с помощью метода «Получить список дополнительных полей».

Пример строки в которой передаются 3 значения: "любое значение;true;93"

lists

Редактирование вложенных списков.

Массив, содержащий параметры:

  • id — id поля
  • value — значение поля

Важно соблюдать структуру вложенных списков. Это значит, что для изменения значения поля второго уровня нужно обязательно передать значение первого уровня

Для очистки поля используйте пустое значение или null


Пример запроса
{
    'ticket_id': '123',
    'subject': 'Письмо',
    'field_id': '10;12;9',
    'field_value': 'любое значение;true;93',
    'lists': [
        [ 
            {
                "id": 1347,
                "value": "1"
            }, 
            {
                "id": 1348,
                "value": "22"
            }
         ]
     ]
}
        

Пример запроса на PHP
$data = array(
    'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
    'client' => "JON",
    'email' => "jon@bonjovi.com",
    'message' => "Hello World",
    'subject' => 'First msg',
    'client_id' => 'new_client',
    'ticket_id'=>'2154827',
    'priority'  => 'medium',
    'type'=>'task'
    'status'  => '2',
    'subject'  => 'POST UPDATE',
    'field_id'=> '10;12;9',
    'field_value'=> 'любое значение;true;93'
);
$mch_api = curl_init(); 
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/update/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;
        


При успешном запросе сервер вернёт сообщение об успешном обновлении запроса.

Пример ответа от сервера
{
    "status":"success"
}