Добавить регион documentgenerator.region.add

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: documentgenerator

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

Метод documentgenerator.region.add добавляет новый пользовательский регион.

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

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

Название
тип

Описание

fields*
object

Параметры региона (подробное описание)

Параметр fields

Название
тип

Описание

title*
string

Название региона

languageId
string

Идентификатор языка региона, например, ru

formatDate
string

Формат даты

formatDatetime
string

Формат даты и времени

formatName
string

Шаблон полного имени, например, #LAST_NAME# #NAME# #SECOND_NAME#.

Список возможных модификаторов:

  • #TITLE# — обращение
  • #NAME# — имя
  • #LAST_NAME# — фамилия
  • #SECOND_NAME# — отчество
  • #NAME_SHORT# — первая буква имени с точкой
  • #LAST_NAME_SHORT# — первая буква фамилии с точкой
  • #SECOND_NAME_SHORT# — первая буква отчества с точкой

Пользовательская документация

phrases
object

Набор локализованных фраз региона в формате код: текст.

Ключи объекта строковые и задаются произвольно в зависимости от шаблона. Значения ключей тоже строковые.

Чтобы понять, какие поля используются в шаблоне документа, получите их список методом documentgenerator.template.getfields. По этим полям удобно определить, для каких значений шаблона нужны свои языковые фразы.

Примеры:

  • TAX_INCLUDED: НДС включен в цену
  • TAX_NOT_INCLUDED: НДС не включен в цену

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "title": "Россия (Пользовательский)",
              "languageId": "ru",
              "formatDate": "DD.MM.YYYY",
              "formatDatetime": "DD.MM.YYYY HH:MI:SS",
              "formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
              "phrases": {
                "TAX_INCLUDED": "НДС включен в цену",
                "TAX_NOT_INCLUDED": "НДС не включен в цену"
              }
            }
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.region.add
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "title": "Россия (Пользовательский)",
              "languageId": "ru",
              "formatDate": "DD.MM.YYYY",
              "formatDatetime": "DD.MM.YYYY HH:MI:SS",
              "formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
              "phrases": {
                "TAX_INCLUDED": "НДС включен в цену",
                "TAX_NOT_INCLUDED": "НДС не включен в цену"
              }
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.region.add
        
try
        {
            const response = await $b24.callMethod(
                'documentgenerator.region.add',
                {
                    fields: {
                        title: 'Россия (Пользовательский)',
                        languageId: 'ru',
                        formatDate: 'DD.MM.YYYY',
                        formatDatetime: 'DD.MM.YYYY HH:MI:SS',
                        formatName: '#LAST_NAME# #NAME# #SECOND_NAME#',
                        phrases: {
                            TAX_INCLUDED: 'НДС включен в цену',
                            TAX_NOT_INCLUDED: 'НДС не включен в цену'
                        }
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service->core->call(
                'documentgenerator.region.add',
                [
                    'fields' => [
                        'title' => 'Россия (Пользовательский)',
                        'languageId' => 'ru',
                        'formatDate' => 'DD.MM.YYYY',
                        'formatDatetime' => 'DD.MM.YYYY HH:MI:SS',
                        'formatName' => '#LAST_NAME# #NAME# #SECOND_NAME#',
                        'phrases' => [
                            'TAX_INCLUDED' => 'НДС включен в цену',
                            'TAX_NOT_INCLUDED' => 'НДС не включен в цену',
                        ],
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'documentgenerator.region.add',
            {
                fields: {
                    title: 'Россия (Пользовательский)',
                    languageId: 'ru',
                    formatDate: 'DD.MM.YYYY',
                    formatDatetime: 'DD.MM.YYYY HH:MI:SS',
                    formatName: '#LAST_NAME# #NAME# #SECOND_NAME#',
                    phrases: {
                        TAX_INCLUDED: 'НДС включен в цену',
                        TAX_NOT_INCLUDED: 'НДС не включен в цену'
                    }
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.region.add',
            [
                'fields' => [
                    'title' => 'Россия (Пользовательский)',
                    'languageId' => 'ru',
                    'formatDate' => 'DD.MM.YYYY',
                    'formatDatetime' => 'DD.MM.YYYY HH:MI:SS',
                    'formatName' => '#LAST_NAME# #NAME# #SECOND_NAME#',
                    'phrases' => [
                        'TAX_INCLUDED' => 'НДС включен в цену',
                        'TAX_NOT_INCLUDED' => 'НДС не включен в цену',
                    ],
                ],
            ]
        );
        
        print_r($result);

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

HTTP-статус: 200

{
            "result": {
                "region": {
                    "id": "1",
                    "title": "Россия (Пользовательский)",
                    "languageId": "ru",
                    "formatDate": "DD.MM.YYYY",
                    "formatDatetime": "DD.MM.YYYY HH:MI:SS",
                    "formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
                    "phrases": {
                        "TAX_INCLUDED": "НДС включен в цену",
                        "TAX_NOT_INCLUDED": "НДС не включен в цену"
                    }
                }
            },
            "time": {
                "start": 1774431594,
                "finish": 1774431594.911013,
                "duration": 0.9110128879547119,
                "processing": 0,
                "date_start": "2026-03-25T12:39:54+03:00",
                "date_finish": "2026-03-25T12:39:54+03:00",
                "operating_reset_at": 1774432194,
                "operating": 0.23056697845458984
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа (подробное описание)

time
time

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

Объект result

Название
тип

Описание

region
object

Данные региона (подробное описание)

Объект region

Название
тип

Описание

id
string

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

title
string

Название региона

languageId
string

Идентификатор языка региона

formatDate
string

Формат даты

formatDatetime
string

Формат даты и времени

formatName
string

Шаблон полного имени

phrases
object

Набор фраз в формате код: текст, где ключи и значения строковые.

Примеры ключей: TAX_INCLUDED, TAX_NOT_INCLUDED

Список полей шаблона можно получить методом documentgenerator.template.getfields

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

400

100

Could not find value for parameter

Обязательный параметр fields не передан или передан пустым

400

BX_EMPTY_REQUIRED

Не заполнено обязательное поле "TITLE"

В параметре fields не передано обязательное поле title

400

0

You do not have permissions to modify templates

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

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

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

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

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

Предыдущая
Обзор методов
Следующая
Изменить регион