GetSIPList

Метод GetAttributes

Примените этот метод для получения информации о SIP-аккаунтах по заданным параметрам. Для этого выполните 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-аккаунта
limit uint64 лимит выводимых данных
offset uint64 номер строки, с которой начинать выборку (начинается с 0)
date_from string дата создания SIP-аккаунта в формате RFC-3339 / ISO-8601, от которой начинать выборку
date_to string дата создания SIP-аккаунта в формате RFC-3339 / ISO-8601, до которой продолжать выборку
username_filter string фильтр по имени пользователя (юзернейму)
order_by oneof OrderBy тип сортировки

OrderBy

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

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

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

SIPListElement

Параметр Тип Описание
application_uuid string уникальный идентификатор приложения, ресурсом которого является SIP-аккаунт
sip_name string название ресурса SIP-аккаунта
description string описание к ресурсу SIP-аккаунта
subscription_fee float абонентская плата
install_fee float стоимость покупки
sip_resource_id uint64 уникальный идентификатор ресурса SIP-аккаунта
user_name string имя пользователя
domain string домен для подключения
number_code uint64 код определяемого номера телефона
create_date string дата создания SIP-аккаунта в формате RFC-3339 / ISO-8601

Примеры

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

{
    "application_uuid": "61914552-bf20-42ed-9eb4-d337fc3882e6",
    "search_filter_by_name": null,
    "limit": 10,
    "offset": 0,
    "date_from": null,
    "date_to": null,
    "username_filter": null,
    "order_by_name": null
}

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

{
    "sips": [
        {
            "application_uuid": "d88e41a3-1014-421e-8cf7-da8a844dafeb",
            "sip_name": "Test",
            "description": "Test SIP-аккаунт",
            "subscription_fee": 90,
            "install_fee": 0,
            "sip_resource_id": "65165",
            "user_name": "74995557890",
            "domain": "exolve.ru",
            "number_code": "74995557890",
            "create_date": "2023-03-09T15:07:16.343019Z"
        },
        {
            "application_uuid": "d88e41a3-1014-421e-8cf7-da8a844dafeb",
            "sip_name": "Test2",
            "description": "Test SIP-аккаунт",
            "subscription_fee": 90,
            "install_fee": 0,
            "sip_resource_id": "63978",
            "user_name": "74996667854",
            "domain": "exolve.ru",
            "number_code": "74996667854",
            "create_date": "2023-03-09T06:40:37.599414Z"
        }
    ]
}

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