## Получить конфигурацию чатов

`GET /v1/chats/configuration`

Получает доступные возможности мессенджера, права на действия со списком и начальные сведения о непрочитанном для текущего пользователя.

Методу нужны скоуп `im` и право записи: получение конфигурации может создать системные папки пользователя. Параметры запроса не принимаются.

## Примеры

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

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

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

```bash
curl https://vibecode.bitrix24.tech/v1/chats/configuration \
  -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/configuration', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const body = await res.json()
```

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

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

## Поля ответа

Неизвестные и некорректные поля не включаются в ответ. Некорректная запись текущего пользователя обозначается `legacyCurrentUser: null`. Отсутствующее поле не означает `false`, а отсутствующий блок не означает пустой список.

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | `true` при успехе |
| `data.features` | object | Известные возможности мессенджера |
| `data.features.chatThreads` | boolean | Доступны ветки обсуждений |
| `data.features.messagesAutoDelete` | boolean | Доступно автоудаление сообщений |
| `data.features.chatGuests` | boolean | Доступны гости чата |
| `data.features.chatFolders` | boolean | Доступны папки чатов. Пока значение `false`, список `data.folders.list` пуст |
| `data.features.personalMessagePins` | boolean | Текущему пользователю доступны личные закрепы |
| `data.pinLimits` | object | Ограничения закрепов. Приходит, только когда известны оба значения |
| `data.pinLimits.maxPinsPerChat` | integer | Сколько общих закрепов допускается в одном чате |
| `data.pinLimits.maxPersonalPinsPerChat` | integer | Сколько личных закрепов допускается в одном чате |
| `data.messageActionCapabilities` | object | Признаки версии API: `personalPins`, `favorites` и `fileSaving` равны `1`. `nativePolicy` равен `1` только при наличии всех секций политики |
| `data.messageActionPolicy` | object | Права на действия с сообщениями. Приходит, только когда известны все четыре секции ниже |
| `data.messageActionPolicy.byChatType` | object | Права по типам чатов с исходными ключами данных |
| `data.messageActionPolicy.byUserType` | object | Права по типам пользователей |
| `data.messageActionPolicy.actionGroups` | object | Состав групп прав |
| `data.messageActionPolicy.actionGroupsDefaults` | object | Права групп по умолчанию для типов чата |
| `data.featureOptions` | object | Известные настройки списка |
| `data.featureOptions.isFolderScopedPinsAvailable` | boolean | Закрепы действуют в отдельных папках |
| `data.featureOptions.isChatFolderAllAvailable` | boolean | Доступна папка «Все» |
| `data.featureOptions.isFolderMuteAvailable` | boolean | Доступно выключение уведомлений папки |
| `data.folders` | object | Папки и их ограничения. Приходит не в каждом ответе |
| `data.folders.list` | array | Папки в том же порядке и той же форме, что `folders` в [папках чатов](/docs/chats/discovery/folders) |
| `data.folders.limits.maxPinnedChats` | number | Неотрицательное целое ограничение числа закрепов |
| `data.permissions.byChatType` | object | Минимальные роли для действий по типам чатов. `default` — правило для остальных типов |
| `data.permissions.byChatType.*.pinChat` | string | Роль для закрепа: `none`, `guest`, `member`, `manager` или `owner` |
| `data.permissions.byChatType.*.hideChat` | string | Роль для скрытия, тот же набор значений |
| `data.permissions.byChatType.*.mute` | string | Роль для уведомлений, тот же набор значений |
| `data.counters` | object | Счётчики непрочитанного. Приходит не в каждом ответе |
| `data.counters.userCounters` | array | Строки в той же форме, что в [счётчиках непрочитанного](/docs/chats/discovery/counters) |
| `data.anchors` | object | Непрочитанные упоминания и реакции. Приходит не в каждом ответе |
| `data.anchors.anchors` | array | Строки в той же форме, что в [якорях непрочитанного](/docs/chats/messages/anchors-list) |
| `data.preloadedEntities.legacyCurrentUser` | object \| null | Начальные сведения о текущем пользователе. `null` означает, что переданная запись некорректна |
| `data.preloadedEntities.legacyCurrentUser.id` | number | Положительный ID [текущего пользователя](/docs/entities/users/me) |
| `data.preloadedEntities.legacyCurrentUser.type` | string | Известный тип: `user`, `extranet`, `collaber` или `guest`. Неизвестный тип не включается в ответ |
| `data.folderActions` | object | Допуск исполнения папочных действий на платформе |
| `data.folderActions.mute` | boolean | Платформа допускает и выключение, и включение уведомлений папки |
| `data.folderActions.readAll` | boolean | Платформа допускает прочтение папки |

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

