Покинуть чат

POST /v1/chats/:chatId/leave

Текущий пользователь (или приложение) выходит из группового чата.

Параметры

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

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/456/leave \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/chats/456/leave \
  -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/456/leave', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/456/leave', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

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

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

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

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

422 — чат не найден или другая ошибка Битрикс24:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Chat not found"
  }
}

Ошибки

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

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

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

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

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