Получить набор дополнительных контентных блоков дела crm.activity.layout.blocks.get

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

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

Scope: crm

Кто может выполнять метод: любой пользователь с правом на чтение элемента CRM, к которому привязано дело

Метод crm.activity.layout.blocks.get получает набор дополнительных контентных блоков дела.

Метод работает только в контексте приложения: при вызове через вебхук он вернет ошибку ERROR_WRONG_CONTEXT. Приложение видит только тот набор блоков, который установило само методом crm.activity.layout.blocks.set.

Метод работает только с делами. Чтобы получить набор блоков комментария или другой записи таймлайна, используйте crm.timeline.layout.blocks.get.

Если дело привязано сразу к нескольким элементам CRM, набор блоков остается один. Передайте в entityTypeId и entityId тип и идентификатор любого из связанных элементов.

Порядок вызова методов и общие правила работы с наборами блоков описаны в обзоре раздела.

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

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

Название
тип

Описание

entityTypeId*
integer

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

entityId*
integer

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

activityId*
integer

Идентификатор дела. Возвращают методы crm.activity.add и crm.activity.list

Примеры кода

Получить набор дополнительных контентных блоков дела с id = 8, привязанного к сделке с id = 4.

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"entityId":4,"activityId":8,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.layout.blocks.get
// 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 LayoutBlocksGetResult = {
  // layout is null when the app has not set any blocks for this activity
  layout: null | {
    blocks: Record<string, {
      type: string
      properties: Record<string, unknown>
    }>
  }
}

try {
  const response = await $b24.actions.v2.call.make<LayoutBlocksGetResult>({
    method: 'crm.activity.layout.blocks.get',
    params: {
      entityTypeId: 2,
      entityId: 4,
      activityId: 8,
    },
    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('Layout blocks:', result.layout?.blocks)
  }
} 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 getLayoutBlocks() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.activity.layout.blocks.get',
        params: {
          entityTypeId: 2,
          entityId: 4,
          activityId: 8,
        },
        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
      // layout is null when the app has not set any blocks for this activity
      console.info('Layout blocks:', result.layout?.blocks)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getLayoutBlocks)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.activity.layout.blocks.get(
        entity_type_id=2,
        entity_id=4,
        activity_id=8,
    ).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(
            'crm.activity.layout.blocks.get',
            [
                'entityTypeId' => 2,
                'entityId'     => 4,
                'activityId'   => 8,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Info: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting activity layout blocks: ' . $e->getMessage();
}
BX24.callMethod(
    'crm.activity.layout.blocks.get',
    {
        entityTypeId: 2, // Сделка
        entityId: 4,     // ID Сделки
        activityId: 8,   // ID Дела привязанного к данной сделке
    },
    (result) => {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    },
);
require_once('crest.php');
$result = CRest::call(
    'crm.activity.layout.blocks.get',
    [
        'entityTypeId' => 2,
        'entityId' => 4,
        'activityId' => 8
    ]
);
echo '';
print_r($result);
echo '';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.layout.blocks.get", b24.Params{
	"entityTypeId": 2,
	"entityId":     4,
	"activityId":   8,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.activity.layout.blocks.get: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

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

HTTP-статус: 200

{
    "result": {
        "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": "Какое-то значение"
                            }
                        }
                    }
                }
            }
        }
    },
    "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": {
        "layout": null
    },
    "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

Корневой элемент ответа (подробное описание). Если получить набор блоков не удалось, метод возвращает не result, а объект error — смотрите раздел «Обработка ошибок»

time
time

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

Объект result

Название
тип

Описание

layout
RestAppLayoutDto

Набор дополнительных контентных блоков, установленный в дело текущим приложением (подробное описание). Если приложение не устанавливало набор блоков в это дело, поле имеет значение null

Объект layout

Название
тип

Описание

blocks
object

Ассоциативный массив контентных блоков в том виде, в каком их передало приложение в crm.activity.layout.blocks.set. Ключ — идентификатор блока, заданный приложением. Значение — объект с полями type и properties

Поле type принимает одно из значений text, largeText, link, deadline, withTitle, lineOfBlocks. Состав properties зависит от типа блока и описан в структуре ContentBlockDto.

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

ERROR_WRONG_CONTEXT

Вызов метода возможен только в контексте rest приложения. Метод вызван через вебхук

OWNER_NOT_FOUND

Элемент, к которому привязано дело, не найден. Передан неизвестный entityTypeId или дело не привязано к элементу с указанным entityId

NOT_FOUND

Дело с указанным activityId не найдено

ACCESS_DENIED

У пользователя нет права на чтение элемента CRM, к которому привязано дело

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

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

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

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