GetSIPList

Метод GetSIPList

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
search_filter_by_name string название SIP ID
limit uint64 лимит выводимых данных
offset uint64 номер строки, с которой начинать выборку (начинается с 0)
date_from string дата создания SIP ID в формате RFC-3339 / ISO-8601, от которой начинать выборку
date_to string дата создания SIP ID в формате RFC-3339 / ISO-8601, до которой продолжать выборку
username_filter string юзернейм SIP ID в формате 88314XXXXXXXXXX
clis_filter string определяемый номер, который используется в искомом SIP ID для исходящих звонков
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 (по убыванию) — по умолчанию для даты

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

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

SIPListElement

Параметр Тип Описание
application_uuid string идентификатор приложения, в котором создан SIP ID
sip_name string название SIP ID
subscription_fee float абонентская плата
install_fee float стоимость подключения
sip_resource_id uint64 идентификатор SIP ID
user_name string юзернейм SIP ID
domain string домен для подключения
number_code string юзернейм SIP ID
create_date string дата создания SIP ID в формате 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",
    "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"
        }
    ]
}

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

Код Статус Пример сообщения Описание
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-ключ

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