SetCallForwarding
Метод SetCallForwarding
Примените этот метод для настройки переадресации входящих вызовов. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/number/v1/SetCallForwarding
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
Имя | Тип | Описание |
---|---|---|
Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0 , где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
Параметр | Тип | Описание |
---|---|---|
number_code | uint64 | код номера |
call_forwarding_type | oneof CallForwardingType | тип переадресации (номер или URL) |
call_forwarding_data | oneof CallForwardingData | настройка переадресации |
CallForwardingType
Параметр | Тип | Описание |
---|---|---|
CALL_FORWARDING_TYPE_NUMBER = 2 | string | переадресация на номер |
CALL_FORWARDING_TYPE_IPCR = 3 | string | переадресация на URL |
CALL_FORWARDING_TYPE_UNSPECIFIED = 0 | string | переадресация не определена |
CallForwardingData
Параметр | Тип | Описание |
---|---|---|
call_forwarding_number | CallForwardingNumber | данные для переадресации на номер |
call_forwarding_ipcr | CallForwardingIpcr | данные для переадресации на URL |
CallForwardingNumber
Параметр | Тип | Описание |
---|---|---|
call_control | CallControl | управление входящим вызовом |
CallControl
Параметр | Тип | Описание |
---|---|---|
redirect_number | string | номер для переадресации |
CallForwardingIpcr
Параметр | Тип | Описание |
---|---|---|
url | string | URL для переадресации звонка |
reserve | string | резервный номер для переадресации, если URL будет недоступен |
Выходные параметры
Пустой JSON с 200 OK статусом.
Возможные ошибки
Код | Статус | Пример сообщения | Описание |
---|---|---|---|
500 | Internal Server Error | Application [ID] does not own resource [number] | указанный в поле number_code номер не принадлежит указанному приложению |
400 | Bad Request | proto: syntax error (line 2:20): unexpected token , | не задано значение в поле number_code |
400 | Bad Request | proto: syntax error (line 2:20): invalid value к | значение в поле number_code не валидно |
500 | Internal Server Error | error unknown call forwarding type | в поле call_forwarding_type указан неверный тип переадресации |
400 | Bad Request | proto: syntax error (line 3:29): invalid value п | значение в поле call_forwarding_type не валидно |
400 | Bad Request | proto: syntax error (line 3:29): unexpected token , | не задано значение в поле call_forwarding_type |
Примеры
Входные параметры для переадресации на номер:
{
"number_code": "79992223344",
"call_forwarding_type": 2,
"call_forwarding_number": {
"call_control":[
{
"redirect_number":"79993335566"
}
]
}
}
Входные параметры для переадресации на URL:
{
"number_code": 74996482766,
"call_forwarding_type": 3,
"call_forwarding_ipcr": {
"url": "https://example.com/",
"reserve": "74993451122"
}
}
Выходные параметры:
{}