Получить список участников im.dialog.users.list

Scope: im

Кто может выполнять метод: пользователь с доступом к чату

Метод im.dialog.users.list возвращает подробную информацию об участниках диалога с поддержкой пагинации.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
DIALOG_ID* `string`	Идентификатор чата в формате: `chatXXX` — чат `sgXXX` — чат группы или проекта `XXX` — идентификатор пользователя личного чата Идентификатор чата можно получить с помощью метода im.chat.get. Идентификатор пользователя — с помощью методов user.get и user.search
SKIP_EXTERNAL `string`	Исключить системных пользователей: `Y` — исключить `N` — не исключать По умолчанию: `N`
SKIP_EXTERNAL_EXCEPT_TYPES `string`	Список типов системных пользователей, которых нужно оставить в выборке, через запятую. Например: `bot, email`
LIMIT `integer`	Количество элементов на страницу. По умолчанию: `50`. Максимальное значение: `200`
LAST_ID `integer`	Идентификатор последнего пользователя из выборки `LIMIT`. Используется для последовательной загрузки списка
OFFSET `integer`	Смещение для постраничной выборки. По умолчанию: `0`

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DIALOG_ID":"chat2935","SKIP_EXTERNAL":"Y","LIMIT":20,"OFFSET":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.dialog.users.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"DIALOG_ID":"chat2935","SKIP_EXTERNAL":"Y","LIMIT":20,"OFFSET":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/im.dialog.users.list

