Метод SetDisplayNumber
Примените метод SetDisplayNumber для установки определяемого номера на SIP ID — это нужно для исходящих звонков на номера телефонной сети общего пользования (ТфОП).
Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:
POST: https://api.exolve.ru/sip/v1/SetDisplayNumber
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| sip_resource_id | uint64 | идентификатор SIP ID |
| number | uint64 | определяемый номер для исходящих звонков в ТфОП |
Выходные параметры
Пустой JSON с 200 OK статусом.
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 401 | Unauthorized | Unauthorized | отсутствует/невалидный API-ключ |
| 400 | Bad Request | Error set sip display number: incorrect number format | неправильный формат номера в поле number |
| 400 | Bad Request | Error set sip display number: number is missing in the application | указанный номер не принадлежит приложению |
| 400 | Bad Request | Error getting sip info: SIP is missing in the application | заданный SIP ID не принадлежит приложению |
| 400 | Bad Request | Error adding SIP: customer is not active | аккаунт пользователя неактивен |
Примеры
Входные параметры:
{
"sip_resource_id": 1111,
"number": 79991112233
}
Выходные параметры:
{}