Задача
Получим информацию о пользователе Иванове Петре Семеновиче, id которого равен 583427
Решение
GET https://apigw.intradesk.ru/taskform/api/users/583427/info/short?ApiKey=65247DBDE14C45A6A275DC1FC0
Ответ сервера:
{
"userType": 10, //тип пользователя, 10 – сотрудник, 20 – клиент
"id": 583427, // идентификатор пользователя
"name": "Иванов Петр Семенович ", // имя пользователя, состоит из фамилии, имени и отчества
"email": "ips@intra5.ru", // электронная почта
"additionalEmails": "[\"mysupport@mail.ru\"]", // массив дополнительных адресов электронных почт
"phoneNumbers": [ // массив телефонных номеров
{
"phoneNumber": "+78001234567", //номер телефона
"default": true, //признак того, что это основной номер пользователя
"phoneExt": null, //добавочный номер
"phoneInternational": "+7 800 123-45-67" //номер телефона в международном формате
},
{
"phoneNumber": "+78009876543",
"default": false,
"phoneExt": null,
"phoneInternational": "+7 800 987-65-43"
}
],
"activeTaskNumber": null, // номер активной заявки, если такая есть в данный момент
"activeTaskStartTime": null, // начало выполнение активной заявки, если такая есть
"groups": "[{\"id\" : 176287, \"name\" : \"Администраторы\", \"type\" : 30, \"isdefault\" : false}]", //сериализованный массив объектов, описывающий в каких группах состоит пользователь
"tags": " Информирование, Массовый инцидент ", //строка с тегами пользователя
"userFields": "[{\"Name\": \"Режим\", \"Type\": 3, \"Value\": \"2\"}]", //сериализованный массив объектов, описывающий значения настраиваемых полей пользователей
"emailConfirmed": false //признак, подтверждена ли электронная почта
}
Полная документация к методу в формате swagger (TaskForm API)
Задача
Получим информацию о компании "Второе бюро", Id которой равен 583427
Решение
GET https://apigw.intradesk.ru/taskform/api/clientcompanys/31972?ApiKey=65247DBDE14C45A6A275DC1FC0
Ответ сервера:
{
"id": 176282, // идентификатор компании
"name": "Второе бюро", //имя компании
"description": "", //описание компании
"additionalInfo": "дополнительная информация", //дополнительная информация
"domains": "[\"maintech\"]", //массив доменов компании
"address": "ул. Ленина 30б", //адрес компании
"web": "", //сайт компании
"phoneNumbers": [ //массив телефонных номеров
{
"phoneNumber": "+78001234567", //номер телефона
"default": true, //признак того, что это основной номер компании
"phoneExt": null, //добавочный номер
"phoneInternational": "+7 800 123-45-67" //номер телефона в международном формате
},
{
"phoneNumber": "+74992342134",
"default": false,
"phoneExt": null,
"phoneInternational": "+7 499 234-21-34"
}
],
"email": "", // электронная почта
"tags": "Информирование", //теги, которыми отмечена компания
"companyFields": "[{\"Name\": \"Режим\", \"Type\": 3, \"Value\": \"two\"}]", //значения доп. полей компании
"groupType": 10, //тип группы. 10 – компания(клиентская), 20 – группа сотрудников
"users": [ //пользователи в текущей группе
{
"id": 583440,
"name": "Иванов Николай Алексеевич "
}
]
}
Полная документация к методу в формате swagger (TaskForm API)
Задача
Установим пользователя-исполнителя с id равным 583437 и группу исполнителей с id равным 176284.
Номер изменяемой заявки = 35 (это значение получили в ответе на запрос создания заявки)
Решение
PUT https://apigw.intradesk.ru/changes/tasks?ApiKey=65247DBDE14C45A6A275DC1FC0
Тело запроса:
{
"number": 35,
"blocks": {
"executor": "{\"value\":{\"userid\":583437,\"groupid\":176284}}"
}
}
Ответ сервера:
Получаем статус ответа 200, значит изменение прошло успешно. В теле ответа поступили данные о заявке.
Полная документация к методу в формате swagger (ChangeService API)
Задача
Получим исполнителей, имя которых содержит подстроку «менедж», за исключение группы с id 61276 и за исключением пользователя с id 583432
Решение
GET https://apigw.intradesk.ru/hints/api/hints/executors?ApiKey=65247DBDE14C45A6A275DC1FC0&str=мен&excludeUserIds=583432&excludeGroupIds=61276
Ответ сервера:
[
{
"id": 583433, //идентификатор пользователя
"name": "Менеджер ночной смены", //имя пользователя
"hasgroupid": false, //признак того, что сотрудник состоит в группе, указанной в параметре "groupId"
"highlight": "[{\"field\":\"searchstring.standard\",\"value\":[\" Менеджер ночной смены nm@intra5\"]}]",
"type": 1, //тип, 1 - пользователь, 2 - группа
"isclient": false,
"isArchived": false //признак того, что пользователь удален (в архиве)
},
{
"id": 176286, //идентификатор группы
"name": "Группа Менеждеров", //имя группы
"hasgroupid": false, //признак того, что группа указана в параметре "groupId"
"highlight": "[{\"field\":\"searchstring.standard\",\"value\":[\"Группа Менеджеров \"]}]",
"type": 2, //тип, 1 - пользователь, 2 - группа
"isclient": false,
"isArchived": false //признак того, что группа удалена (в архиве)
}
]
Полная документация к методу в формате swagger (Hints API)
Другие возможные параметры
"str" - поисковая строка
"excludeUserIds" - в результатах поиска исключает указанные идентификаторы пользователей
"excludeGroupIds" - в результатах поиска исключает указанные идентификаторы групп сотрудников
"groupId" - идентификатор группы текущего назначенного Исполнителя пользователя (для поиска пользователей только внутри этой группы)
"top" - количество результатов в выдаче. По умолчанию 7