Получить список агентов
POST https://api.usedesk.ru/users
Внимание. Если вы используете коробочную версию Юздеска на собственном сервере, URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.
Метод возвращает список агентов компании с группами, удовлетворяющих заданным условиям фильтров.
* — обязательные поля
| Параметр | Значение |
| api_token* | Токен API канала |
| user_type |
Тип или роль пользователя Возможные значения:
Значение по умолчанию: employee |
| group_id | id группы, в которой состоит агент |
| query | Строка, по которой осуществляется поиск |
| user_id |
id агента Если передано данное поле, то будет возвращена информация об одном агенте |
Пример применения фильтров
{
'group_id':'123',
'query': 'Ivan',
'user_type': 'admin',
}
Пример запроса на PHP
$data = array(
'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
'group_id'=> 123,
'query' =>'Ivan',
'user_type'=>'admin',
);
$mch_api = curl_init(); // initialize cURL connection
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/users');
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;
Пример ответа от сервера
[
{
"id": 558,
"name": "Agent Name",
"email": "agent@gmail.com",
"position": "Тестировщик",
"role": "admin",
"phone": null,
"online_status": "0",
"avatar": "https://api.usedesk.ru/upload/avatars/123454tykhj;uy94639526783940569584736524ehn5",
"chat_online_status": "1",
"groups": [
{
"id": 123,
"name": "группа",
"company_id": 153561,
"deleted": 0,
"deleted_at": "0000-00-00 00:00:00",
"custom_working_time": 0,
"timezone": "Europe/Moscow",
"pivot": {
"user_id": 558,
"user_group_id": 413
}
},
{
"id": 354,
"name": "Группа 2",
"company_id": 153561,
"deleted": 0,
"deleted_at": "0000-00-00 00:00:00",
"pivot": {
"user_id": 558,
"user_group_id": 354
}
},
{
"id": 127,
"name": "Группа 4",
"company_id": 153561,
"deleted": 0,
"deleted_at": "0000-00-00 00:00:00",
"pivot": {
"user_id": 558,
"user_group_id": 127
}
},
{
"id": 415,
"name": "группа тест 3",
"company_id": 153561,
"deleted": 0,
"deleted_at": "0000-00-00 00:00:00",
"pivot": {
"user_id": 558,
"user_group_id": 415
}
}
]
}
]
Параметры ответа от сервера
| Параметр | Описание | ||||||||||||||||||||||
| id | ID агента | ||||||||||||||||||||||
| name | Имя агента | ||||||||||||||||||||||
| Email агента | |||||||||||||||||||||||
| position | Должность агента | ||||||||||||||||||||||
| role | Роль агента | ||||||||||||||||||||||
| phone | Телефон агента | ||||||||||||||||||||||
| online_status | Онлайн-статус агента в запросах | ||||||||||||||||||||||
| avatar | URL аватара агента | ||||||||||||||||||||||
| chat_online_status | Онлайн-статус агента в чатах | ||||||||||||||||||||||
| groups | Массив групп, в которых состоит агент
|