Получить список групп агентов
POST https://api.usedesk.ru/groups
Внимание. Если вы используете коробочную версию Юздеска на собственном сервере, URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.
Метод возвращает список групп и агентов, состоящих в них.
* — обязательные поля.
|
Параметр
|
Значение
|
|---|---|
| api_token* | Токен API канала |
Пример запроса на PHP
$data = array(
'api_token'=> 'e1cbe1c1c9d910ef2ae975215644cb53dd555de4',
);
$mch_api = curl_init();
curl_setopt($mch_api, CURLOPT_URL, 'https://api.usedesk.ru/groups');
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": 354,
"name": "Группа 2",
"company_id": 153561,
"deleted": 0,
"deleted_at": "0000-00-00 00:00:00",
"custom_working_time": 0,
"timezone": "Europe/Moscow",
"users": [
{
"id": 568,
"name": "agent1",
"email": "agent1@usedesk.ru",
"position": "",
"role": "admin",
"phone": null,
"pivot": {
"user_group_id": "354",
"user_id": "568"
}
},
{
"id": "558",
"name": "Agent2",
"email": "agent2@gmail.com",
"position": "",
"role": "employee",
"phone": null,
"avatar": "https://api.usedesk.ru/upload/avatars/123454tykhj;uy94639526783940569584736524ehn5",
"pivot": {
"user_group_id": 354,
"user_id": 558
}
}
]
},
]
Параметры ответа от сервера
| Параметр | Значение | ||||||||||||||||||||||
| id | ID группы | ||||||||||||||||||||||
| name | Название группы | ||||||||||||||||||||||
| company_id | ID компании | ||||||||||||||||||||||
| deleted | Флаг, обозначающий удаление группы | ||||||||||||||||||||||
| deleted_at | Дата удаления группы | ||||||||||||||||||||||
| custom_working_time | Флаг, обозначающий время работы группы, отличающееся от времени работы компании | ||||||||||||||||||||||
| timezone | Часовой пояс группы | ||||||||||||||||||||||
| users | Данные о составе группы
|