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

Прочитать настройки

GET /v1/chats/settings

Возвращает общие настройки мессенджера пользователя — звук, тему, отправку по Enter, приватность, схему уведомлений и другие.

Параметры

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

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

Примеры

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

Terminal

curl "https://vibecode.bitrix24.tech/v1/chats/settings" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal

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

const { data: settings } = await res.json()
console.log('Тема:', settings.enableDarkTheme, 'Enter отправляет:', settings.sendByEnter)

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

javascript

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

const { data: settings } = await res.json()
console.log('Статус:', settings.status)

Поля ответа

data — объект настроек. Ключ — имя настройки, значение — строка или логическое значение. Имена настроек задаёт Битрикс24, и их набор зависит от версии мессенджера. Те же имена принимает изменение настройки. Таблица описывает основные настройки, полный набор показан в примере ответа.

Поле	Тип	Описание
`success`	boolean	Всегда `true` при успехе
`data`	object	Настройки: ключ — имя настройки, значение — строка или логическое значение
`data.status`	string	Статус пользователя: `online`, `dnd` или `away`. Меняется через `PUT /v1/chats/settings/status`
`data.enableSound`	boolean	Звуки мессенджера
`data.enableBigSmile`	boolean	Крупные смайлы в сообщении, состоящем только из смайлов
`data.enableDarkTheme`	string	Тема: `auto`, `light` или `dark`
`data.sendByEnter`	boolean	`true` — сообщение отправляется по Enter
`data.chatAlignment`	string	Выравнивание сообщений в чате
`data.pinnedChatSort`	string	Порядок закреплённых чатов
`data.notifyScheme`	string	Схема уведомлений: `simple` или `expert`
`data.privacySearch`	string	Кто может найти пользователя в поиске

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

JSON

{
  "success": true,
  "data": {
    "status": "online",
    "backgroundImage": false,
    "bxdNotify": false,
    "sshNotify": true,
    "generalNotify": false,
    "trackStatus": "",
    "nativeNotify": true,
    "openDesktopFromPanel": false,
    "viewOffline": true,
    "viewGroup": true,
    "viewLastMessage": true,
    "viewBirthday": true,
    "viewCommonUsers": true,
    "enableSound": true,
    "enableBigSmile": true,
    "defaultReaction": "like",
    "enableDarkTheme": "dark",
    "isCurrentThemeDark": false,
    "enableRichLink": true,
    "linesTabEnable": true,
    "linesNewGroupEnable": false,
    "sendByEnter": true,
    "correctText": false,
    "panelPositionHorizontal": "right",
    "panelPositionVertical": "bottom",
    "loadLastMessage": true,
    "loadLastNotify": true,
    "notifyAutoRead": false,
    "notifyScheme": "expert",
    "notifySchemeLevel": "important",
    "notifySchemeSendSite": false,
    "notifySchemeSendEmail": false,
    "notifySchemeSendXmpp": true,
    "notifySchemeSendPush": false,
    "privacyMessage": "all",
    "privacyChat": "all",
    "privacyCall": "all",
    "privacySearch": "all",
    "privacyProfile": "all",
    "callAcceptIncomingVideo": "AllowAll",
    "backgroundImageId": "azure",
    "chatAlignment": "left",
    "pinnedChatSort": "byCost"
  }
}

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

400 — userId не положительное целое: