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 | номер Exolve, на который устанавливается переадресация |
call_forwarding_type | enum CallForwardingType | тип переадресации |
call_forwarding_data | oneof CallForwardingData | настройка переадресации |
CallForwardingType
Параметр | Тип | Описание |
---|---|---|
0 | enum | переадресация не определена |
2 | enum | переадресация на номер или SIP ID |
3 | enum | переадресация на URL |
4 | enum | переадресация на SIP-транк (Static IP) |
CallForwardingData
Параметр | Тип | Описание |
---|---|---|
call_forwarding_number | CallForwardingNumber | данные для переадресации на номер или SIP ID |
call_forwarding_ipcr | CallForwardingIpcr | данные для переадресации на URL |
call_forwarding_static | CallForwardingStatic | данные для переадресации на SIP-транк (Static IP) |
CallForwardingNumber
Параметр | Тип | Описание |
---|---|---|
redirect_type | enum RedirectType | тип переадресации |
call_control | CallControl | управление входящим вызовом |
event_url | string | URL для отправки уведомлений о ходе звонка |
event_extended | boolean | True для получения расширенных уведомлений. False для получения стандартного набора уведомлений |
client_id | string | сквозной идентификатор вызова от API клиента |
file_to_a | string | аудиосообщение звонящему абоненту |
file_to_b | string | аудиосообщение принимающему абоненту |
masking | boolean | True для скрытия номера звонящего абонента. False для показа оригинального номера звонящего абонента |
display_number | string | номер, который показывается абоненту C (номер переадресации). Зависит от параметра masking . Если значение masking - false , абоненту C показывается реальный номер звонящего. Если параметр masking - true , пользователь может передать любой номер Exolve, принадлежащий приложению |
RedirectType
Параметр | Тип | Описание |
---|---|---|
1 | enum | одиночная переадресация |
2 | enum | последовательная переадресация |
3 | enum | параллельная переадресация |
CallControl
Параметр | Тип | Описание |
---|---|---|
redirect_number | string | номер или юзернейм SIP ID для переадресации |
timeout | uint32 | время ожидания ответа в секундах |
active | boolean | True для переадресации вызова на redirect_number , False для сброса вызова |
name | string | символьное имя номера для переадресации вызова |
CallForwardingIpcr
Параметр | Тип | Описание |
---|---|---|
url | string | URL для переадресации звонка |
reserve | string | резервный номер для переадресации, если URL будет недоступен |
CallForwardingStatic
Параметр | Тип | Описание |
---|---|---|
static_ip | string | IP адрес |
port | uint32 | порт |
timeout | uint32 | таймаут переадресации |
did | uint64 | DID номер |
Выходные параметры
Пустой JSON с 200 OK статусом.
Примеры
Входные параметры для переадресации на номер или SIP ID:
{
"number_code": 74991112233,
"call_forwarding_type": 2,
"call_forwarding_number": {
"redirect_type": 1,
"call_control":[
{
"timeout": "16",
"active": true,
"name": "звонит клиент",
"redirect_number": "74992223344" // или 883140XXXXXXXXX (SIP ID)
}
],
"event_url": "https://example.com/",
"event_extended": true,
"client_id": "test",
"file_to_a": "12345",
"file_to_b": "54321",
"masking": true,
"display_number": "74995556677"
}
}
Входные параметры для переадресации на URL:
{
"number_code": 74991112233,
"call_forwarding_type": 3,
"call_forwarding_ipcr": {
"url": "https://example.com/",
"reserve": "74993334455"
}
}
Входные параметры для переадресации на SIP-транк (Static IP):
{
"number_code": 74991112233,
"call_forwarding_type": 4,
"call_forwarding_static": {
"static_ip": "127.0.0.1",
"port": 10,
"timeout": 30,
"did": 111
}
}
Выходные параметры:
{}
Примечание к отправке уведомлений при входящем звонке
Вы можете настроить отправку уведомлении на URL о ходе входящих звонков двумя способами:
-
Установить URL для определённого номера, передав значение в поле “event_url” при выполнения метода SetCallForwarding.
-
Установить URL в настройках приложения в блоке “Уведомления о событиях” в Личном кабинете разработчика. Установленный URL применяется ко всем номерам приложения.
При отправке уведомлений о ходе входящего звонка платформа Exolve сначала проверяет, указан ли URL индивидуально на номере вызова. Если URL не указан на номере, проверяет, указан ли в приложении. Подробнее:
- Если URL указан и на номере, и в приложении, то уведомления будут отправлены на URL из индивидуальных настроек номера.
- Если URL указан на номере, но пуст в приложении, то уведомления будут отправлены на URL из индивидуальных настроек номера.
- Если URL не указан на номере, но указан в приложении, то уведомления будут отправлены на URL из приложения