Получить список включаемых областей для страницы landing.template.getLandingRef
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
landingКто может выполнять метод: пользователь с правом «просмотр» сайта
Метод landing.template.getLandingRef получает список включаемых областей, которые привязаны к странице.
В ответ входят только привязки, сохраненные для страницы. Привязки, которые настроены на уровне сайта, метод не возвращает. Чтобы получить их, используйте метод landing.template.getSiteRef.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор страницы. Идентификатор страницы можно получить методом landing.landing.getList |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 557
}' \
"https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.template.getLandingRef.json"
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 557,
"auth": "**put_access_token_here**"
}' \
"https://**put.your-domain-here**/rest/landing.template.getLandingRef.json"
// 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 LandingRefResult = Record<string, number> | true
try {
const response = await $b24.actions.v2.call.make<LandingRefResult>({
method: 'landing.template.getLandingRef',
params: {
id: 557,
},
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
if (result === true) {
console.info('No landing refs configured')
} else {
console.info('Landing refs:', result, 'Area count:', Object.keys(result).length)
}
}
} 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 getLandingRef() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.template.getLandingRef',
params: {
id: 557,
},
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
if (result === true) {
console.info('No landing refs configured')
} else {
console.info('Landing refs:', result, 'Area count:', Object.keys(result).length)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getLandingRef)
</script>
try {
$response = $b24Service
->core
->call(
'landing.template.getLandingRef',
[
'id' => 557,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting landing refs: ' . $e->getMessage();
}
BX24.callMethod(
'landing.template.getLandingRef',
{
id: 557
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'landing.template.getLandingRef',
[
'id' => 557,
]
);
if (isset($result['error']))
{
echo 'Ошибка: ' . $result['error_description'];
}
else
{
echo '<pre>';
print_r($result['result']);
echo '</pre>';
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "landing.template.getLandingRef", b24.Params{
"id": 557,
})
if err != nil {
return fmt.Errorf("landing.template.getLandingRef: %w", err)
}
var item struct {
F1 int `json:"1"`
F2 int `json:"2"`
F3 int `json:"3"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.F1, item.F2)
Обработка ответа
HTTP-статус: 200
Если для страницы настроены включаемые области, метод вернет объект со списком этих привязок. В нем для каждой области указан идентификатор страницы, которая к ней привязана.
Если для страницы не сохранены привязки включаемых областей, метод возвращает true.
{
"result": {
"1": 614,
"2": 615,
"3": 616
},
"time": {
"start": 1774765200,
"finish": 1774765200.411258,
"duration": 0.4112579822540283,
"processing": 0,
"date_start": "2026-03-29T10:00:00+03:00",
"date_finish": "2026-03-29T10:00:00+03:00",
"operating_reset_at": 1774765800,
"operating": 0
}
}
{
"result": true,
"time": {
"start": 1774874736,
"finish": 1774874736.085915,
"duration": 0.08591508865356445,
"processing": 0,
"date_start": "2026-03-30T15:45:36+03:00",
"date_finish": "2026-03-30T15:45:36+03:00",
"operating_reset_at": 1774875336,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
Привязки включаемых областей страницы в формате Если для страницы сохранены привязки, метод возвращает объект. Если привязок нет, метод возвращает |
|
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
<ID_ОБЛАСТИ> |
Идентификатор включаемой области шаблона. Значение по этому ключу содержит идентификатор страницы, назначенной в эту область |
Обработка ошибок
HTTP-статус: 400
{
"error": "ENTITY_NOT_FOUND",
"error_description": "Сущность не найдена"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Не передан обязательный параметр |
|
|
Страница не найдена или недоступна |
|
|
Недостаточно прав для просмотра сайта |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |