Комментарии задач

Комментарии — вложенный ресурс задачи. У каждого комментария есть автор, текст и время создания. Базовый путь — /v1/tasks/:taskId/comments. Все операции требуют существующей задачи (:taskId) на портале.

Битрикс24 API: tasks.task.chat.message.*, task.commentitem.* Скоуп: task

Создать комментарий

POST /v1/tasks/:taskId/comments

Добавляет комментарий к задаче. На новой карточке задачи сообщение отправляется в чат, на старой — попадает в блок комментариев в самой карточке.

Параметры

Параметр Тип Обяз. Описание
taskId (path) number да ID задачи

Поля запроса (body)

Поле Тип Обяз. Описание
message string ★ Текст комментария, до 65 535 символов. Поддерживает BB-код ([USER=ID]Имя[/USER], [B]...[/B], [QUOTE]...[/QUOTE])

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/289/comments" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Добавил черновик отчёта — посмотри, пожалуйста."
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/289/comments" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Добавил черновик отчёта — посмотри, пожалуйста."
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/289/comments', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Добавил черновик отчёта — посмотри, пожалуйста.',
  }),
})

const { success, data } = await res.json()
console.log('ID нового комментария:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/tasks/289/comments', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'Добавил черновик отчёта — посмотри, пожалуйста.',
  }),
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number | null Идентификатор нового комментария. На новой карточке возвращается id чат-сообщения, в редком случае может быть null — см. «Известные особенности»

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

HTTP 201 Created:

JSON 
{
  "success": true,
  "data": {
    "id": 36559
  }
}

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

400 — пустой или отсутствующий message:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`message` is required and must be a string"
  }
}

404 — задача не существует или недоступна:

JSON 
{
  "success": false,
  "error": {
    "code": "TASK_NOT_FOUND",
    "message": "Bitrix24 did not create the comment (returned false). Task 99999999 may not exist or may not be accessible."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS taskId не положительное целое
400 INVALID_PARAMS Поле message отсутствует или не является строкой
400 INVALID_PARAMS message превышает лимит длины
403 SCOPE_DENIED API-ключ не имеет скоупа task
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
404 TASK_NOT_FOUND Задача taskId не существует или недоступна ключу — Битрикс24 не создал комментарий

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

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

data.id изредка бывает null при успехе (success: true). На новой карточке задачи комментарий уходит в чат (tasks.task.chat.message.send), а id восстанавливается отдельным поиском по последним сообщениям чата. Если восстановить id не удалось (сообщение не нашлось в окне поиска), комментарий уже создан, но ответ возвращает id: null — это не ошибка, повторный запрос создаст дубликат. Если же Битрикс24 в принципе не создал комментарий (задача не существует или недоступна), это отдельный случай — API возвращает 404 TASK_NOT_FOUND, а не 201 с id: null.

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