Добавить участников

POST /v1/chats/:chatId/users

Добавляет одного или нескольких пользователей в групповой чат.

Параметры

Параметр Тип Обяз. Описание
chatId (path) number да Числовой ID чата (без префикса chat)

Поля запроса (body)

Поле Тип Обяз. Описание
users number[] да Массив ID пользователей для добавления
hideHistory boolean нет true — новые участники не видят историю до вступления, по умолчанию true. false — история открыта с момента создания чата

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/123/users" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "users": [42, 53] }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/chats/123/users" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "users": [42, 53] }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/123/users', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ users: [42, 53] }),
})

const { success, data } = await res.json()
console.log('Добавлено:', data)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/123/users', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ users: [42, 53] }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data boolean true при успешном добавлении

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

JSON 
{
  "success": true,
  "data": true
}

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

403 — API-ключ не имеет скоупа im:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'im' scope"
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа im
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
422 BITRIX_ERROR Битрикс24 вернул ошибку — текст в поле message (например, чат не найден или нет прав)
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

Несуществующие пользователи пропускаются. Если в массиве users есть ID несуществующих или неактивных пользователей, они игнорируются без ошибки. Операция для остальных участников выполняется.

По умолчанию история скрыта. При добавлении без явного hideHistory новые участники не видят сообщения, отправленные до их вступления. Чтобы открыть доступ к истории с момента создания чата, передайте hideHistory: false.

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