Получить список участников чата imbot.v2.Chat.User.list

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

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

Scope: imbot

Кто может выполнять метод: владелец зарегистрированного бота

Метод imbot.v2.Chat.User.list возвращает список участников чата. Если бот состоит в чате, он тоже есть в списке — его отличает поле bot: true.

Пользователи с деактивированной учетной записью в список не попадают.

Бот должен быть участником чата. Список участников открытого чата или открытого канала метод возвращает и без участия бота.

Метод не поддерживает постраничную навигацию: параметров смещения нет, а ответ не содержит общего количества участников. За один вызов можно получить не более 200 участников. Число участников чата есть в поле userCounter ответа imbot.v2.Chat.get.

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

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

Название
тип

Описание

botId*
integer

ID бота

botToken
string

Токен бота. Обязателен при авторизации через вебхук, для OAuth не нужен.

Передавайте тот же botToken, который указали при регистрации бота

dialogId*
string

ID группового чата в формате dialogId: chat{chatId}

order
object

Сортировка.

Доступные поля:

  • id — порядок вступления в чат
  • lastSendMessageId — ID последнего сообщения участника
  • userId — ID пользователя

Направление сортировки: ASC или DESC. Если передать несколько полей, метод учтет одно — то, что стоит выше в списке доступных полей. Без order порядок не гарантирован.

Пример: {"id": "ASC"}

limit
integer

Количество записей, от 1 до 200. По умолчанию 50. Значение вне диапазона не вызывает ошибку — метод вернет до 50 записей

Примеры кода

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"botToken":"my_bot_token","dialogId":"chat5","order":{"id":"ASC"},"limit":50}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.User.list

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"botId":456,"dialogId":"chat5","order":{"id":"ASC"},"limit":50,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/imbot.v2.Chat.User.list

try {
  const response = await $b24.callMethod('imbot.v2.Chat.User.list', {
    botId: 456,
    dialogId: 'chat5',
    order: { id: 'ASC' },
    limit: 50,
  });

  const { result } = response.getData();
  console.log('result:', result);
} catch (error) {
  console.error('Error:', error);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.imbot.v2.chat.user.list(
        bot_id=456,
        dialog_id="chat5",
        order={
            "id": "ASC",
        },
        limit=50,
    ).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(
            'imbot.v2.Chat.User.list',
            [
                'botId' => 456,
                'dialogId' => 'chat5',
                'order' => ['id' => 'ASC'],
                'limit' => 50,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'result: ' . print_r($result, true);
} catch (Throwable $exception) {
    error_log($exception->getMessage());
    echo 'Error: ' . $exception->getMessage();
}

BX24.callMethod(
    'imbot.v2.Chat.User.list',
    {
        botId: 456,
        dialogId: 'chat5',
        order: { id: 'ASC' },
        limit: 50,
    },
    function(result) {
        if (result.error()) {
            console.error(result.error().ex);
        } else {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'imbot.v2.Chat.User.list',
    [
        'botId' => 456,
        'dialogId' => 'chat5',
        'order' => ['id' => 'ASC'],
        'limit' => 50,
    ]
);

if (!empty($result['error'])) {
    echo 'Error: ' . $result['error_description'];
} else {
    foreach ($result['result'] as $user) {
        echo $user['id'] . ': ' . $user['name'] . "\n";
    }
}

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.v2.Chat.User.list", b24.Params{
	"botId":    456,
	"botToken": "my_bot_token",
	"dialogId": "chat5",
	"order": b24.Params{
		"id": "ASC",
	},
	"limit": 50,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("imbot.v2.Chat.User.list: %w", err)
}

var items []struct {
	ID           b24.ID `json:"id"`
	Active       bool   `json:"active"`
	Name         string `json:"name"`
	FirstName    string `json:"firstName"`
	LastName     string `json:"lastName"`
	WorkPosition string `json:"workPosition"`
}
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": 1,
            "active": true,
            "name": "John Smith",
            "firstName": "John",
            "lastName": "Smith",
            "workPosition": "Developer",
            "color": "#ab7761",
            "avatar": "",
            "gender": "M",
            "birthday": "15-03",
            "extranet": false,
            "bot": false,
            "connector": false,
            "externalAuthId": "default",
            "status": "online",
            "idle": false,
            "lastActivityDate": "2025-01-15T14:25:00+03:00",
            "mobileLastDate": false,
            "desktopLastDate": "2025-01-15T14:25:00+03:00",
            "absent": false,
            "departments": [7],
            "phones": false,
            "type": "user",
            "website": "",
            "email": ""
        },
        {
            "id": 2,
            "active": true,
            "name": "Anna Davis",
            "firstName": "Anna",
            "lastName": "Davis",
            "workPosition": "Manager",
            "color": "#5b7e91",
            "avatar": "",
            "gender": "F",
            "birthday": "22-08",
            "extranet": false,
            "bot": false,
            "connector": false,
            "externalAuthId": "default",
            "status": "online",
            "idle": false,
            "lastActivityDate": "2025-01-15T14:20:00+03:00",
            "mobileLastDate": false,
            "desktopLastDate": "2025-01-15T14:20:00+03:00",
            "absent": false,
            "departments": [12],
            "phones": false,
            "type": "user",
            "website": "",
            "email": ""
        }
    ],
    "time": {
        "start": 1728626400.123,
        "finish": 1728626400.234,
        "duration": 0.111,
        "processing": 0.045,
        "date_start": "2024-10-11T10:00:00+03:00",
        "date_finish": "2024-10-11T10:00:00+03:00"
    }
}

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

Название
тип

Описание

result
User[]

Массив участников чата. Описание полей объекта — User

time
time

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

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

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "ACCESS_DENIED"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

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

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

Код

Описание

Значение

BOT_TOKEN_NOT_SPECIFIED

Bot token not specified (botToken is required for webhook auth)

Не указан botToken. Обязателен при авторизации через вебхук

BOT_ID_REQUIRED

botId is required

Не указан botId

BOT_NOT_FOUND

Bot not found

Бот не найден

BOT_OWNERSHIP_ERROR

Bot was installed by another rest application

Бот зарегистрирован другим приложением

CHAT_NOT_FOUND

CHAT_NOT_FOUND

Чат с указанным dialogId не найден

ACCESS_DENIED

ACCESS_DENIED

Бот не является участником закрытого чата

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

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

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

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

Предыдущая
Добавить участников в чат
Следующая
Удалить участника из чата