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

Статус пользователя

Устанавливает статус пользователя в мессенджере — «в сети», «не беспокоить» или «отошёл».

Установить статус

PUT /v1/chats/settings/status

Обновляет и настройку status, и текущий статус, который видят другие пользователи.

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

Тело запроса — JSON-объект:

Поле Тип Обяз. Описание
status string да online — в сети, dnd — не беспокоить, away — отошёл
userId number нет ID пользователя, чей статус установить, — положительное целое. По умолчанию — владелец ключа. Чужой статус меняет только администратор Битрикс24. Список пользователей: GET /v1/users

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

Примеры

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

Terminal
curl -X PUT "https://vibecode.bitrix24.tech/v1/chats/settings/status" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "dnd"}'

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

Terminal
curl -X PUT "https://vibecode.bitrix24.tech/v1/chats/settings/status" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status": "dnd"}'

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/settings/status', {
  method: 'PUT',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ status: 'dnd' }),
})

const { data } = await res.json()
console.log('Статус установлен:', data)

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

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

const { data } = await res.json()
console.log('Статус установлен:', data)

Поля ответа

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

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

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

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

400 — статус вне допустимого набора:

JSON
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`status` must be `online`, `dnd` or `away`."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Не передан status
400 INVALID_PARAMS status не online, не dnd и не away
400 INVALID_PARAMS userId не положительное целое
400 INVALID_PARAMS Тело запроса не JSON-объект
400 INVALID_PARAMS В теле передано поле, кроме status и userId
400 INVALID_PARAMS Передан параметр запроса — метод их не принимает
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code. SETTINGS_ACCESS_DENIED — чужой статус меняет не администратор
502 ME_ALIAS_RESOLUTION_FAILED userId не передан, и не удалось определить владельца ключа
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

  • Значения status, кроме online, dnd и away, платформа отклоняет до обращения к Битрикс24: иначе настройка status и текущий статус разошлись бы.
  • Изменить статус через PATCH /v1/chats/settings нельзя: так изменилась бы только настройка, а статус, который видят другие, остался бы прежним.
  • Текущий статус возвращается в поле status при чтении настроек.

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