Получить данные о пользователе im.user.get
Scope:
imКто может выполнять метод: любой пользователь
Метод im.user.get получает данные о текущем пользователе или о пользователе по ID.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
ID |
Идентификатор пользователя. Если не передан, метод вернет данные текущего пользователя. Получить идентификатор пользователя можно методами user.get, user.search или im.chat.user.list |
|
AVATAR_HR |
Параметр для запроса поля На текущий момент поле |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":5,"AVATAR_HR":"Y"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.user.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":5,"AVATAR_HR":"Y","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.user.get
try {
const response = await $b24.callMethod('im.user.get', {
ID: 5,
AVATAR_HR: 'Y',
});
const { result } = response.getData();
console.log(result);
} catch (error) {
console.error(error);
}
try {
$response = $b24Service->core->call(
'im.user.get',
[
'ID' => 5,
'AVATAR_HR' => 'Y',
]
);
$result = $response->getResponseData()->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
var_dump($result->data());
}
} catch (Throwable $exception) {
echo $exception->getMessage();
}
BX24.callMethod(
'im.user.get',
{
ID: 5,
AVATAR_HR: 'Y',
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.user.get',
[
'ID' => 5,
'AVATAR_HR' => 'Y',
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
var_dump($result['result']);
}
Обработка ответа
HTTP-код: 200
{
"result": {
"id": 5,
"active": true,
"name": "Иван Петров",
"first_name": "Иван",
"last_name": "Петров",
"work_position": "Менеджер",
"color": "#048bd0",
"avatar": "https://example.bitrix24.ru/upload/main/avatar.png",
"avatar_hr": "https://example.bitrix24.ru/upload/main/avatar_hr.png",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "default",
"status": "online",
"idle": false,
"last_activity_date": "2026-03-02T09:30:00+03:00",
"mobile_last_date": false,
"desktop_last_date": false,
"absent": false,
"departments": [10],
"phones": {
"work_phone": "+71234567890",
"personal_mobile": "+71234567890",
"inner_phone": "21"
},
"website": "example.ru",
"email": "user@example.ru",
"bot_data": null,
"type": "user"
},
"time": {
"start": 1760000000.0,
"finish": 1760000000.2,
"duration": 0.2,
"processing": 0.08,
"date_start": "2026-03-02T09:30:00+03:00",
"date_finish": "2026-03-02T09:30:00+03:00",
"operating_reset_at": 1760030000,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными пользователя. Структура объекта подробно описана ниже |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
id |
Идентификатор пользователя |
|
active |
Признак активности учетной записи пользователя |
|
name |
Имя и фамилия пользователя |
|
first_name |
Имя пользователя |
|
last_name |
Фамилия пользователя |
|
work_position |
Должность пользователя |
|
color |
Цвет пользователя в формате HEX |
|
Ссылка на аватар пользователя |
|
|
Ссылка на аватар высокого разрешения. На текущий момент поле возвращается всегда, независимо от значения |
|
|
gender |
Пол пользователя: |
|
birthday |
День рождения в формате |
|
extranet |
Признак экстранет-пользователя |
|
network |
Признак пользователя Битрикс24 Network |
|
bot |
Признак пользователя-бота |
|
connector |
Признак пользователя-коннектора открытых линий |
|
external_auth_id |
Идентификатор внешней авторизации |
|
status |
Статус пользователя. В новом мессенджере поле всегда содержит |
|
Время перехода в статус «Отошел» в формате ISO 8601 (RFC3339) или |
|
|
Время последней активности в формате ISO 8601 (RFC3339) или |
|
|
Время последней активности в мобильном приложении в формате ISO 8601 (RFC3339) или |
|
|
Время последней активности в десктопном приложении в формате ISO 8601 (RFC3339) или |
|
|
Дата окончания отсутствия в формате ISO 8601 (RFC3339) или |
|
|
departments |
Массив идентификаторов подразделений |
|
Телефоны пользователя или Структура объекта подробно описана ниже |
|
|
website |
Сайт пользователя или пустая строка |
|
email |
Email пользователя или пустая строка |
|
Данные бота для пользователей-ботов |
|
|
type |
Тип пользователя |
Объект phones
|
Название |
Описание |
|
personal_mobile |
Мобильный телефон |
|
work_phone |
Рабочий телефон |
|
inner_phone |
Внутренний телефон |
Обработка ошибок
HTTP-статус: 400
{
"error": "ID_EMPTY",
"error_description": "User ID can't be empty"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
User ID can't be empty |
Передан |
|
|
User is not exists |
Пользователь с указанным |
|
|
You can request only users who consist of your extranet group |
Текущий экстранет-пользователь запрашивает пользователя не из своей экстранет-группы |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить данные о списке пользователей im.user.list.get
- Установить статус пользователя im.user.status.set
- Получить статус пользователя im.user.status.get
- Включить автоматический статус «Отошел» im.user.status.idle.start
- Выключить автоматический статус «Отошел» im.user.status.idle.end