Установить набор дополнительных контентных блоков в запись таймлайна crm.timeline.layout.blocks.set

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

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

Scope: crm

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

Метод crm.timeline.layout.blocks.set устанавливает набор дополнительных контентных блоков для записи таймлайна.

Установка нового набора дополнительных контентных блоков в запись таймлайна будет стирать ранее добавленный набор в рамках одного приложения.

Установка набора дополнительных контентных блоков не может быть применена к записям таймлайна, относящимся к:

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

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

Название
тип

Описание

entityTypeId*
integer

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

entityId*
integer

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

timelineId*
integer

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

layout*
RestAppLayoutDto

Объект, описывающий набор дополнительных контентных блоков

Особенности отображения

Если запись таймлайна содержит более одного набора дополнительных контентных блоков, они выводятся в порядке добавления

В HTML-верстке data-атрибуты показывают, каким приложением добавлен набор дополнительных контентных блоков:

  • data-app-name: название приложения
  • data-rest-client-id: идентификатор приложения

Примеры кода

В запись таймлайна с id = 8, привязанную к сделке с id = 4, установим следующий набор дополнительных контентных блоков:

  1. Текст
  2. Длинный многострочный текст
  3. Ссылка
  4. Блок с заголовком

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"entityId":4,"timelineId":8,"layout":{"blocks":{"block_1":{"type":"text","properties":{"value":"Здравствуйте!\nМы начинаем.","multiline":true,"bold":true,"color":"base_90"}},"block_2":{"type":"largeText","properties":{"value":"Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания."}},"block_3":{"type":"link","properties":{"text":"Открыть сделку","bold":true,"action":{"type":"redirect","uri":"/crm/deal/details/123/"}}},"block_4":{"type":"withTitle","properties":{"title":"Заголовок","block":{"type":"text","properties":{"value":"Какое-то значение"}}}}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.layout.blocks.set
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"entityId":4,"timelineId":8,"layout":{"blocks":{"block_1":{"type":"text","properties":{"value":"Здравствуйте!\nМы начинаем.","multiline":true,"bold":true,"color":"base_90"}},"block_2":{"type":"largeText","properties":{"value":"Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания."}},"block_3":{"type":"link","properties":{"text":"Открыть сделку","bold":true,"action":{"type":"redirect","uri":"/crm/deal/details/123/"}}},"block_4":{"type":"withTitle","properties":{"title":"Заголовок","block":{"type":"text","properties":{"value":"Какое-то значение"}}}}}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.timeline.layout.blocks.set
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.timeline.layout.blocks.set',
        		{
        			entityTypeId: 2, // Сделка
        			entityId: 4,     // ID сделки
        			timelineId: 8,   // ID записи таймлайна, привязанной к данной сделке
        			layout: layout,  // Объект, описывающий набор дополнительных контентных блоков
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.timeline.layout.blocks.set',
                    [
                        'entityTypeId' => 2, // Сделка
                        'entityId'     => 4, // ID сделки
                        'timelineId'   => 8, // ID записи таймлайна, привязанной к данной сделке
                        'layout'       => [
                            'blocks' => [
                                'block_1' => [
                                    'type'       => "text",
                                    'properties' => [
                                        'value'     => "Здравствуйте!\nМы начинаем.",
                                        'multiline' => true,
                                        'bold'      => true,
                                        'color'     => "base_90"
                                    ]
                                ],
                                'block_2' => [
                                    'type'       => "largeText",
                                    'properties' => [
                                        'value' => "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания."
                                    ]
                                ],
                                'block_3' => [
                                    'type'       => "link",
                                    'properties' => [
                                        'text'     => "Открыть сделку",
                                        'bold'     => true,
                                        'action'   => [
                                            'type' => "redirect",
                                            'uri'  => "/crm/deal/details/123/"
                                        ]
                                    ]
                                ],
                                'block_4' => [
                                    'type'       => "withTitle",
                                    'properties' => [
                                        'title'   => "Заголовок",
                                        'block'   => [
                                            'type'       => "text",
                                            'properties' => [
                                                'value' => "Какое-то значение"
                                            ]
                                        ]
                                    ]
                                ]
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error setting timeline layout blocks: ' . $e->getMessage();
        }
        
const layout = {
            blocks: {
                'block_1': {
                    type: "text",
                    properties: {
                        value: "Здравствуйте!\nМы начинаем.",
                        multiline: true,
                        bold: true,
                        color: "base_90"
                    }
                },
                'block_2': {
                    type: "largeText",
                    properties: {
                        value: "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания."
                    }
                },
                'block_3': {
                    type: "link",
                    properties: {
                        text: "Открыть сделку",
                        bold: true,
                        action: {
                            type: "redirect",
                            uri: "/crm/deal/details/123/"
                        }
                    }
                },
                'block_4': {
                    type: "withTitle",
                    properties: {
                        title: "Заголовок",
                        block: {
                            type: "text",
                            properties: {
                                value: "Какое-то значение"
                            }
                        }
                    }
                }
            }
        };
        BX24.callMethod(
            'crm.timeline.layout.blocks.set',
            {
                entityTypeId: 2, // Сделка
                entityId: 4,     // ID сделки
                timelineId: 8,   // ID записи таймлайна, привязанной к данной сделке
                layout: layout,  // Объект, описывающий набор дополнительных контентных блоков
            },
            (result) => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            },
        );
        
require_once('crest.php');
        $result = CRest::call(
            'crm.timeline.layout.blocks.set',
            [
                'entityTypeId' => 2,
                'entityId' => 4,
                'timelineId' => 8,
                'layout' => [
                    'blocks' => [
                        'block_1' => [
                            'type' => "text",
                            'properties' => [
                                'value' => "Здравствуйте!\nМы начинаем.",
                                'multiline' => true,
                                'bold' => true,
                                'color' => "base_90"
                            ]
                        ],
                        'block_2' => [
                            'type' => "largeText",
                            'properties' => [
                                'value' => "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания."
                            ]
                        ],
                        'block_3' => [
                            'type' => "link",
                            'properties' => [
                                'text' => "Открыть сделку",
                                'bold' => true,
                                'action' => [
                                    'type' => "redirect",
                                    'uri' => "/crm/deal/details/123/"
                                ]
                            ]
                        ],
                        'block_4' => [
                            'type' => "withTitle",
                            'properties' => [
                                'title' => "Заголовок",
                                'block' => [
                                    'type' => "text",
                                    'properties' => [
                                        'value' => "Какое-то значение"
                                    ]
                                ]
                            ]
                        ]
                    ]
                ]
            ]
        );
        echo '';
        print_r($result);
        echo '';
        

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "success": true
            },
            "time": {
                "start": 1753341040.475739,
                "finish": 1753341040.582705,
                "duration": 0.10696601867675781,
                "processing": 0.04708504676818848,
                "date_start": "2025-07-24T17:57:20+00:00",
                "date_finish": "2025-07-24T17:57:20+00:00",
                "operating": 0
            }
        }
        

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа. При успешном выполнении содержит объект с полем success. Если набор не установлен, возвращается null

time
time

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

Объект result

Название
тип

Описание

success
boolean

Результат установки набора дополнительных контентных блоков. Поле возвращается при успешном выполнении метода и имеет значение true

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

HTTP-статус: 400

{
            "error": "ERROR_WRONG_CONTEXT",
            "error_description": "Вызов метода возможен только в контексте rest приложения"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

ERROR_WRONG_CONTEXT

Вызов метода возможен только в контексте rest приложения

OWNER_NOT_FOUND

Элемент, к которому привязана запись таймлайна, не найден

NOT_FOUND

Запись таймлайна не найдена

ACCESS_DENIED

Доступ запрещен

UNSUITABLE_TIMELINE_ITEM

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

FIELD_IS_REQUIRED

Поле blocks в RestAppLayoutDto должно быть заполнено.

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

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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