Дополнительные поля

Внимание

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

Получить список дополнительных полей

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

Метод возвращает все дополнительные поля компании

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

ПараметрЗначение
api_token*Токен API канала
Пример запроса на PHP
$data = array(
	'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
);
$mch_api = curl_init(); // initialize cURL connection

curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/ticket/fields');
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;
Пример ответа от сервера
[
	{
		"custom_field": {
			"id": "1",
			"company_id": "153561",
			"ticket_field_type_id": "2", // 1 - текс, 2 - список, 3 - чекбокс, 4 - вложенный список
			"name": "Сложность",
			"value": null,
			"required": "1", // Если поле обязательно, нельзя будет оставить ответ в запросе, не заполнив это поле
			"add_tag": "1", // При добавлении значения поля к запросу будет добавлять тег в формате :
			"add_filter": "1", // Поле добавляется в фильтр на странице \tickets
			"sort": "0", // Порядок сортировки на странице со списком полей. Чем меньше, тем выше ыыводится поле.
			"active": "1",
			"hidden": "0", // 0 - поле выводится на странице запроса в меню редактирования, 1 - не выводится.
			"api": "0", // 0 - поле можно редактировать, 1 - редактировать нельзя, т.е поле можно изменить только через api 
			"deleted": "0",
			"parent_field_id": 2078,
			"mask": "",
			"ticket_interface": 0,
			"created_at": "2016-11-25 00:00",
			"updated_at": "2016-11-25 00:00"
		},
		// Если тип поля - 2 (список), то возвращается еще список значений поля
		"field_options": [
			{
				"id": "1",
				"ticket_field_id": "1",
				"value": "Сложно"
			},
			{
				"id": "2",
				"ticket_field_id": "1",
				"value": "Очень сложно"
			},
			{
				"id": "3",
				"ticket_field_id": "1",
				"value": "Анриал"
			}
        },
        // Если тип поля - 4 (вложенный список), то возвращается массив данных, в котором содержатся 
           все актуальные id родительских значений (т.е именно тех значений, при выборе которых станет 
           доступно текущее значение текущего поля)
		"field_options": [
            {
                "id": 31584,
                "ticket_field_id": 640,
                "value": "Какаду",
                "parent_option_id": [
                    31579,
                    34532,
                    11583
                ],
                "created_at": null,
                "updated_at": null,
                "order": 1
            },
            {
                "id": 31585,
                "ticket_field_id": 640,
                "value": "Сова",
                "parent_option_id": [
                    31579
                ],
                "created_at": null,
                "updated_at": null,
                "order": 2
            }

        ]
	}
]

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

url: https://api.usedesk.ru/update/connectedList 

Deprecated (версия 1.0): Не рекомендуем использовать. Работа с вложенными списками вынесена в метод обновления запроса https://api.usedesk.ru/update/ticket

Метод позволяет изменять значения вложенных списков в дополнительных полях запроса

ПараметрЗначение
api_token Токен
ticket_id ID запроса
lists Массив вложенных списков. Каждый список представляет собой массив со значениями списка. Последовательность не важна. 
Пример запроса на PHP
$data = [
	"api_token"=> "e1cbe1c1c9d910ef2ae975215644cb53dd555de4",
	"ticket_id"=>1231231,
	"lists"=> [
		[
			["id"=>"61","value"=>"Тест"],
			["id"=>"62","value"=>"Тест1"],
			["id"=>"63","value"=>"Тест2"]
		]
	]
];
$mch_api = curl_init();

curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/update/connectedList');
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":"ok",
	"code":200
}