Метод 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 в формате 88314XXXXXXXXXX |
| attributes | SipAttributes | атрибуты SIP ID |
| create_date | string | дата создания SIP ID в формате RFC-3339 / ISO-8601 |
| numbers_with_call_forwarding | repeated uint64 | номера, с которых переадресуются входящие звонки на этот SIP ID |
| status | string | статус регистрации SIP ID на оборудовании с использованием логина и пароля |
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 | определяемый номер для исходящих звонков в ТфОП |
Примеры
Входные параметры:
{
"sip_resource_id": "1234"
}
Выходные параметры:
{
"application_uuid": "c9c5031b-ad9b-4453-b6f8-bd1b14455790",
"sip_resource_id": "1234",
"sip_name": "SIP ID для исходящих звонков",
"description": "",
"number_code": "883140776926011",
"attributes": {
"login": "883140776926011",
"password": "WbUMgSMihkr0",
"subscription_fee": 95,
"install_fee": 0,
"username": "883140776926011",
"domain": "sip.exolve.ru",
"call_record": true,
"cli": "79587723311"
},
"create_date": "2026-01-29T13:14:03.147699Z",
"numbers_with_call_forwarding": [],
"status": "registered"
}
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 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 | аккаунт пользователя неактивен |
| 400 | Bad Request | “error”: “invalid value *” | невалидное значение поля |
| 400 | Bad Request | “error”: “unknown field *” | невалидное значение поля |
| 401 | Unauthorized | malformed token | отсутствует API-ключ |
| 401 | Unauthorized | Unauthorized | невалидный API-ключ |