Добавить вложение в пункт чек-листа по содержимому tasks.template.checklist.addAttachmentByContent
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
taskКто может выполнять метод: пользователь с правами на изменение шаблона задачи
Метод tasks.template.checklist.addAttachmentByContent добавляет вложение в пункт чек-листа по содержимому файла.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
templateId* |
Идентификатор шаблона задачи. Идентификатор шаблона задачи можно получить при создании нового шаблона |
|
checkListItemId* |
Идентификатор пункта чек-листа. Идентификатор пункта чек-листа шаблона можно получить при создании нового пункта или методом получения списка пунктов |
|
attachmentParameters* |
Параметры создаваемого вложения (подробное описание) |
Параметр attachmentParameters
|
Название |
Описание |
|
NAME |
Имя создаваемого файла |
|
CONTENT |
Содержимое файла в формате base64 |
Частые кейсы и сценарии
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"templateId": 139,
"checkListItemId": 37,
"attachmentParameters": {
"NAME": "dashboard-note.txt",
"CONTENT": "RGFzaGJvYXJkIG5vdGU="
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.template.checklist.addAttachmentByContent
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"templateId": 139,
"checkListItemId": 37,
"attachmentParameters": {
"NAME": "dashboard-note.txt",
"CONTENT": "RGFzaGJvYXJkIG5vdGU="
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/tasks.template.checklist.addAttachmentByContent
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CheckListItemResult = {
checkListItem: {
id: number
copiedId: number | null
userId: number
createdBy: number | null
parentId: number
title: string
sortIndex: number
displaySortIndex: string
isComplete: boolean
isImportant: boolean
completedCount: number
members: Array<{
id: string
type: string
name: string
personalPhoto: string
personalGender: string
image: string
isCollaber: boolean
}>
attachments: unknown[]
nodeId: number | null
templateId: number
}
}
try {
const response = await $b24.actions.v2.call.make<CheckListItemResult>({
method: 'tasks.template.checklist.addAttachmentByContent',
params: {
templateId: 139,
checkListItemId: 37,
attachmentParameters: {
NAME: 'dashboard-note.txt',
CONTENT: 'RGFzaGJvYXJkIG5vdGU=',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.checkListItem.id, result.checkListItem.title)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addAttachmentByContent() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'tasks.template.checklist.addAttachmentByContent',
params: {
templateId: 139,
checkListItemId: 37,
attachmentParameters: {
NAME: 'dashboard-note.txt',
CONTENT: 'RGFzaGJvYXJkIG5vdGU=',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.checkListItem.id, result.checkListItem.title)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addAttachmentByContent)
</script>
try {
$response = $b24Service
->core
->call(
'tasks.template.checklist.addAttachmentByContent',
[
'templateId' => 139,
'checkListItemId' => 37,
'attachmentParameters' => [
'NAME' => 'dashboard-note.txt',
'CONTENT' => 'RGFzaGJvYXJkIG5vdGU='
]
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'tasks.template.checklist.addAttachmentByContent',
{
templateId: 139,
checkListItemId: 37,
attachmentParameters: {
NAME: 'dashboard-note.txt',
CONTENT: 'RGFzaGJvYXJkIG5vdGU='
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.template.checklist.addAttachmentByContent',
[
'templateId' => 139,
'checkListItemId' => 37,
'attachmentParameters' => [
'NAME' => 'dashboard-note.txt',
'CONTENT' => 'RGFzaGJvYXJkIG5vdGU='
]
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.template.checklist.addAttachmentByContent", b24.Params{
"templateId": 139,
"checkListItemId": 37,
"attachmentParameters": b24.Params{
"NAME": "dashboard-note.txt",
"CONTENT": "RGFzaGJvYXJkIG5vdGU=",
},
})
if err != nil {
return fmt.Errorf("tasks.template.checklist.addAttachmentByContent: %w", err)
}
// Метод заворачивает ответ в объект с ключом "checkListItem".
raw, ok := b24.Unwrap(res.Result, "checkListItem")
if !ok {
return fmt.Errorf("в ответе нет ключа checkListItem")
}
var item struct {
ID b24.ID `json:"id"`
UserID b24.ID `json:"userId"`
ParentID b24.ID `json:"parentId"`
Title string `json:"title"`
SortIndex int `json:"sortIndex"`
DisplaySortIndex string `json:"displaySortIndex"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.UserID)
Обработка ответа
HTTP-статус: 200
{
"result": {
"checkListItem": {
"id": 37,
"copiedId": null,
"userId": 503,
"createdBy": null,
"parentId": 23,
"title": "4. Подготовить дашборд и отправить ссылку",
"sortIndex": 2,
"displaySortIndex": "",
"isComplete": false,
"isImportant": true,
"completedCount": 0,
"members": [
{
"id": "547",
"type": "A",
"name": "Анна Петрова",
"personalPhoto": "57129",
"personalGender": "",
"image": "https://mysite.ru/b17053/resize_cache/57129/c0120a8d7c10d63c83e32398d1ec4d9e/main/137/137bfa78b877be117e75f1ac8652834a/anna.png",
"isCollaber": false
}
],
"attachments": [],
"nodeId": null,
"templateId": 139
}
},
"time": {
"start": 1773303072,
"finish": 1773303072.349161,
"duration": 0.34916090965270996,
"processing": 0,
"date_start": "2026-03-12T11:11:12+03:00",
"date_finish": "2026-03-12T11:11:12+03:00",
"operating_reset_at": 1773303672,
"operating": 0.2779998779296875
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа (подробное описание). Новый файл не отображается в ответе метода |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
checkListItem |
Пункт чек-листа после добавления вложения (подробное описание) |
Объект checkListItem
|
Название |
Описание |
|
id |
Идентификатор пункта чек-листа |
|
copiedId |
Идентификатор исходного пункта при копировании, если есть |
|
userId |
Идентификатор пользователя, в контексте которого сформирован объект |
|
createdBy |
Идентификатор автора пункта |
|
parentId |
Идентификатор родительского пункта. Значение |
|
title |
Текст пункта чек-листа |
|
sortIndex |
Индекс сортировки. Чем меньше значение, тем выше пункт в списке или подсписке |
|
displaySortIndex |
Вспомогательное значение порядка отображения |
|
isComplete |
Статус выполнения пункта |
|
isImportant |
Отметка важности пункта |
|
completedCount |
Количество завершений пункта |
|
members |
Массив объектов с описанием участников. Если данных нет, возвращается пустой массив |
|
attachments |
Объект с описанием вложений. Если данных нет, возвращается пустой массив |
|
nodeId |
Служебный идентификатор узла, если используется |
|
templateId |
Идентификатор шаблона задачи |
Объект members
|
Название |
Описание |
|
id |
Идентификатор пользователя |
|
type |
Роль пользователя в пункте чек-листа. Возможные значения:
|
|
name |
Имя пользователя |
|
personalPhoto |
Идентификатор файла с аватаром пользователя на Диске |
|
personalGender |
Пол пользователя. Возможные значения:
|
|
image |
Ссылка на аватар пользователя |
|
isCollaber |
Признак, что пользователь является внешним участником |
Объект attachments
|
Название |
Описание |
|
attachmentId |
Идентификатор файла на Диске в формате |
Обработка ошибок
HTTP-статус: 400
{
"error": "100",
"error_description": "Could not find value for parameter {templateId}"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Could not find value for parameter |
Не передан обязательный параметр |
|
|
|
Bitrix\Tasks\CheckList\Internals\CheckList All parameters in the constructor must have real class type |
Не передан обязательный параметр |
|
|
|
Could not find value for parameter |
Не передан или передан пустым обязательный параметр |
|
|
|
Произошла ошибка при добавлении вложения |
Указан несуществующий или пустой |
|
|
|
Изменение элемента: действие недоступно |
У пользователя нет прав доступа на изменение шаблона задачи |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжить изучение
- Добавить пункт чек-листа в шаблон задачи tasks.template.checklist.add
- Обновить пункт чек-листа шаблона задачи tasks.template.checklist.update
- Получить пункт чек-листа шаблона задачи tasks.template.checklist.get
- Получить список пунктов чек-листа шаблона задачи tasks.template.checklist.list
- Удалить пункт чек-листа шаблона задачи tasks.template.checklist.delete
- Переместить пункт чек-листа после другого tasks.template.checklist.moveAfter
- Переместить пункт чек-листа перед другим tasks.template.checklist.moveBefore
- Завершить пункт чек-листа шаблона задачи tasks.template.checklist.complete
- Возобновить пункт чек-листа шаблона задачи tasks.template.checklist.renew
- Добавить вложения из Диска в пункт чек-листа tasks.template.checklist.addAttachmentsFromDisk
- Удалить вложения из пункта чек-листа tasks.template.checklist.removeAttachments