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

Выход десктоп-приложения

POST /v1/chats/desktop/logout

Отмечает десктоп-приложение вызывающего и его самого «не в сети» в мессенджере — так делает десктоп-приложение Битрикс24 при выходе.

Параметры

Параметров нет. Любое поле тела или параметр запроса отклоняется с 400 INVALID_PARAMS.

Примеры

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

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

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

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

const { success } = await res.json()
console.log('Отмечено:', success)

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

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

const { success } = await res.json()
console.log('Отмечено:', success)

Поля ответа

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

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

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

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

400 — передано поле тела:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body field `dialogId` is not accepted by POST /v1/chats/desktop/logout. It takes no body fields."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передано поле тела или параметр запроса — операция их не принимает
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ работает только на чтение
422 BITRIX_ERROR Битрикс24 вернул ошибку. Код портала — в error.b24Code
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

  • Вызов не выходит из Битрикс24 и не отзывает ключи — меняется только статус присутствия.
  • Любой следующий вызов мессенджера от того же пользователя, например состояние обновлений, снова отметит его «в сети».

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