Для AI-агентов: markdown этой страницы — /docs-content/chats/discovery/configuration.md индекс документации — /llms.txt
Получить конфигурацию чатов
GET /v1/chats/configuration
Получает доступные возможности мессенджера, права на действия со списком и начальные сведения о непрочитанном для текущего пользователя.
Методу нужны скоуп im и право записи: получение конфигурации может создать системные папки пользователя. Параметры запроса не принимаются.
Примеры
curl — личный ключ
curl https://vibecode.bitrix24.tech/v1/chats/configuration \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl https://vibecode.bitrix24.tech/v1/chats/configuration \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
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-приложение
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 в папках чатов |
Поле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 | ОписаниеСтроки в той же форме, что в счётчиках непрочитанного |
Полеdata.anchors |
Типobject | ОписаниеНепрочитанные упоминания и реакции. Приходит не в каждом ответе |
Полеdata.anchors.anchors |
Типarray | ОписаниеСтроки в той же форме, что в якорях непрочитанного |
Полеdata.preloadedEntities.legacyCurrentUser |
Типobject | null | ОписаниеНачальные сведения о текущем пользователе. null означает, что переданная запись некорректна |
Полеdata.preloadedEntities.legacyCurrentUser.id |
Типnumber | ОписаниеПоложительный ID текущего пользователя |
Полеdata.preloadedEntities.legacyCurrentUser.type |
Типstring | ОписаниеИзвестный тип: user, extranet, collaber или guest. Неизвестный тип не включается в ответ |
Полеdata.folderActions |
Типobject | ОписаниеДопуск исполнения папочных действий на платформе |
Полеdata.folderActions.mute |
Типboolean | ОписаниеПлатформа допускает и выключение, и включение уведомлений папки |
Полеdata.folderActions.readAll |
Типboolean | ОписаниеПлатформа допускает прочтение папки |
Пример ответа
Показаны основные поля.
{
"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:
{"success": false, "error": {"code": "INVALID_PARAMS", "message": "Query parameter `extra` is not accepted by GET /v1/chats/configuration. It takes no query parameters."}}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеПередан параметр запроса |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеКлюч разрешает только чтение |
| HTTP403 | КодBITRIX_ACCESS_DENIED |
ОписаниеБитрикс24 отказал в доступе |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеБитрикс24 отклонил запрос. Его код сохранён в error.b24Code |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан API-ключ |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ ключа не настроены токены Битрикс24 |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеУ ключа нет скоупа im |
Общие ошибки API — Ошибки.
Известные особенности
Допуск folderActions не заменяет возможности портала и права пользователя. Например, при folderActions.mute: true и isFolderMuteAvailable: false выключение уведомлений папки недоступно.
Для текущего пользователя передаются только ID и известный тип из конфигурации Битрикс24. Сопоставьте ID с пользователем, от имени которого выполняется запрос. Список людей, контактные данные, произвольные настройки и учётные данные не возвращаются. Ответ персональный и приходит с заголовком Cache-Control: private, no-store.
Признаки messageActionCapabilities сообщают версию API Вайбкод и приходят только вместе с объектом featureOptions. Они не определяют наличие методов и не дают прав. Если конфигурация недоступна, возвращается ошибка без признаков версии.
Включайте личные закрепы только при messageActionCapabilities.personalPins: 1, features.personalMessagePins: true, обоих ограничениях закрепов и начальном блоке personalPins из загрузки чата. Отсутствующие данные остаются неизвестными. Отсутствие политики не даёт права общего закрепа или удаления.