SetCallForwarding

Метод SetCallForwarding

Примените метод SetCallForwarding для настройки переадресации входящих вызовов на номере.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/number/v1/SetCallForwarding

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

CallForwardingType

CallForwardingData

CallForwardingSip

CallForwardingNumber

RedirectType

CallControl

Period

CallForwardingIpcr

CallForwardingStatic

CallForwardingStatics

RedirectTypeStatics

Выходные параметры

Пустой JSON с 200 OK статусом.

Примеры

Входные параметры для переадресации на внешний SIP-аккаунт (тип 1):

{
    "number_code": 74991112233,
    "call_forwarding_type": 1,
    "call_forwarding_sip": {
       "sip_uri": "testsip06844538@testsip.test.ru"
    }
}

Входные параметры для переадресации на номер или SIP ID (тип 2):

{
    "number_code": 74991112233,
    "call_forwarding_type": 2,
    "call_forwarding_number": {
       "redirect_type": 1,
       "call_control":[
           {
                "timeout": "16",
                "active": true,
                "period": "wd {Mon-Fri} hr {6am-14pm}",
                "period_description": "график будни",
                "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"
    }
}

Входные параметры для динамической переадресации по API (на URL) (тип 3):

{
    "number_code": 74991112233,
    "call_forwarding_type": 3,
    "call_forwarding_ipcr": {
        "url": "https://example.com/",
        "reserve": "74993334455"
    }
}

Входные параметры для переадресации на SIP-транк (Static IP) (тип 4):

{
    "number_code": 74991112233,
    "call_forwarding_type": 4,
    "call_forwarding_static": {
       "static_ip": "127.0.0.1",
       "port": 10,
       "timeout": 30,
       "did": 111
    }
}

Входные параметры для переадресации на несколько SIP-транков (Static IP) последовательно (тип 6):

{
  "number_code": 74991112233,
  "call_forwarding_type": 6,
  "call_forwarding_ip_statics": {
    "redirect_type": 2,
    "ip_statics": [
      {
        "ip": "127.0.0.1",
        "port": 5060,
        "timeout": 60
      },
      {
        "ip": "111.112.113.114",
        "port": 5060,
        "timeout": 60
      }
    ]
  }
}

Входные параметры для переадресации на несколько SIP-транков (Static IP) с балансировкой трафика (тип 6):

{
  "number_code": 74991112233,
  "call_forwarding_type": 6,
  "call_forwarding_ip_statics": {
    "redirect_type": 3,
    "ip_statics": [
      {
        "ip": "127.0.0.1",
        "port": 5060,
        "timeout": 60,
        "percent": 40
      },
      {
        "ip": "111.112.113.114",
        "port": 5060,
        "timeout": 60,
        "percent": 60
      }
    ]
  }
}

Выходные параметры:

{}

Примечание к отправке уведомлений при входящем звонке

Вы можете настроить отправку уведомлений о ходе входящих звонков на URL-адрес вашего сервера двумя способами:

1. Установить URL для определённого номера, передав значение в поле event_url при выполнения метода SetCallForwarding.
2. Установить URL в настройках приложения в блоке «Уведомления о событиях» в Личном кабинете разработчика. Установленный URL применяется ко всем номерам приложения.

При отправке уведомлений о ходе входящего звонка платформа МТС Exolve сначала проверяет, указан ли URL индивидуально на номере вызова. Если URL не указан на номере, проверяет, указан ли в приложении. Подробнее:

1. Если URL указан и на номере, и в приложении, уведомления будут отправлены на URL из индивидуальных настроек номера.
2. Если URL указан на номере, но пуст в приложении, уведомления будут отправлены на URL из индивидуальных настроек номера.
3. Если URL не указан на номере, но указан в приложении, уведомления будут отправлены на URL из приложения

Возможные ошибки