GetSIPList

Метод GetSIPList

Примените метод GetSIPList для получения информации о всех SIP ID приложения по заданным параметрам.

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

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

Авторизация

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

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

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

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

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

OrderBy

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

OrderByName/OrderByDate

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

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

ПараметрТипОписание
sipsSIPListElementсписок SIP ID и информация о них

Максимальное количество SIP ID в выходных параметрах: 256. Для получения информации о последующих SIP ID, воспользуйтесь смещением выбранного диапазона при помощи параметра offset. Пример: чтобы получить список SIP ID с 257 по 512, во входных параметрах укажите значение offset: 256


SIPListElement

ПараметрТипОписание
application_uuidstringидентификатор приложения, в котором создан SIP ID
sip_namestringназвание SIP ID
subscription_feefloatабонентская плата
install_feefloatстоимость подключения
sip_resource_iduint64идентификатор SIP ID
user_namestringюзернейм SIP ID
domainstringдомен для подключения
number_codestringюзернейм SIP ID
create_datestringдата создания SIP ID в формате 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",
    "clis_filter":
    [
     "79999999999",
     "79133333333"
    ],
    "order_by_name": 1
}

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

{
    "sips": [
        {
            "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
            "sip_name": "sip_name_1",
            "subscription_fee": 0,
            "install_fee": 0,
            "sip_resource_id": "1111",
            "user_name": "883140123456789",
            "domain": "sip.exolve.ru",
            "number_code": "883140123456789",
            "create_date": "2023-12-20T12:35:56.122610Z",
            "cli": "79991112233"
        },
        {
            "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
            "sip_name": "sip_name_2",
            "subscription_fee": 0,
            "install_fee": 0,
            "sip_resource_id": "2222",
            "user_name": "883140987654321",
            "domain": "sip.exolve.ru",
            "number_code": "883140987654321",
            "create_date": "2023-10-10T11:28:38.316920Z",
            "cli": "79994445566"
        }
    ]
}

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

КодСтатусПример сообщенияОписание
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-ключ
500Internal Server Error“Error getting SIP list: *”количество SIP ID в выходных параметрах превышает максимальный лимит (256)