GetStaticList

Метод GetStaticList

Примените метод GetStaticList для получения информации о всех Static IP по заданным параметрам.

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

POST: https://api.exolve.ru/number/customer/v1/GetStaticList

Авторизация

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

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

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

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

ПараметрТипОписание
search_filter_by_namestringназвание Static IP
limituint64лимит выводимых данных
offsetuint64номер строки, с которой начинать выборку (начинается с 0)
date_fromstringдата создания Static IP в формате RFC-3339 / ISO-8601, от которой начинать выборку
date_tostringдата создания Static IP в формате RFC-3339 / ISO-8601, до которой продолжать выборку
ipstringIP-адрес ресурса Static IP без порта
clis_filterstringопределяемый номер, который используется в искомом Static IP для исходящих звонков на номера ТфОП
order_byoneof OrderByтип сортировки

OrderBy

ПараметрТипОписание
order_by_nameenum OrderByNameсортировка по имени
order_by_dateenum OrderByDateсортировка по дате

OrderByName/OrderByDate

ПараметрТипОписание
1enumascending order (по возрастанию)
2enumdescending order (по убыванию) — по умолчанию для даты

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

ПараметрТипОписание
staticsStaticElementсписок Static IP и информация о них

StaticElement

ПараметрТипОписание
application_uuidstringидентификатор приложения, в котором создан Static IP
static_namestringназвание Static IP
descriptionstringописание Static IP
static_resource_iduint64идентификатор Static IP
ipstringIP-адрес
portuint32порт
number_codestringопределяемый номер, используется для исходящих звонков с этого Static IP на номера ТфОП
create_datestringдата создания Static IP в формате RFC-3339 / ISO-8601
clistringопределяемый номер, используется для исходящих звонков с SIP ID

Примеры

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

{
    "limit": 10,
    "offset": 0,
    "date_from": "2022-12-19T12:35:56.122610Z",
    "date_to": "2025-05-21T12:35:56.122610Z",
    "ip": "111.112.113.114",
    "clis_filter":
    [
     "79999999999",
     "79133333333"
    ],
    "order_by_name": null
}

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

{
    "statics": [
        {
            "application_uuid": "d88e41a3-1014-421e-8cf7-da8a144dafeb",
            "static_name": "static_ip_name",
            "description": "static_ip_description",
            "static_resource_id": "65165",
            "ip": "111.112.113.114",
            "port": 5060,
            "number_code": "74996482487",
            "create_date": "2025-03-09T15:07:16.343019Z"
        }
    ]
}

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

КодСтатусПример сообщенияОписание
400Bad Request“unknown field ‘*’”в одном из полей невалидный формат данных
400Bad Request“unexpected token *”в одном из полей невалидный формат
400Bad Request“invalid value *”в одном из полей невалидный формат данных
400Bad Request“invalid value for uint64 field limit: *”значение поля limit невалидного формата
400Bad Request“invalid value for uint64 field offset: *”значение поля offset невалидного формата
400Bad Request“invalid value for string field searchFilterByName: *”значение поля searchFilterByName невалидного формата
400Bad Request“invalid value for string field ip: *”значение поля ip невалидного формата
400Bad Request“invalid value for enum field orderByName: *”в поле order_by_name должно быть одно из определённых значений
400Bad Request“invalid value for enum field orderByDate: *”в поле order_by_date должно быть одно из определённых значений
401Unauthorizedmalformed tokenотсутствует API-ключ
401Unauthorizedunauthorizedневалидный API-ключ