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

Проверка участия

GET /v1/chats/:dialogId/users/membership

Проверяет, какие из перечисленных пользователей состоят в чате. Один запрос отвечает на вопрос сразу для списка до 50 пользователей: например, перед приглашением в чат или перед упоминанием.

Параметры

Параметр Тип Обяз. По умолч. Описание
dialogId (path) string да — Идентификатор диалога: chatXXX для группового чата, ID пользователя для личного диалога или алиас me. chatXXX — поле id строки последних диалогов, ID пользователя — из списка пользователей
userIds (query) string да — От 1 до 50 ID пользователей из списка пользователей через запятую, например 7,12. Каждый ID — положительное целое без пробелов и ведущих нулей. Повтор ID допустим и учитывается в лимите 50

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

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/chats/chat123/users/membership?userIds=7,12" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/chats/chat123/users/membership?userIds=7,12" \
  -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/membership?userIds=7,12', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log('Не в чате:', data.usersNotInChat)

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

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

const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.usersInChat array ID пользователей из запроса, которые состоят в чате
data.usersNotInChat array ID пользователей из запроса, которые в чате не состоят
data.users array Краткие карточки всех пользователей из запроса
data.users[].id number ID пользователя
data.users[].name string Полное имя
data.users[].avatar string URL аватара. Пустая строка, если аватар не задан
data.users[].color string Цвет аватара в шестнадцатеричном формате
data.users[].type string Тип пользователя: user, extranet, bot и другие

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

JSON 
{
  "success": true,
  "data": {
    "usersInChat": [7],
    "usersNotInChat": [12],
    "users": [
      { "id": 7, "name": "Иван Петров", "avatar": "", "color": "#df532d", "type": "user" },
      { "id": 12, "name": "Анна Смирнова", "avatar": "", "color": "#1eb4aa", "type": "extranet" }
    ]
  }
}

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

400 — не передан userIds:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`userIds` is required: 1-50 Bitrix24 user ids separated by commas (4,7), each a positive integer without spaces or leading zeros."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS userIds не передан, передано больше 50 ID или ID не является положительным целым. Параметр вне userIds или повтор параметра. Проверяется до обращения к Битрикс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 — Ошибки.

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

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

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