метод REST scope: im

im.dialog.users.list

Получить список участников

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

Описание

Метод 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 -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

Ответ

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

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": "DIALOG_ID_EMPTY",
    "error_description": "Dialog ID can't be empty"
}
Код Описание Значение
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 Нет доступа к указанному чату

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.