Получить список регионов documentgenerator.region.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
documentgeneratorКто может выполнять метод: пользователь с правом на изменение шаблонов генератора документов
Метод documentgenerator.region.list возвращает список предустановленных и пользовательских регионов.
Параметры метода
Без параметров.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Accept: application/json" \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.region.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/documentgenerator.region.list
// 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
type RegionItem = {
id?: string
code: string
title: string
languageId: string
formatDate?: string
formatDatetime?: string
formatName?: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type RegionsResult = {
regions: Record<string, RegionItem>
}
try {
const response = await $b24.actions.v2.call.make<RegionsResult>({
method: 'documentgenerator.region.list',
params: {},
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(Object.keys(result.regions).length, result.regions)
}
} 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 fetchRegionList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'documentgenerator.region.list',
params: {},
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
console.info(Object.keys(result.regions).length, result.regions)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchRegionList)
</script>
try {
$response = $b24Service->core->call('documentgenerator.region.list');
$result = $response->getResponseData()->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'documentgenerator.region.list',
{},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call('documentgenerator.region.list');
print_r($result);
Обработка ответа
HTTP-статус: 200
В ответе могут быть два типа элементов:
- предустановленный регион, у которого обычно есть
code,title,languageId - пользовательский регион, у которого дополнительно могут быть
id,formatDate,formatDatetime,formatName
{
"result": {
"regions": {
"ru": {
"code": "ru",
"title": "Россия",
"languageId": "ru"
},
"by": {
"code": "by",
"title": "Беларусь",
"languageId": "ru"
},
"kz": {
"code": "kz",
"title": "Казахстан",
"languageId": "kz"
},
"ua": {
"code": "ua",
"title": "Украина",
"languageId": "ua"
},
"de": {
"code": "de",
"title": "Германия",
"languageId": "de"
},
"uk": {
"code": "uk",
"title": "Великобритания",
"languageId": "en"
},
"br": {
"code": "br",
"title": "Бразилия",
"languageId": "br"
},
"sp": {
"code": "sp",
"title": "Испания",
"languageId": "la"
},
"mx": {
"code": "mx",
"title": "Мексика",
"languageId": "la"
},
"pl": {
"code": "pl",
"title": "Польша",
"languageId": "pl"
},
"fr": {
"code": "fr",
"title": "Франция",
"languageId": "fr"
},
"1": {
"id": "1",
"title": "Россия (Пользовательский)",
"languageId": "ru",
"formatDate": "DD.MM.YYYY",
"formatDatetime": "DD.MM.YYYY HH:MI:SS",
"formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
"code": "1"
}
}
},
"time": {
"start": 1774431603,
"finish": 1774431603.769177,
"duration": 0.7691769599914551,
"processing": 0,
"date_start": "2026-03-25T12:40:03+03:00",
"date_finish": "2026-03-25T12:40:03+03:00",
"operating_reset_at": 1774432203,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
regions |
Список регионов, где ключ объекта это |
Объект regions
Объект regions может содержать как предустановленные, так и пользовательские регионы.
- Для предустановленного региона обычно доступны поля
code,title,languageId - Для пользовательского региона дополнительно могут возвращаться
id,formatDate,formatDatetime,formatName
|
Название |
Описание |
|
id |
Идентификатор пользовательского региона, для предустановленного региона поле может отсутствовать |
|
code |
Код региона |
|
title |
Название региона |
|
languageId |
Идентификатор языка региона |
|
formatDate |
Формат даты для пользовательского региона |
|
formatDatetime |
Формат даты и времени для пользовательского региона |
|
formatName |
Шаблон полного имени для пользовательского региона |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "You do not have permissions to modify templates"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
You do not have permissions to modify templates |
Недостаточно прав на изменение шаблонов генератора документов |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |