Метод Create
Примените метод Create для создания SIP ID — вы сможете использовать этот ресурс для исходящих и входящих звонков.
Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:
POST: https://api.exolve.ru/sip/v1/Create
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| sip_name | string | название SIP ID |
| number | uint64 | определяемый номер |
| description | string | описание SIP ID |
| call_record | boolean | подключение записи разговоров. True — подключить запись разговоров, False — не подключать запись разговоров |
Примечание
Чтобы подключить запись разговоров на SIP ID, предварительно подключите эту услугу в настройках приложения в Личном кабинете разработчика.
Определяемый номер используется для исходящих звонков при выходе в телефонную сеть общего пользования. В качестве такого номера можно назначить только один из номеров этого же приложения.
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| sip_resource_id | uint64 | идентификатор SIP ID |
| username | string | юзернейм SIP ID |
Примеры
Входные параметры:
{
"sip_name": "Test",
"number": 74991112233,
"description": "Test SIP ID",
"call_record": true
}
Выходные параметры:
{
"sip_resource_id": "1111",
"username": "88314011122"
}
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 401 | Unauthorized | Unauthorized | отсутствует/невалидный API-ключ |
| 400 | Bad Request | Error adding SIP: sip name is not unique on the application | SIP ID с таким именем уже есть в приложении |
| 400 | Bad Request | Error adding SIP: not enough money on account | попытка купить 4 SIP ID при нулевом балансе |
| 400 | Bad Request | Error adding SIP: customer is not active | аккаунт пользователя не активен |
| 409 | Conflict | Error adding SIP: call record is disabled on the app | услуга записи звонков не включена в настройках приложения |
| 500 | Internal Server Error | Application [app_name] does not own resource [number] | указанный номер не принадлежит приложению |
| 400 | Bad Request | invalid value [value] | в одном из полей невалидный формат |
| 400 | Bad Request | value length must be between 3 and 40 runes, inclusive | поле sip_name должно содержать от 3 до 40 символов включительно |