Для AI-агентов: markdown этой страницы — /docs-content/entities/task-comments/fields.md индекс документации — /llms.txt
Поля комментария
GET /v1/tasks/:taskId/comments/fields
Возвращает схему полей комментария задачи: для каждого из семи полей — тип, признак «только для чтения», отображаемое название и описание. Помогает автогенерации кода и подсказкам AI-агентам.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрtaskId (path) |
Типnumber | Обяз.да | ОписаниеID задачи. Значение не проверяется — схема одинакова для любого, включая несуществующую задачу |
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/tasks/289/comments/fields" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/tasks/289/comments/fields" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/289/comments/fields', {
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
})
const { success, data } = await res.json()
console.log('Поля комментария:', Object.keys(data.fields))
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/289/comments/fields', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { success, data } = await res.json()
Поля ответа
data.fields — объект, ключ которого — имя поля, а значение — { type, readonly, label, description }.
Подписи полей label и description приходят на русском языке. Заголовками запроса язык не переключается.
| Поле | Тип | RO | Описание |
|---|---|---|---|
Полеid |
Типnumber | ROда | ОписаниеИдентификатор комментария. Может прийти null в ответе создания на новой карточке |
ПолеtaskId |
Типnumber | ROда | ОписаниеИдентификатор родительской задачи. Берётся из пути URL |
ПолеauthorId |
Типnumber | ROда | ОписаниеАвтор комментария. Список сотрудников: GET /v1/users |
Полеmessage |
Типstring | RO | ОписаниеТекст комментария, до 65 535 символов. Единственное записываемое поле, обязателен при создании. Поддерживает BB-код |
ПолеcreatedAt |
Типdatetime | ROда | ОписаниеДата и время создания, UTC ISO 8601 |
Полеsource |
Типstring | ROда | ОписаниеХранилище, из которого пришёл комментарий: chat или legacy. Номера комментариев в двух хранилищах независимы, поэтому id значит комментарий только вместе с этим полем |
Полеattachments |
Типarray | ROда | ОписаниеФайлы, приложенные к комментарию. Ключ присутствует всегда, без файлов — пустой список. Элемент: fileId (число), name и size (когда Битрикс24 их отдал), downloadUrl (путь к байтам без домена) |
Поля с отметкой RO (readonly: true) заполняются платформой и не принимаются при создании и обновлении. Записывается только message.
Пример ответа
{
"success": true,
"data": {
"fields": {
"id": { "type": "number", "readonly": true, "label": "Идентификатор", "description": "Идентификатор комментария.", "nullable": true },
"taskId": { "type": "number", "readonly": true, "label": "Идентификатор задачи", "description": "Идентификатор родительской задачи (из пути запроса)." },
"authorId": { "type": "number", "readonly": true, "label": "Идентификатор автора", "description": "Идентификатор пользователя, оставившего комментарий, — из GET /v1/users." },
"message": { "type": "string", "readonly": false, "label": "Текст", "description": "Текст комментария. Обязателен при создании." },
"createdAt": { "type": "datetime", "readonly": true, "label": "Дата создания", "description": "Дата создания, UTC ISO 8601." },
"source": { "type": "string", "readonly": true, "label": "Хранилище", "description": "Хранилище, из которого пришёл комментарий: chat (новая карточка задачи) или legacy (домиграционные комментарии старой карточки). Номера комментариев в хранилищах независимы, поэтому передавайте это значение параметром ?source= в GET /v1/tasks/:taskId/comments/:id и при скачивании файла." },
"attachments": { "type": "array", "readonly": true, "label": "Вложения", "description": "Файлы, приложенные к комментарию. Ключ присутствует всегда; без файлов — пустой массив. Элемент: fileId (число), name (строка, когда Б24 его отдал), size (размер в байтах, когда Б24 его отдал), downloadUrl (строка, путь без домена — склейте с базовым URL API вашего портала)." }
}
}
}
Пример ответа при ошибке
403 — у ключа нет скоупа task:
{
"success": false,
"error": {
"code": "SCOPE_DENIED",
"message": "This endpoint requires 'task' scope"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP403 | КодSCOPE_DENIED |
ОписаниеAPI-ключ не имеет скоупа task |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеЗаголовок X-Api-Key не передан |
Полный список общих ошибок API — Ошибки.