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 фильтр по имени пользователя (юзернейму)
order_by oneof OrderBy тип сортировки

OrderBy

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

OrderByName/OrderByDate

Параметр Тип Описание
0 enum не определён
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 определяемый номер телефона

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

Код Статус Пример сообщения Описание
401 Unauthorized Unauthorized отсутствует/не валидный API-ключ
400 Bad Request invalid value [value] в одном из полей не валидный формат
400 Bad Request GetSIPListRequest.OrderByName: value must be one of the defined enum values в поле order_by_name должно быть одно из определённых значений
400 Bad Request GetSIPListRequest.OrderByDate: value must be one of the defined enum values в поле order_by_date должно быть одно из определённых значений
400 Bad Request invalid google.protobuf.Timestamp value [value] в поле date_from/date_to не валидный формат даты
400 Bad Request Error adding SIP: customer is not active аккаунт пользователя не активен

Примеры

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

{
    "search_filter_by_name": null,
    "limit": 10,
    "offset": 0,
    "date_from": "2022-12-19T12:35:56.122610Z",
    "date_to": "2023-12-21T12:35:56.122610Z",
    "username_filter": null,
    "order_by_name": 1
}

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

{
    "sips": [
        {
            "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
            "sip_name": "TEST SIP ID",
            "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": "TEST SIP",
            "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"
        }
    ]
}

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