GetStaticList

Метод GetStaticList

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
search_filter_by_name string название Static IP
limit uint64 лимит выводимых данных
offset uint64 номер строки, с которой начинать выборку (начинается с 0)
date_from string дата создания Static IP в формате RFC-3339 / ISO-8601, от которой начинать выборку
date_to string дата создания Static IP в формате RFC-3339 / ISO-8601, до которой продолжать выборку
ip string IP-адрес ресурса Static IP без порта
clis_filter string определяемый номер, который используется в искомом Static IP для исходящих звонков на номера ТфОП
order_by oneof OrderBy тип сортировки

OrderBy

Параметр Тип Описание
order_by_name enum OrderByName сортировка по имени
order_by_date enum OrderByDate сортировка по дате

OrderByName/OrderByDate

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

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

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

StaticElement

Параметр Тип Описание
application_uuid string идентификатор приложения, в котором создан Static IP
static_name string название Static IP
description string описание Static IP
static_resource_id uint64 идентификатор Static IP
ip string IP-адрес
port uint32 порт
number_code string определяемый номер, используется для исходящих звонков с этого Static IP на номера ТфОП
create_date string дата создания Static IP в формате RFC-3339 / ISO-8601
cli string определяемый номер, используется для исходящих звонков с 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"
        }
    ]
}

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

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

Содержание статьи