SIP API

SIP API — это определенный программный интерфейс, который позволяет управлять SIP ID в приложении.

SIP (Session Initiary protocol) — это разновидность протокола, который обеспечивает обмен данными в сети в формате мультимедиа. SIP-протокол позволяет открывать несколько сеансов связи одновременно без потери скорости обработки информации. Также SIP имеет высокий уровень безопасности благодаря шифрованию входных и выходных каналов связи. SIP-протокол позволяет пользователям совершать аудио и видео звонки с высокой скоростью и безопасностью внутри сети дешевле, чем у операторов мобильной связи.

SIP API Exolve предлагает пользователям следующие методы для работы:

• Create - создает SIP ID в приложении в Личном кабинете;

• Delete - удаляет созданный SIP ID в приложении в Личном кабинете;

• GetFees - получает стоимость использования SIP ID;

• GetAttributes - получает информацию о параметрах созданного SIP ID;

• GetSIPList - получает информацию обо всех SIP ID по заданным параметрам;

• SetDisplayNumber - устанавливает определяемый номера на SIP ID;

• ChangePassword - меняет пароль от SIP ID.

Решения, где используется SIP API

Попробовать бесплатно

Метод Create

Примените этот метод для создания SIP ID. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/sip/v1/Create

Авторизация

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

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

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

Примечание
Чтобы включить запись звонков через SIP ID, убедитесь, что соответствующая услуга уже включена в настройках приложения в Личном кабинете разработчика.

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

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

Примеры

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

{
    "sip_name": "Test",
    "number": 74991112233,
    "description": "Test SIP ID",
    "call_record": true
}

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

{
    "sip_resource_id": "1111",
    "username": "88314011122"
}

Метод Delete

Примените этот метод для удаления ресурса SIP ID. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/sip/v1/Delete

Авторизация

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

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

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

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

Пустой JSON c 200 OK статусом.

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

Примеры

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

{
    "sip_resource_id": "111"
}

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

{}

Метод GetFees

Примените этот метод для получения стоимости использования ресурса SIP ID. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/sip/v1/GetFees

Авторизация

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

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

Передайте пустой JSON в теле запроса.

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

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

Примеры

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

{}

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

{
    "install_fee": 0,
    "subscription_fee": 90
}

Метод GetAttributes

Примените этот метод для получения детальной информации о ресурсе SIP ID (его атрибуты). Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/sip/v1/GetAttributes

Авторизация

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

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

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

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

SipAttributes

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

Примеры

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

{
    "sip_resource_id": 1111
}

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

{
    "application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
    "sip_resource_id": "1111",
    "sip_name": "TEST SIP ID",
    "description": "",
    "number_code": "883140123456789",
    "attributes": {
        "login": "883140123456789",
        "password": "password123",
        "subscription_fee": 0,
        "install_fee": 0,
        "username": "883140123456789",
        "domain": "sip.exolve.ru",
        "call_record": false,
        "cli": "79991112233"
    },
    "create_date": "2023-12-20T12:35:56.122610Z"
}

Метод GetSIPList

Примените этот метод для получения информации обо всех SIP ID по заданным параметрам. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

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

Авторизация

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

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

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

OrderBy

OrderByName/OrderByDate

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

SIPListElement

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

Примеры

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

{
    "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"
        }
    ]
}

Метод SetDisplayNumber

Примените этот метод для установки определяемого номера на SIP ID. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/sip/v1/SetDisplayNumber

Авторизация

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

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

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

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

Пустой JSON с 200 OK статусом.

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

Примеры

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

{
    "sip_resource_id": 1111,
    "number": 79991112233
}

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

{}

Метод ChangePassword

Примените этот метод для смены пароля от SIP ID. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/sip/v1/ChangePassword

Авторизация

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

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

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

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

Пустой JSON с 200 OK статусом.

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

Примеры

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

{
    "sip_resource_id": 1111,
}

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

{}