GetAttributes

Метод GetAttributes

Примените этот метод для получения детальной информации о ресурсе SIP-аккаунта (его атрибуты). Для этого выполните 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-аккаунта

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

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

SipAttributes

Параметр Тип Описание
login sting логин от SIP-аккаунта
password string пароль от SIP-аккаунта
install_fee float стоимость покупки
subscription_fee float абонентская плата
username string имя пользователя
domain string домен для подключения

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

Код Статус Пример сообщения Описание
500 Internal Server Error ERROR: Application [ID] does not own resource [number] значение в поле sip_resource_id не принадлежит указанному приложению
400 Bad Request proto: syntax error (line 6:15): invalid value п значение в поле sip_resource_id не валидно
400 Bad Request proto: syntax error (line 6:15): unexpected token , не задано значение в поле sip_resource_id

Примеры

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

{
    "sip_resource_id": 5202
}

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

{
    "application_uuid": "d25b1d5a-6879-44a2-95fd-c9487bc4a1f4",
    "sip_resource_id": "5202",
    "sip_name": "Test",
    "description": "Test SIP-аккаунт",
    "number_code": "74995557890",
    "attributes": {
        "login": "login",
        "password": "pass",
        "subscription_fee": 90,
        "install_fee": 0,
        "username": "username",
        "domain": "domain"
    }
}

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