Функция Call Interactive позволяет инициировать в качестве действия опции контекста IVR инициировать HTTP-запрос из IVR на заданный URL и обработать ответ на него. С запросом передается постоянный набор параметров, содержащий информацию о вызове в IVR, эти параметры располагаются в строке запроса (при методе GET) или в теле запроса (при методе POST). URL и метод запросы может быть задан при настройке действия опции контекста IVR.
| Table of Contents |
|---|
Конфигурации Call Interactive
Параметры запроса
Имя | Тип | Описание |
|---|---|---|
CallID |
| Уникальный идентификатор вызова. |
CallerIDNum |
| Номер вызывающего абонента. |
CallerIDName |
| Имя вызывающего абонента. |
CalledDID |
| Вызываемый номер телефонной сети общего пользования (Внешний вызываемый номер. Присутствует, если доступен). |
CalledExtension |
| Номер IVR в расширенном формате (например: |
| CalledExtensionID | integer | Идентификатор добавочного IVR в системе |
CallStatus |
| Статус вызова, всегда имеет значение ANSWER |
CallFlow |
| Поток вызовов, всегда имеет значение IN |
CallerExtension |
| Добавочный номерИмя добавочного номера, осуществляющий вызов IVR. Только на случай вызова в пределах одного сервера Присутствует только при внутреннем вызове. |
| CallerExtensionID | integer | Идентификатор добавочного номера, осуществляющего вызов IVR. Присутствует только при внутреннем вызове. |
CalledNumber |
| Номер, который набирала вызывающая сторона (может быть внешним номером: |
CallAPIID |
| Идентификатор звонка. Автоматически генерируется и сохраняется на протяжении всего звонка вне зависимости от того, переводится ли он. Эта переменная может использоваться для идентификации звонка в службе Call Events, если он был создан посредством запроса к UnifiedAPI. |
Переменные в строке запроса
Структура ответа
Ответ на запрос Call Interactive запрос Call Interactive не является обязательным и нужен, если требуется совершить какое-либо действие.
Ответ на запрос должен быть сформирован в формате XML и иметь следующую структуру:
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<Response>
Action
</Response> |
где Action может быть одним из ниже перечисленных действий.
Варианты действий
Hangup
Немедленно завершает звонок.
...
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Hangup/>
</Response> |
Pause
Приостанавливает звонок на заданное число атрибутом length тега Pause число секунд. Если значение не задано, то по умолчанию принимается 10.
...
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Pause length="15" />
</Response> |
SetVar
Задает значение переменной для IVR. Имя переменной должно содержатся в атрибуте name тега SetVar, а значение – содержимым это тега.
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<SetVar name="transferDestination">09897987</SetVar>
</Response> |
Jump
Осуществляет переход к заданной опции заданного контекста IVR-контекста. Идентификатор контекста и опция задаются атрибутами context и option тега Jump.
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Jump context="StartSupport3" option="1" priority="3"start"/>
</Response> |
SetCallerId
Задает номер вызывающего абонента и имя вызывающего абонента в среде IVR. Номер и имя задаются атрибутами name и number тега SetCaller.
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<SetCaller name="callerName" number="92992"/>
</Response> |
...