GetAttributes

Метод GetAttributes

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
sip_resource_id uint64 уникальный идентификатор ресурса SIP ID

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

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

SipAttributes

Параметр Тип Описание
login sting логин (юзернейм) SIP ID
password string пароль SIP ID
install_fee float стоимость покупки
subscription_fee float абонентская плата
username string юзернейм SIP ID
domain string домен для подключения
call_record boolean запись разговора. True - включить запись разговоров, False - не включать запись разговоров
cli string определяемый номер Exolve (для исходящих звонков в ТфОП)

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

Код Статус Пример сообщения Описание
401 Unauthorized Unauthorized отсутствует/не валидный API-ключ
400 Bad Request Error getting sip info: SIP is missing in the application заданный SIP ID не принадлежит приложению
400 Bad Request invalid value for uint64 type [value] значение в поле sip_resource_id не валидно
400 Bad Request Error adding SIP: customer is not active аккаунт пользователя не активен

Примеры

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

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

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