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

Кого можно упомянуть

GET /v1/chats/:dialogId/users/mentionable

Возвращает участников чата, которых текущий пользователь может упомянуть через @. В списке активные участники, кроме самого текущего пользователя, скрытых связей и скрытых ботов.

Параметры

Параметр Тип Обяз. По умолч. Описание
dialogId (path) string да — Идентификатор диалога: chatXXX для группового чата, ID пользователя для личного диалога или алиас me. chatXXX — поле id строки последних диалогов, ID пользователя — из списка пользователей
limit (query) number нет 50 Сколько участников вернуть, от 1 до 200. Значение вне диапазона срезается, переданное и применённое значения — в meta.requestedLimit и meta.appliedLimit. Без параметра применяется значение портала — 50

Другие параметры и повторы отклоняются с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/chats/chat123/users/mentionable?limit=20" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/chats/chat123/users/mentionable?limit=20" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

const { data } = await res.json()
console.log('Можно упомянуть:', data.users.map((u) => u.name))

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

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

const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект результата
data.users array Участники, которых можно упомянуть
data.users[].id number ID пользователя
data.users[].name string Полное имя
data.users[].firstName string Имя
data.users[].lastName string Фамилия
data.users[].workPosition string Должность
data.users[].avatar string URL аватара. Пустая строка, если аватар не задан
data.users[].color string Цвет аватара в шестнадцатеричном формате
data.users[].type string Тип пользователя: user, extranet, bot и другие
data.users[].bot boolean Пользователь — бот
data.users[].extranet boolean Внешний пользователь
data.users[].status string Статус присутствия, например online
data.users[].lastActivityDate string Момент последней активности (ISO 8601)
data.users[].absent boolean | string false или дата окончания отсутствия
data.users[].departments array ID подразделений
meta.requestedLimit number Переданный limit. Приходит вместе с appliedLimit, только когда значение вышло за диапазон от 1 до 200
meta.appliedLimit number Применённое значение limit — только если он был приведён к границе

Карточка пользователя содержит и другие поля мессенджера.

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

JSON 
{
  "success": true,
  "data": {
    "users": [
      {
        "id": 7,
        "active": true,
        "name": "Иван Петров",
        "firstName": "Иван",
        "lastName": "Петров",
        "workPosition": "Дизайнер",
        "color": "#df532d",
        "avatar": "",
        "gender": "M",
        "bot": false,
        "extranet": false,
        "status": "online",
        "lastActivityDate": "2026-09-20T10:01:00+03:00",
        "absent": false,
        "departments": [1],
        "type": "user"
      }
    ]
  }
}

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

400 — limit не число:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`limit` must be an integer (1-200)."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Параметр вне limit, повтор параметра или нечисловой limit. Проверяется до обращения к Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме только для чтения, а запрос сделан не личным ключом сотрудника или dialogId не указывает на существующий диалог
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено». Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку. Код портала — в error.b24Code. Несуществующий чат — CHAT_NOT_FOUND
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить пользователя при использовании алиаса me
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

Известные особенности

Список может быть короче limit и неполным. Скрытые боты отбрасываются уже после выборки, поэтому страница бывает короче limit. Курсора нет: в чате больше 200 участников список не полный — всех участников читайте списком участников.

Вызов может сделать вас участником. Если чат разрешает автовступление, вызов добавляет текущего пользователя в участники — как при открытии чата. Это чтение разрешено ключу READONLY по узкому исключению. Само оно не отмечает сообщения прочитанными. Скоуп im и права пользователя в Битрикс24 сохраняются.

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