Добавить вложение в пункт чек-листа по содержимому tasks.template.checklist.addAttachmentByContent

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод: пользователь с правами на изменение шаблона задачи

Метод tasks.template.checklist.addAttachmentByContent добавляет вложение в пункт чек-листа по содержимому файла.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

templateId*
integer

Идентификатор шаблона задачи.

Идентификатор шаблона задачи можно получить при создании нового шаблона

checkListItemId*
integer

Идентификатор пункта чек-листа.

Идентификатор пункта чек-листа шаблона можно получить при создании нового пункта или методом получения списка пунктов

attachmentParameters*
object

Параметры создаваемого вложения (подробное описание)

Параметр attachmentParameters

Название
тип

Описание

NAME
string

Имя создаваемого файла

CONTENT
string

Содержимое файла в формате 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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

attachment_parameters = {
    "NAME": "dashboard-note.txt",
    "CONTENT": "RGFzaGJvYXJkIG5vdGU=",
}

try:
    bitrix_response = client.tasks.template.checklist.add_attachment_by_content(
        template_id=139,
        check_list_item_id=37,
        attachment_parameters=attachment_parameters,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
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
object

Объект с данными ответа (подробное описание).

Новый файл не отображается в ответе метода tasks.template.checklist.addAttachmentByContent в attachments. Чтобы получить данные о новом файле выполните метод tasks.template.checklist.get

time
time

Информация о времени выполнения запроса

Объект result

Название
тип

Описание

checkListItem
object

Пункт чек-листа после добавления вложения (подробное описание)

Объект checkListItem

Название
тип

Описание

id
integer

Идентификатор пункта чек-листа

copiedId
integer

Идентификатор исходного пункта при копировании, если есть

userId
integer

Идентификатор пользователя, в контексте которого сформирован объект

createdBy
integer

Идентификатор автора пункта

parentId
integer

Идентификатор родительского пункта. Значение 0 означает корневой пункт

title
string

Текст пункта чек-листа

sortIndex
integer

Индекс сортировки. Чем меньше значение, тем выше пункт в списке или подсписке

displaySortIndex
string

Вспомогательное значение порядка отображения

isComplete
boolean

Статус выполнения пункта

isImportant
boolean

Отметка важности пункта

completedCount
integer

Количество завершений пункта

members
array

Массив объектов с описанием участников.

Если данных нет, возвращается пустой массив []

attachments
object

Объект с описанием вложений.

Если данных нет, возвращается пустой массив []

nodeId
integer

Служебный идентификатор узла, если используется

templateId
integer

Идентификатор шаблона задачи

Объект members

Название
тип

Описание

id
string

Идентификатор пользователя

type
string

Роль пользователя в пункте чек-листа. Возможные значения:

  • A — соисполнитель
  • U — наблюдатель

name
string

Имя пользователя

personalPhoto
string

Идентификатор файла с аватаром пользователя на Диске

personalGender
string

Пол пользователя. Возможные значения:

  • M — мужчина
  • F — женщина

image
string

Ссылка на аватар пользователя

isCollaber
boolean

Признак, что пользователь является внешним участником

Объект attachments

Название
тип

Описание

attachmentId
string

Идентификатор файла на Диске в формате n<fileId>, где ключ — идентификатор прикрепления

Обработка ошибок

HTTP-статус: 400

{
    "error": "100",
    "error_description": "Could not find value for parameter {templateId}"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

100

Could not find value for parameter

Не передан обязательный параметр templateId

400

100

Bitrix\Tasks\CheckList\Internals\CheckList All parameters in the constructor must have real class type

Не передан обязательный параметр checkListItemId

400

100

Could not find value for parameter

Не передан или передан пустым обязательный параметр attachmentParameters

400

0

Произошла ошибка при добавлении вложения

Указан несуществующий или пустой checkListItemId

400

0

Изменение элемента: действие недоступно

У пользователя нет прав доступа на изменение шаблона задачи

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжить изучение