Для AI-агентов: markdown этой страницы — /docs-content/bots/chats/user-list.md индекс документации — /llms.txt

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

GET /v1/bots/:botId/chats/:dialogId/users

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

Параметры

Параметр Тип Обяз. По умолч. Описание
botId (path) number да — ID бота
dialogId (path) string да — ID диалога (chatXXX)
limit (query) number нет 50 Количество записей (1-200)

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users?limit=100" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users?limit=100" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users?limit=100', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Участников:', data.length)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/bots/42/chats/chat456/users?limit=100', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив участников
data[].id number ID пользователя
data[].active boolean Активен ли аккаунт
data[].name string Полное имя
data[].firstName string Имя
data[].lastName string Фамилия. Пустая строка, если не задана
data[].workPosition string Должность. Пустая строка, если не задана
data[].color string Цвет аватара в формате HEX, например #29619b
data[].avatar string URL аватара. Пустая строка, если аватар не задан
data[].gender string Пол: M — мужской, F — женский, пустая строка — не указан
data[].birthday string Дата рождения. Пустая строка, если не указана
data[].extranet boolean Является ли пользователь внешним, тип extranet
data[].bot boolean Является ли ботом
data[].connector boolean Пользователь открытых линий
data[].externalAuthId string Код внешней авторизации учётной записи. У бота — bot
data[].internalAccount boolean Внутренняя учётная запись портала. У бота — false
data[].intranetUser boolean Сотрудник портала. У бота — false
data[].status string Статус: online, away, dnd
data[].idle boolean Признак бездействия пользователя
data[].lastActivityDate string | false Время последней активности в формате ISO 8601. false, если активности не было
data[].mobileLastDate string | false Время последнего входа из мобильного приложения. false, если входа не было
data[].desktopLastDate string | false Время последнего входа из приложения для компьютера. false, если входа не было
data[].absent boolean | string false или дата окончания отсутствия
data[].departments number[] ID подразделений. Список: GET /v1/departments. Пустой массив у бота
data[].phones object | false Телефоны. Ключи — work_phone, personal_mobile, inner_phone, в объекте только заполненные. false, если телефонов нет
data[].type string Тип пользователя: user, bot, extranet
data[].website string Сайт. Пустая строка, если не указан
data[].email string Адрес электронной почты. Пустая строка, если не указан

Пример ответа

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "active": true,
      "name": "Иван Петров",
      "firstName": "Иван",
      "lastName": "Петров",
      "workPosition": "Менеджер",
      "color": "#df532d",
      "avatar": "",
      "gender": "M",
      "birthday": "",
      "extranet": false,
      "bot": false,
      "connector": false,
      "externalAuthId": "socservices",
      "internalAccount": true,
      "intranetUser": true,
      "status": "online",
      "idle": false,
      "lastActivityDate": "2026-10-14T18:44:48+03:00",
      "mobileLastDate": false,
      "desktopLastDate": false,
      "absent": false,
      "departments": [1, 47],
      "phones": {
        "personal_mobile": "70000000000",
        "inner_phone": "111"
      },
      "type": "user",
      "website": "",
      "email": "user@example.com"
    },
    {
      "id": 42,
      "active": true,
      "name": "Техподдержка",
      "firstName": "Техподдержка",
      "lastName": "",
      "workPosition": "Чат-бот",
      "color": "#58cc47",
      "avatar": "",
      "gender": "M",
      "birthday": "",
      "extranet": false,
      "bot": true,
      "connector": false,
      "externalAuthId": "bot",
      "internalAccount": false,
      "intranetUser": false,
      "status": "online",
      "idle": false,
      "lastActivityDate": false,
      "mobileLastDate": false,
      "desktopLastDate": false,
      "absent": false,
      "departments": [],
      "phones": false,
      "type": "bot",
      "website": "",
      "email": ""
    }
  ]
}

Пример ответа при ошибке

403 — бот не является участником чата:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Access denied"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_BOT_ID botId не является числом
404 BOT_NOT_FOUND Бот с таким ID не найден
403 BOT_ACCESS_DENIED Бот принадлежит другому API-ключу
403 BITRIX_ACCESS_DENIED Бот не является участником чата
422 BITRIX_ERROR Другая ошибка Битрикс24, текст в message
403 SCOPE_DENIED API-ключ не имеет скоупа imbot
410 BOT_DISABLED Бот отключён и не обрабатывает вызовы API. Как вернуть бота — Бот отключён
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

Смотрите также