Установить диапазон сетевых адресов timeman.networkrange.set

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

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

Scope: timeman

Кто может выполнять метод: администратор

Метод timeman.networkrange.set устанавливает диапазоны сетевых адресов для офисной сети.

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

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

Название
тип

Описание

RANGES*
string

Диапазоны сетевых адресов в виде списка объектов. Каждый объект содержит описание диапазона сетевых адресов.

ranges: [
    {
        "ip_range": "10.0.0.0-10.255.255.255",
        "name": "Офисная сеть 10.x.x.x"
    },
    {
        "ip_range": "10.10.0.1",
        "name": "Адрес 10.10.0.1"
    },
    ...
]

Диапазон может содержать:

  • блок адресов, например, 10.0.0.0-10.255.255.255
  • один адрес, например, 10.10.0.1

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ranges":[{"ip_range":"10.0.0.0-10.255.255.255","name":"Офисная сеть 10.x.x.x"},{"ip_range":"172.16.0.0-172.31.255.255","name":"Офисная сеть 172.x.x.x"},{"ip_range":"192.168.0.0-192.168.255.255","name":"Офисная сеть 192.168.x.x"}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.networkrange.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ranges":[{"ip_range":"10.0.0.0-10.255.255.255","name":"Офисная сеть 10.x.x.x"},{"ip_range":"172.16.0.0-172.31.255.255","name":"Офисная сеть 172.x.x.x"},{"ip_range":"192.168.0.0-192.168.255.255","name":"Офисная сеть 192.168.x.x"}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/timeman.networkrange.set
// 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 NetworkRangeSetResult = {
  result: boolean
  error_ranges?: Array<{
    ip_range: string
    name: string
  }>
}

try {
  const response = await $b24.actions.v2.call.make<NetworkRangeSetResult>({
    method: 'timeman.networkrange.set',
    params: {
      ranges: [
        {
          ip_range: '10.0.0.0-10.255.255.255',
          name: 'Office network 10.x.x.x',
        },
        {
          ip_range: '172.16.0.0-172.31.255.255',
          name: 'Office network 172.x.x.x',
        },
        {
          ip_range: '192.168.0.0-192.168.255.255',
          name: 'Office network 192.168.x.x',
        },
      ],
    },
    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('Set result:', result.result, 'Error ranges:', result.error_ranges)
  }
} 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 setNetworkRanges() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'timeman.networkrange.set',
        params: {
          ranges: [
            {
              ip_range: '10.0.0.0-10.255.255.255',
              name: 'Office network 10.x.x.x',
            },
            {
              ip_range: '172.16.0.0-172.31.255.255',
              name: 'Office network 172.x.x.x',
            },
            {
              ip_range: '192.168.0.0-192.168.255.255',
              name: 'Office network 192.168.x.x',
            },
          ],
        },
        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('Set result:', result.result, 'Error ranges:', result.error_ranges)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', setNetworkRanges)
</script>
try {
    $response = $b24Service
        ->core
        ->call(
            'timeman.networkrange.set',
            [
                'ranges' => [
                    [
                        "ip_range" => "10.0.0.0-10.255.255.255",
                        "name"     => "Офисная сеть 10.x.x.x"
                    ],
                    [
                        "ip_range" => "172.16.0.0-172.31.255.255",
                        "name"     => "Офисная сеть 172.x.x.x"
                    ],
                    [
                        "ip_range" => "192.168.0.0-192.168.255.255",
                        "name"     => "Офисная сеть 192.168.x.x"
                    ]
                ]
            ]
        );

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

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

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error setting network ranges: ' . $e->getMessage();
}
BX24.callMethod(
    'timeman.networkrange.set',
    {
        ranges: [
            {
                "ip_range": "10.0.0.0-10.255.255.255",
                "name": "Офисная сеть 10.x.x.x"
            },
            {
                "ip_range": "172.16.0.0-172.31.255.255",
                "name": "Офисная сеть 172.x.x.x"
            },
            {
                "ip_range": "192.168.0.0-192.168.255.255",
                "name": "Офисная сеть 192.168.x.x"
            }
        ]
    },
    function(result){
        if(result.error())
        {
            console.error(result.error().ex);
        }
        else
        {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'timeman.networkrange.set',
    [
        'ranges' => [
            [
                'ip_range' => '10.0.0.0-10.255.255.255',
                'name' => 'Офисная сеть 10.x.x.x'
            ],
            [
                'ip_range' => '172.16.0.0-172.31.255.255',
                'name' => 'Офисная сеть 172.x.x.x'
            ],
            [
                'ip_range' => '192.168.0.0-192.168.255.255',
                'name' => 'Офисная сеть 192.168.x.x'
            ]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "timeman.networkrange.set", b24.Params{
	"RANGES": []b24.Params{
		{
			"ip_range": "10.0.0.0-10.255.255.255",
			"name":     "Офисная сеть 10.x.x.x",
		},
		{
			"ip_range": "172.16.0.0-172.31.255.255",
			"name":     "Офисная сеть 172.x.x.x",
		},
		{
			"ip_range": "192.168.0.0-192.168.255.255",
			"name":     "Офисная сеть 192.168.x.x",
		},
	},
})
if err != nil {
	return fmt.Errorf("timeman.networkrange.set: %w", err)
}

var item struct {
	Result bool `json:"result"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Result)

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

HTTP-статус: 200

{
    "result": {
        "result": true
    },
    "time": {
        "start": 1742999863.0244141,
        "finish": 1742999863.057137,
        "duration": 0.03272294998168945,
        "processing": 0.0023658275604248047,
        "date_start": "2025-03-26T17:37:43+03:00",
        "date_finish": "2025-03-26T17:37:43+03:00",
        "operating_reset_at": 1743000463,
        "operating": 0
    }
}

При возникновении ошибки разбора диапазонов

HTTP-статус: 200

{
    "result": {
        "result": false,
        "error_ranges": [
            {
                "ip_range": "a172.16.0.0-172.31.255.255",
                "name": "Офисная сеть 172.x.x.x"
            }
        ]
    },
    "time": {
        "start": 1743058773.526674,
        "finish": 1743058773.5625639,
        "duration": 0.035889863967895508,
        "processing": 0.0005609989166259766,
        "date_start": "2025-03-27T09:59:33+03:00",
        "date_finish": "2025-03-27T09:59:33+03:00",
        "operating_reset_at": 1743059373,
        "operating": 0
    }
}

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

Название
тип

Описание

result
boolean

Корневой элемент ответа. Может иметь значения:

  • true — все диапазоны успешно установлены
  • false — есть диапазоны с ошибками

error_range
array

Массив диапазонов, в которых были найдены ошибки

time
time

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

Объект диапазона

Название
тип

Описание

ip_range
string

Диапазон сетевых адресов

name
string

Название диапазона

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

HTTP-статус: 400

{
    "error": "INVALID_FORMAT",
    "error_description": "A wrong format for the RANGES field is passed"
}

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

ACCESS_ERROR

You don't have access to use this method

Метод доступен только администратору

INVALID_FORMAT

A wrong format for the RANGES field is passed

Передан некорректный формат в параметре RANGES

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

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

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

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