## Создать папку чатов `POST /v1/chats/folders` Создаёт личную папку чатов текущего пользователя и сразу может наполнить её чатами. Список папок с их `id` — [`GET /v1/chats/folders`](/docs/chats/discovery/folders). ## Поля запроса (body) | Поле | Тип | Обяз. | Описание | |------|-----|:-----:|---------| | `title` | string | да | Название папки, от 1 до 30 символов после обрезки пробелов. Название вне этих границ отклоняется с `422 BITRIX_ERROR`, а не `400` | | `chatIds` | number[] | нет | ID чатов начального состава. Каждый элемент — положительное целое: число или строка из цифр. ID чата — поле `id` в [последних диалогах](/docs/chats/discovery/recent) | | `dialogIds` | string[] | нет | Идентификаторы диалогов: `chatXXX` или ID пользователя для личного диалога. Элемент — непустая строка до 64 символов без запятых и пробелов по краям. Алиас `me` не принимается — передайте ID пользователя. Идентификатор — поле `dialogId` в [последних диалогах](/docs/chats/discovery/recent) | Состав папки — объединение `chatIds` и `dialogIds`. Параметров запроса нет. Любой параметр запроса или другое поле тела отклоняется с `400 INVALID_PARAMS`. ## Примеры ### curl — личный ключ ```bash curl -X POST "https://vibecode.bitrix24.tech/v1/chats/folders" \ -H "X-Api-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"title": "Клиенты", "chatIds": [5287], "dialogIds": ["chat5289"]}' ``` ### curl — OAuth-приложение ```bash curl -X POST "https://vibecode.bitrix24.tech/v1/chats/folders" \ -H "X-Api-Key: YOUR_APP_KEY" \ -H "Authorization: Bearer USER_SESSION_TOKEN" \ -H "Content-Type: application/json" \ -d '{"title": "Клиенты", "chatIds": [5287], "dialogIds": ["chat5289"]}' ``` ### JavaScript — личный ключ ```javascript const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/folders', { method: 'POST', headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json', }, body: JSON.stringify({ title: 'Клиенты', chatIds: [5287], dialogIds: ['chat5289'] }), }) const { success, data } = await res.json() const folderId = data.folder.id ``` ### JavaScript — OAuth-приложение ```javascript const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/folders', { method: 'POST', headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Authorization': 'Bearer USER_SESSION_TOKEN', 'Content-Type': 'application/json', }, body: JSON.stringify({ title: 'Клиенты', chatIds: [5287], dialogIds: ['chat5289'] }), }) const { success, data } = await res.json() const folderId = data.folder.id ``` ## Поля ответа | Поле | Тип | Описание | |------|-----|---------| | `success` | boolean | Всегда `true` при успехе | | `data.folder` | object | Созданная папка | | `data.folder.id` | number | ID папки | | `data.folder.type` | string | Всегда `personal` | | `data.folder.title` | string | Название | | `data.folder.sort` | number | Порядок папки в интерфейсе | | `data.folder.visible` | boolean | Папка показывается в интерфейсе | | `data.folder.description` | null | У личной папки описания нет | | `data.folder.displaysNestedInRoot` | boolean | Вложенные чаты показываются и в корневом списке | | `data.folder.definition.chats` | array | Состав папки, список `{ chatId, dialogId }` | ## Пример ответа ```json { "success": true, "data": { "folder": { "id": 127, "type": "personal", "title": "Клиенты", "sort": 12, "visible": true, "description": null, "displaysNestedInRoot": false, "definition": { "chats": [ { "chatId": 5287, "dialogId": "chat5287" }, { "chatId": 5289, "dialogId": "chat5289" } ] } } } } ``` ## Пример ответа при ошибке 422 — название длиннее 30 символов: ```json { "success": false, "error": { "code": "BITRIX_ERROR", "message": "Длина строки должна быть не больше, чем 30 знаков", "b24Code": "title" } } ``` ## Ошибки | HTTP | Код | Описание | |------|-----|---------| | 400 | `INVALID_PARAMS` | Нет `title` или он не строка, некорректный элемент `chatIds` или `dialogIds`, передан параметр запроса или неизвестное поле тела, тело — не JSON-объект. Проверяется до обращения к Битрикс24 | | 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку, код портала — в `error.b24Code`: `title` — название пустое после обрезки пробелов или длиннее 30 символов, `FOLDER_LIMIT_EXCEEDED` — у пользователя уже 20 личных папок, `FOLDER_CHATS_LIMIT_EXCEEDED` — в составе больше 50 чатов, `FOLDER_CHAT_NOT_ELIGIBLE` — в составе есть чат, который нельзя положить в папку, например, чат, в котором пользователь не участвует | | 404 | `ENTITY_NOT_FOUND` | Битрикс24 вернул «не найдено», код портала — в `error.b24Code` | | 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` | | 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ только для чтения: создание папки — запись, см. [права доступа](/docs/access-rights) | | 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 | | 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или вернул ошибку сервера | Полный список общих ошибок API — [Ошибки](/docs/errors). ## Известные особенности - **ID пользователя в `dialogIds` создаёт личный диалог.** Если с пользователем ещё нет личного чата, вызов его создаёт и кладёт в папку. - **`dialogIds` работает начиная с обновления `im 26.1000.0`.** В облачном Битрикс24 оно уже установлено. Коробочный Битрикс24 без этого обновления пропускает `dialogIds` и не возвращает ошибку: вызов с одними `dialogIds` создаст пустую папку. На таком портале передавайте `chatIds`. - **Один неподходящий чат отклоняет весь состав.** Если пользователь не участник хотя бы одного чата из `chatIds` или `dialogIds`, вызов возвращает `FOLDER_CHAT_NOT_ELIGIBLE` и папка не создаётся, даже когда остальные чаты подходят. ## Смотрите также - [Папки чатов](/docs/chats/discovery/folders) - [Получить папку чатов](/docs/chats/management/folders-get) - [Изменить папку чатов](/docs/chats/management/folders-update) - [Удалить папку чатов](/docs/chats/management/folders-delete) - [Изменить порядок папок чатов](/docs/chats/management/folders-order) - [Добавить чаты в папку](/docs/chats/management/folder-chats) - [Убрать чаты из папки](/docs/chats/management/folder-chats-delete)