метод REST scope: imbot

imbot.v2.Chat.User.list

Список участников чата

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

Описание

Метод imbot.v2.Chat.User.list возвращает список участников чата.

Параметры

botId integer обязательный

ID бота

botToken string необязательный

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

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

dialogId string обязательный

ID диалога. Для групповых чатов — chat{chatId}

order object необязательный

Сортировка.

Доступные поля: id, lastSendMessageId, userId. Значение: ASC или DESC.

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

limit integer необязательный

Количество записей (1–200). По умолчанию 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

Ответ

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",
            "absent": false,
            "departments": [7],
            "phones": false,
            "type": "employee"
        },
        {
            "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",
            "absent": false,
            "departments": [12],
            "phones": false,
            "type": "employee"
        }
    ],
    "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"
    }
}

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

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied"
}
Код Описание Значение
BOT_TOKEN_NOT_SPECIFIED Bot token is not specified Не указан botToken. Обязателен при авторизации через вебхук
BOT_ID_REQUIRED Bot ID is required Не указан botId
BOT_NOT_FOUND Bot not found Бот не найден
BOT_OWNERSHIP_ERROR Bot is registered by another application Бот зарегистрирован другим приложением
ACCESS_DENIED Access denied Бот не является участником чата

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

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