Получить дополнительные поля сайта landing.site.getadditionalfields

Scope: landing

Кто может выполнять метод: пользователь с правом «просмотр» сайта

Метод landing.site.getadditionalfields получает дополнительные поля сайта.

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

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

Название
тип

Описание

id*
integer

Идентификатор сайта.

Идентификатор сайта можно получить с помощью метода landing.site.getList или из результата метода landing.site.add

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 205
          }' \
          "https://**put.your-domain-here**/rest/**user_id**/**webhook_code**/landing.site.getadditionalfields.json"
        
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "id": 205,
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/landing.site.getadditionalfields.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'landing.site.getadditionalfields',
        		{
        			id: 205
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.site.getadditionalfields',
                    [
                        'id' => 205,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting additional fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.site.getadditionalfields',
            {
                id: 205
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.site.getadditionalfields',
            [
                'id' => 205,
            ]
        );
        
        if (isset($result['error']))
        {
            echo 'Ошибка: ' . $result['error_description'];
        }
        else
        {
            echo '<pre>';
            print_r($result['result']);
            echo '</pre>';
        }

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

HTTP-статус: 200

Ниже приведен сокращенный пример ответа. Фактический набор полей зависит от настроек конкретного сайта.

{
            "result": {
                "COOKIES_USE": "Y",
                "COOKIES_AGREEMENT_ID": "19",
                "COOKIES_COLOR_BG": "#03c1fe",
                "COOKIES_COLOR_TEXT": "#fff",
                "COOKIES_POSITION": "bottom_left",
                "COOKIES_MODE": "I",
                "B24BUTTON_CODE": "https://cdn-ru.bitrix24.ru/b13743910/crm/site_button/loader_1_68znkz.js",
                "B24BUTTON_COLOR": "site",
                "B24BUTTON_COLOR_VALUE": "#03c1fe",
                "COPYRIGHT_SHOW": "Y",
                "COPYRIGHT_CODE": "6",
                "SETTINGS_PRICE_CODE": [
                    "BASE"
                ],
                "SETTINGS_SHOW_PRICE_COUNT": 1,
                "SETTINGS_CURRENCY_ID": "RUB",
                "SPEED_USE_LAZY": "Y",
                "THEME_CODE": "1construction",
                "THEME_COLOR": "#f7b70b",
                "YACOUNTER_USE": "Y",
                "YACOUNTER_COUNTER": "73521121",
                "ROBOTS_USE": "Y",
                "ROBOTS_CONTENT": "Disallow: /preview/*",
                "CSSBLOCK_USE": "N",
                "HEADBLOCK_USE": "N"
            },
            "time": {
                "start": 1773278929,
                "finish": 1773278929.806224,
                "duration": 0.8062241077423096,
                "processing": 0,
                "date_start": "2026-03-12T04:28:49+03:00",
                "date_finish": "2026-03-12T04:28:49+03:00",
                "operating_reset_at": 1773279529,
                "operating": 0.11928892135620117
            }
        }

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

Название
тип

Описание

result
object | array | null

Набор дополнительных полей сайта в формате {"<КОД_ПОЛЯ>": "<ЗНАЧЕНИЕ>"}.

Если доступных полей нет, метод может вернуть null или пустой массив [] (подробное описание)

time
time

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

Объект result

Название
тип

Описание

<КОД_ПОЛЯ>
string | integer | boolean | array | object

Пара «код поля → значение поля».

Значение может быть строкой ("Y", "#03c1fe"), числом (1) или массивом (например, ["BASE"]).

Состав и тип значения зависят от конкретного дополнительного поля. Доступные коды полей описаны в списке дополнительных полей сайта

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

HTTP-статус: 400

{
            "error": "MISSING_PARAMS",
            "error_description": "Недостаточно параметров вызова, пропущены: id"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

MISSING_PARAMS

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

ACCESS_DENIED

Недостаточно прав для вызова метода

TYPE_ERROR

Ошибка типа данных в параметрах вызова метода

SYSTEM_ERROR

Внутренняя ошибка при выполнении метода

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

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

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

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

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

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

Предыдущая
Получить публичный URL сайта
Следующая
Пометить сайт как удаленный