Передать владение чатом

POST /v1/chats/:chatId/owner

Передаёт права владельца группового чата другому участнику. Новый владелец должен уже состоять в чате.

Параметры

Параметр Тип Обяз. Описание
chatId (path) number да ID чата (положительное целое)

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

Поле Тип Обяз. Описание
userId number да ID пользователя, которому передаётся владение. Пользователь должен быть участником чата. Список участников: GET /v1/chats/:chatId/users

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/456/owner \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "userId": 42 }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/456/owner \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "userId": 42 }'

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

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

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

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

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

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

Поля ответа

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

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

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

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

422 — нарушено условие передачи владения:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Change owner can only owner and user must be member in chat"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_PARAMS Поле userId отсутствует или не является положительным целым числом
422 BITRIX_ERROR Передать владение может только текущий владелец, новый владелец должен быть участником чата
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера
403 SCOPE_DENIED API-ключ не имеет скоупа im
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Если нужный участник ещё не состоит в чате, добавьте его через `POST /v1/chats/:chatId/users` перед вызовом этого эндпоинта.

Выход владельца из чата. Создатель чата остаётся владельцем даже после вызова `POST /v1/chats/:chatId/leave` — выход не снимает статус владельца. Чтобы покинуть чат полностью: сначала передайте владение другому участнику этим эндпоинтом, затем вызовите выход.

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