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

`GET /v1/chats/settings`

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

## Параметры

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

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

## Примеры

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

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

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

```bash
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, и их набор зависит от версии мессенджера. Те же имена принимает [изменение настройки](/docs/chats/settings/update). Таблица описывает основные настройки, полный набор показан в примере ответа.

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | object | Настройки: ключ — имя настройки, значение — строка или логическое значение |
| `data.status` | string | Статус пользователя: `online`, `dnd` или `away`. Меняется через [`PUT /v1/chats/settings/status`](/docs/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` не положительное целое:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "The query parameter `userId` must be a positive integer."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `userId` не положительное целое |
| 400 | `INVALID_PARAMS` | Передан параметр запроса, кроме `userId` |
| 400 | `INVALID_PARAMS` | `userId` передан больше одного раза или со скобками, например `userId[]=5` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ только для чтения. Запрос отклоняется до обращения к Битрикс24 |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку, код портала — в `error.b24Code`. `SETTINGS_ACCESS_DENIED` — чужие настройки запросил не администратор |
| 502 | `ME_ALIAS_RESOLUTION_FAILED` | `userId` не передан, и не удалось определить владельца ключа |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или вернул ошибку сервера |

Полный список общих ошибок API — [Ошибки](/docs/errors).

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

- Чтение настроек пользователя, у которого ещё нет привязки к набору настроек, может создать такую привязку — значения при этом не меняются.
- Для `userId`, которого нет на портале, ответ — настройки по умолчанию, без ошибки. Проверить, что пользователь существует, можно через [`GET /v1/users/:id`](/docs/entities/users/get).

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

- [Изменить настройку](/docs/chats/settings/update)
- [Статус пользователя](/docs/chats/settings/status)
- [Настройки мессенджера](/docs/chats/settings)