Получить идентификаторы участников чата im.chat.user.list

Scope: im

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

Метод im.chat.user.list возвращает список идентификаторов участников чата.

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

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

Название
тип

Описание

CHAT_ID*
integer

Идентификатор чата.

Идентификатор чата можно получить с помощью метода im.chat.get

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CHAT_ID":2935}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.user.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CHAT_ID":2935,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/im.chat.user.list
        
try
        {
            const response = await $b24.callMethod(
                'im.chat.user.list',
                {
                    CHAT_ID: 2935
                }
            );
            
            const result = response.getData().result;
            console.log('Chat user list:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'im.chat.user.list',
                    [
                        'CHAT_ID' => 2935
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving chat user list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'im.chat.user.list',
            {
                CHAT_ID: 2935,
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'im.chat.user.list',
            [
                'CHAT_ID' => 2935
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": [99, 1269, 1271],
            "time": {
                "start": 1772453354,
                "finish": 1772453354.969984,
                "duration": 0.9699840545654297,
                "processing": 0,
                "date_start": "2026-03-02T11:09:14+03:00",
                "date_finish": "2026-03-02T11:09:14+03:00",
                "operating_reset_at": 1772453954,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
array

Массив идентификаторов участников чата.

Пустой массив означает, что у пользователя нет прав на просмотр идентификаторов участников чата

time
time

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

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

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

{
            "error": "CHAT_ID_EMPTY",
            "error_description": "Chat ID can't be empty"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

CHAT_ID_EMPTY

Chat ID can't be empty

Не передан CHAT_ID

ACCESS_ERROR

Action unavailable

Операция недоступна для этого чата

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

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

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

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

Предыдущая
Приглаcить участников в чат
Следующая
Получить список участников