GetAttributes

Метод GetAttributes

Примените метод GetAttributes для получения деталей (атрибутов) конкретного ресурса Static IP.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/static-ip/v1/GetAttributes

Авторизация

Передайте следующие заголовки HTTP для успешной авторизации.

ИмяТипОписание
AuthorizationstringAPI-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

ПараметрТипОписание
static_resource_iduint64идентификатор Static IP

Выходные параметры

ПараметрТипОписание
status_namestringстатус активности ресурса Static IP
static_ip_namestringназвание ресурса Static IP
create_datestringдата создания ресурса Static IP в формате RFC-3339 / ISO-8601
attributesAttributesатрибуты Static IP
static_resource_iduint64идентификатор ресурса Static IP
numbers_with_call_forwardingrepeated uint64номера, с которых переадресуются входящие звонки на этот ресурс Static IP

Attributes

ПараметрТипОписание
static_ipstringстатический IP-адрес
portuint32порт
clistringопределяемый номер для исходящих звонков с этого Static IP на номера ТфОП

Примеры

Входные параметры:

{
    "static_resource_id": 1111
}

Выходные параметры:

{
    "status_name": "Active",
    "static_ip_name": "static_ip_name",
    "create_date": "2025-03-09T15:07:16.343019Z",
    "attributes": {
        "static_ip": "111.112.113.114",
        "port": 5060,
        "cli":  "79991234455"
               },
    "static_resource_id": "1111",
    "numbers_with_call_forwarding": [
        "79998887766"
    ]
}

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

КодСтатусПример сообщенияОписание
400Bad Request“error”: “Error getting sip static info: sip static is missing in the application”искомый Static IP не принадлежит этому приложению
400Bad Requestinvalid value for uint64 type [value]значение поля static_resource_id невалидно
400Bad RequestError adding SIP: customer is not activeаккаунт пользователя неактивен
400Bad Request“error”: “invalid value *”невалидное значение поля
400Bad Request“error”: “unknown field *”невалидное значение поля
401Unauthorizedmalformed tokenотсутствует API-ключ
401UnauthorizedUnauthorizedневалидный API-ключ