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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

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 -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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each DialogUser returned in result[]
type DialogUser = {
  id: number
  active: boolean
  name: string
  first_name: string
  last_name: string
  work_position: string | null
  color: string
  avatar: string
  avatar_hr: string
  gender: string
  birthday: string
  extranet: boolean
  network: boolean
  bot: boolean
  connector: boolean
  external_auth_id: string
  status: string
  idle: ISODate | false
  last_activity_date: ISODate
  mobile_last_date: ISODate | false
  desktop_last_date: ISODate | false
  absent: ISODate | false
  departments: number[]
  phones: { work_phone?: string; personal_mobile?: string; personal_phone?: string } | false
  bot_data: object | null
  type: string
  website: string
  email: string
}

try {
  const response = await $b24.actions.v2.call.make<DialogUser[]>({
    method: 'im.dialog.users.list',
    params: {
      DIALOG_ID: 'chat13',
      SKIP_EXTERNAL: 'Y',
      LIMIT: 20,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(`Retrieved ${result.length} dialog users:`, result.map(u => u.name))
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function fetchDialogUsers() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.dialog.users.list',
        params: {
          DIALOG_ID: 'chat13',
          SKIP_EXTERNAL: 'Y',
          LIMIT: 20,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(`Retrieved ${result.length} dialog users:`, result.map(u => u.name))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', fetchDialogUsers)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.dialog.users.list(
        dialog_id="chat2935",
        skip_external=True,
        limit=20,
        offset=0,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.dialog.users.list", b24.Params{
	"DIALOG_ID":     "chat2935",
	"SKIP_EXTERNAL": "Y",
	"LIMIT":         20,
	"OFFSET":        0,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("im.dialog.users.list: %w", err)
}

var items []struct {
	ID           b24.ID `json:"id"`
	Active       bool   `json:"active"`
	Name         string `json:"name"`
	FirstName    string `json:"first_name"`
	LastName     string `json:"last_name"`
	WorkPosition string `json:"work_position"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.ID, it.Active)
}

// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
	fmt.Println("всего:", *res.Total)
}

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

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
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Код

Описание

Значение

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-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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