try
        {
            const response = await $b24.callMethod(
                'im.dialog.users.list',
                {
                    DIALOG_ID: 'chat13',
                    SKIP_EXTERNAL: 'Y',
                    LIMIT: 20,
                    start: 0
                }
            );
        
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.dialog.users.list',
                    [
                        'DIALOG_ID' => 'chat2935',
                        'SKIP_EXTERNAL' => 'Y',
                        'LIMIT' => 20,
                        'OFFSET' => 0
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving dialog users list: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.dialog.users.list',
            {
                DIALOG_ID: 'chat2935',
                SKIP_EXTERNAL: 'Y',
                LIMIT: 20,
                OFFSET: 0
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.dialog.users.list',
            [
                'DIALOG_ID' => 'chat2935',
                'SKIP_EXTERNAL' => 'Y',
                'LIMIT' => 20,
                'OFFSET' => 0
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                "id": 1269,
                "active": true,
                "name": "Александр Смирнов",
                "first_name": "Александр",
                "last_name": "Смирнов",
                "work_position": "Руководитель отдела продаж",
                "color": "#58cc47",
                "avatar": "https://cdn-ru.bitrix24.ru/avatars/alexander-smirnov.png",
                "avatar_hr": "https://cdn-ru.bitrix24.ru/avatars/alexander-smirnov@2x.png",
                "gender": "M",
                "birthday": "",
                "extranet": false,
                "network": false,
                "bot": false,
                "connector": false,
                "external_auth_id": "socservices",
                "status": "online",
                "idle": false,
                "last_activity_date": "2026-03-02T17:45:59+03:00",
                "mobile_last_date": false,
                "desktop_last_date": false,
                "absent": false,
                "departments": [1],
                "phones": {
                    "personal_mobile": "79165554419"
                },
                "bot_data": null,
                "type": "user",
                "website": "",
                "email": "a.smirnov@example.ru"
                },
                {
                "id": 99,
                "active": true,
                "name": "Екатерина Иванова",
                "first_name": "Екатерина",
                "last_name": "Иванова",
                "work_position": "Бизнес-аналитик",
                "color": "#58cc47",
                "avatar": "https://cdn-ru.bitrix24.ru/avatars/ekaterina-ivanova.png",
                "avatar_hr": "https://cdn-ru.bitrix24.ru/avatars/ekaterina-ivanova@2x.png",
                "gender": "F",
                "birthday": "",
                "extranet": false,
                "network": false,
                "bot": false,
                "connector": false,
                "external_auth_id": "socservices",
                "status": "online",
                "idle": false,
                "last_activity_date": "2026-03-02T17:44:31+03:00",
                "mobile_last_date": false,
                "desktop_last_date": false,
                "absent": false,
                "departments": [121],
                "phones": false,
                "bot_data": null,
                "type": "user",
                "website": "",
                "email": "e.ivanova@mail.ru"
                },
                {
                "id": 1271,
                "active": true,
                "name": "Дмитрий Кузнецов",
                "first_name": "Дмитрий",
                "last_name": "Кузнецов",
                "work_position": "Старший разработчик",
                "color": "#df532d",
                "avatar": "https://cdn-ru.bitrix24.ru/avatars/dmitry-kuznetsov.png",
                "avatar_hr": "https://cdn-ru.bitrix24.ru/avatars/dmitry-kuznetsov@2x.png",
                "gender": "M",
                "birthday": "",
                "extranet": false,
                "network": false,
                "bot": false,
                "connector": false,
                "external_auth_id": "socservices",
                "status": "online",
                "idle": false,
                "last_activity_date": "2026-03-02T17:45:02+03:00",
                "mobile_last_date": false,
                "desktop_last_date": false,
                "absent": false,
                "departments": [1],
                "phones": false,
                "bot_data": null,
                "type": "user",
                "website": "",
                "email": "d.kuznetsov@mail.ru"
                }
            ],
            "total": 3,
            "time": {
                "start": 1772477165,
                "finish": 1772477165.266759,
                "duration": 0.26675891876220703,
                "processing": 0,
                "date_start": "2026-03-02T17:46:05+03:00",
                "date_finish": "2026-03-02T17:46:05+03:00",
                "operating_reset_at": 1772477765,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `array`	Массив объектов с данными участников диалога
total `integer`	Общее количество участников, доступных текущему пользователю
next `integer`	Смещение следующей страницы результатов. Возвращается, если есть следующая страница
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
id `integer`	Идентификатор пользователя
active `boolean`	Признак активности пользователя
name `string`	Имя и фамилия пользователя
first_name `string`	Имя пользователя
last_name `string`	Фамилия пользователя
work_position `string`	Должность пользователя. Может быть `null`
color `string`	Цвет пользователя в формате HEX
avatar `string`	Ссылка на аватар. Если пусто, аватар не задан
avatar_hr `string`	Ссылка на аватар высокого разрешения
gender `string`	Пол пользователя
birthday `string`	День рождения в формате `DD-MM` или пустая строка
extranet `boolean`	Признак внешнего экстранет-пользователя
network `boolean`	Признак пользователя Битрикс24.Network
bot `boolean`	Признак бота
connector `boolean`	Признак пользователя открытых линий
external_auth_id `string`	Код внешней авторизации
status `string`	Статус пользователя
idle `datetime`	Дата, когда пользователь отошел от компьютера. Если не задано, `false`
last_activity_date `datetime`	Дата последней активности пользователя
mobile_last_date `datetime`	Дата последней активности в мобильном приложении. Если не задано, `false`
desktop_last_date `datetime`	Дата последней активности в десктоп-приложении. Если не задано, `false`
absent `datetime`	Дата отпуска пользователя. Если не задано, `false`
departments `array`	Список идентификаторов отделов пользователя
phones `object`	Контактные телефоны пользователя. Может быть `false`
bot_data `object`	Данные бота. Для обычного пользователя может быть `null`
type `string`	Тип пользователя
website `string`	Сайт пользователя
email `string`	Email пользователя

Объект phones

Название `тип`	Описание
work_phone `string`	Рабочий телефон
personal_mobile `string`	Мобильный телефон
personal_phone `string`	Домашний телефон

Обработка ошибок

HTTP-статус: 400, 403

{
            "error": "DIALOG_ID_EMPTY",
            "error_description": "Dialog ID can't be empty"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`DIALOG_ID_EMPTY`	Dialog ID can't be empty	Не передан или передан некорректный `DIALOG_ID`
`ACCESS_ERROR`	You do not have access to the specified dialog	Нет доступа к указанному диалогу
`ACCESS_ERROR`	You don't have access to this chat	Нет доступа к указанному чату

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Получить идентификаторы участников чата

Исключить участников из чата

Получить список участников im.dialog.users.list

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект resultОбъект result

Объект phonesОбъект phones

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение