Проверить IP-адрес timeman.networkrange.check

Scope: timeman

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

Метод timeman.networkrange.check проверяет IP-адрес на вхождение в диапазоны сетевых адресов офисной сети.

Для корректной работы метода должен быть установлен хотя бы один диапазон.

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

Название
тип

Описание

IP
string

IP-адрес, который нужно проверить. Например 10.10.255.25.

Если не указать — проверка будет выполнена для текущего IP-адреса

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IP":"10.10.255.255"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.networkrange.check
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IP":"10.10.255.255","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/timeman.networkrange.check
        
try
        {
        	const response = await $b24.callMethod(
        		'timeman.networkrange.check',
        		{
        			'IP': '10.10.255.255'
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error.ex);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'timeman.networkrange.check',
                    [
                        'IP' => '10.10.255.255'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error()->ex);
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error checking network range: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'timeman.networkrange.check',
            {
                'IP': '10.10.255.255'
            },
            function(result){
                if(result.error())
                {
                    console.error(result.error().ex);
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'timeman.networkrange.check',
            [
                'IP' => '10.10.255.255'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "ip": "10.10.255.255",
                "range": "10.0.0.0-10.255.255.255",
                "name": "10.x.x.x"
            },
            "time": {
                "start": 1742997578.1675889,
                "finish": 1742997578.205729,
                "duration": 0.038140058517456055,
                "processing": 0.0028028488159179688,
                "date_start": "2025-03-26T16:59:38+03:00",
                "date_finish": "2025-03-26T16:59:38+03:00",
                "operating_reset_at": 1742998178,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа.

Содержит объект c описанием диапазона, в который входит IP-адрес.

Вернет false если IP-адрес не входит ни в один диапазон офисной сети

ip
string

IP-адрес, который был проверен

range
string

Диапазон, в который входит IP-адрес

name
string

Название диапазона, в который входит IP-адрес

time
time

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

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

HTTP-статус: 400

{
            "error": "ACCESS_ERROR",
            "error_description": "You don't have access to use this method"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

ACCESS_ERROR

You don't have access to use this method

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

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

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

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

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

Предыдущая
Обзор методов
Следующая
Получить диапазон сетевых адресов