Показаны основные поля.

```json
{
  "success": true,
  "data": {
    "features": {"chatThreads": true, "messagesAutoDelete": false, "chatFolders": true, "personalMessagePins": true},
    "pinLimits": {"maxPinsPerChat": 20, "maxPersonalPinsPerChat": 20},
    "messageActionCapabilities": {"personalPins": 1, "favorites": 1, "fileSaving": 1},
    "counters": {"userCounters": [{"chatId": 1945, "counter": 2, "parentChatId": 0, "isMuted": false, "isMarkedAsUnread": false, "recentSections": ["default"]}]},
    "folders": {"list": [{"id": 1, "type": "system", "definition": {"recentSection": "default"}}], "limits": {"maxPinnedChats": 45}},
    "anchors": {"anchors": [{"chatId": 1945, "messageId": 846, "fromUserId": 7, "type": "reaction", "subType": "like", "parentChatId": 0, "parentMessageId": 0, "recentSections": ["chat"]}]},
    "featureOptions": {"isFolderScopedPinsAvailable": true, "isChatFolderAllAvailable": true, "isFolderMuteAvailable": false},
    "permissions": {"byChatType": {"default": {"pinChat": "member", "hideChat": "member", "mute": "member"}}},
    "preloadedEntities": {"legacyCurrentUser": {"id": 6, "type": "user"}},
    "folderActions": {"mute": true, "readAll": true}
  }
}
```

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

400 — передан неизвестный параметр запроса `extra`:

```json
{"success": false, "error": {"code": "INVALID_PARAMS", "message": "Query parameter `extra` is not accepted by GET /v1/chats/configuration. It takes no query parameters."}}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | Передан параметр запроса |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ разрешает только чтение |
| 403 | `BITRIX_ACCESS_DENIED` | Битрикс24 отказал в доступе |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил запрос. Его код сохранён в `error.b24Code` |
| 401 | `MISSING_API_KEY` | Не передан API-ключ |
| 401 | `TOKEN_MISSING` | У ключа не настроены токены Битрикс24 |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `im` |

Общие ошибки API — [Ошибки](/docs/errors).

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

Допуск `folderActions` не заменяет возможности портала и права пользователя. Например, при `folderActions.mute: true` и `isFolderMuteAvailable: false` выключение уведомлений папки недоступно.

Для текущего пользователя передаются только ID и известный тип из конфигурации Битрикс24. Сопоставьте ID с пользователем, от имени которого выполняется запрос. Список людей, контактные данные, произвольные настройки и учётные данные не возвращаются. Ответ персональный и приходит с заголовком `Cache-Control: private, no-store`.

Признаки `messageActionCapabilities` сообщают версию API Вайбкод и приходят только вместе с объектом `featureOptions`. Они не определяют наличие методов и не дают прав. Если конфигурация недоступна, возвращается ошибка без признаков версии.

Включайте личные закрепы только при `messageActionCapabilities.personalPins: 1`, `features.personalMessagePins: true`, обоих ограничениях закрепов и начальном блоке `personalPins` из загрузки чата. Отсутствующие данные остаются неизвестными. Отсутствие политики не даёт права общего закрепа или удаления.

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

- [Личные закрепы](/docs/chats/messages/personal-pins)
- [Избранные сообщения](/docs/chats/messages/favorites)
- [Папки чатов](/docs/chats/discovery/folders)
- [Закрепить чат](/docs/chats/management/pin)
- [Счётчики непрочитанного](/docs/chats/discovery/counters)
