Просмотров: 10952
Дата последнего изменения: 18.07.2022
Сложность урока:
3 уровень - средняя сложность. Необходимо внимание и немного подумать.
4
5
Получение списка руководителей подразделений
Ревизия
Получить информацию о текущей ревизии API (версии платформы) – im.revision.get
: 18
Обратите внимание! Метод указан с использованием функции
restCommand - это метод отправки данных в
Битрикс24 , данный метод есть в примере
ЭхоБота , и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод
BX24.callMethod или
bitrix24-php-sdk .
Примечание : Метод
im.department.managers.get доступен только для
интранет-пользователей
В Битрикс24 различают два вида пользователей:
интранет-пользователи – внутренние пользователи (сотрудники Вашей компании);
экстранет-пользователи – внешние пользователи (поставщики, дистрибьюторы и т.п.).
Подробнее о возможностях интранет и экстранет пользователей ...
.
Параметры
Параметр
Пример
Обязат.
Описание
Ревизия
ID
[105]
Да
Идентификаторы подразделений
19
USER_DATA
N
Нет
Подгружать данные о пользователях
19
Если передан параметр USER_DATA = Y
, то в ответе вместо массива идентификаторов будет передан массив объектов с информацией о пользователе.
Вызов метода и ответ
JavaScript
BX24.callMethod('im.department.managers.get', {USER_DATA: 'Y'}, function(result){
if(result.error())
{
console.error(result.error().ex);
}
else
{
console.log('users', result.data());
}
});
PHP
$result = restCommand('im.department.managers.get', Array(
'USER_DATA' => 'Y'
), $_REQUEST["auth"]);
Пример ответа
При опции USER_DATA = N
:
{
"result": {
105: [1]
},
}
При опции USER_DATA = Y
:
{
"result": {
105: {
"id": 1,
"name": "Евгений Шеленков",
"first_name": "Евгений",
"last_name": "Шеленков",
"work_position": "",
"color": "#df532d",
"avatar": "http://192.168.2.232/upload/resize_cache/main/1d3/100_100_2/shelenkov.png",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "default",
"status": "online",
"idle": false,
"last_activity_date": "2018-01-29T17:35:31+03:00",
"desktop_last_date": false,
"mobile_last_date": false,
"departments": [
50
],
"absent": false,
"phones": {
"work_phone": "",
"personal_mobile": "",
"personal_phone": ""
}
}
}
}
Описание ключей :
id
– идентификатор пользователя
name
– имя и фамилия пользователя
first_name
– имя пользователя
last_name
– фамилия пользователя
work_position
– должность
color
– цвет пользователя в формате hex
avatar
– ссылка на аватар (если пусто, значит аватар не задан)
gender
– пол пользователя
birthday
– день рождения пользователя в формате DD-MM, если пусто – не задан
extranet
– признак внешнего экстранет-пользователя (true/false
)
network
– признак пользователя Битрикс24.Network (true/false
)
bot
– признак бота (true/false
)
connector
– признак пользователя открытых линий (true/false
)
external_auth_id
– код внешней авторизации
status
– выбранный статус пользователя
idle
– дата, когда пользователь отошел от компьютера, в формате АТОМ (если не задано, false
)
last_activity_date
– дата последнего действия пользователя в формате АТОМ
mobile_last_date
– дата последнего действия в мобильном приложении в формате АТОМ (если не задано, false
)
desktop_last_date
– дата последнего действия в десктопном приложении в формате АТОМ (если не задано, false
)
absent
– дата, по какое число у пользователя отпуск, в формате АТОМ (если не задано, false
)
phones
– массив номеров телефонов: work_phone
– рабочий телефон, personal_mobile
– мобильный телефон, personal_phone
– домашний телефон
Пример ответа при возникновении ошибки
{
"error": "ID_EMPTY",
"error_description": "Department ID can't be empty"
}
Описание ключей :
error
– код возникшей ошибки
error_description
– краткое описание возникшей ошибки
Возможные коды ошибок
Код
Описание
ID_EMPTY
Не передан список идентификаторов