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

Форма потока

GET /v1/chats/:dialogId/flow-form

Данные для формы создания потока задач из коллаба: ID рабочей группы коллаба. Поток не создаётся — форму заполняет пользователь в Битрикс24.

Работает только для коллабов.

Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да ID диалога коллаба: chat123 — поле dialogId строки списка коллаб

Параметров запроса нет: любой параметр отклоняется с 400 INVALID_PARAMS.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/chats/chat42/flow-form" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

const { data } = await res.json()
console.log('Группа коллаба:', data.groupId)

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

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

const { data } = await res.json()
console.log('Группа коллаба:', data.groupId)

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.groupId number ID рабочей группы коллаба — в ней будет создан поток

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

JSON 
{
  "success": true,
  "data": { "groupId": 57 }
}

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

422 — чат не коллаб:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Chat type is not supported",
    "b24Code": "CHAT_TYPE_NOT_SUPPORTED"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Передан параметр запроса — операция их не принимает
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ работает только на чтение: вызов может сделать владельца ключа участником чата
404 ENTITY_NOT_FOUND Битрикс24 вернул «не найдено». Код портала — в error.b24Code
422 BITRIX_ERROR Битрикс24 вернул ошибку. Код портала — в error.b24Code. CHAT_TYPE_NOT_SUPPORTED — чат не коллаб
502 ME_ALIAS_RESOLUTION_FAILED Не удалось определить текущего пользователя для me
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

Полный список общих ошибок API — Ошибки.

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