Протестировать методы API можно на странице интерактивного обозревателя и без написания кода
...
| Warning |
|---|
Мы обновили документацию, актуальная версия страницы доступна по ссылке: Голосовое меню (/ivr/) |
Добавочные номера типа ivr служат для настройки маршрутизации звонков внутри АТС с использованием информации, вводимой клиентом на клавиатуре телефона с помощью тонального набора.
Для конфигурации голосового меню необходимо создать добавочный , указав в качестве типа (type) значение ivr. После этого становится возможным конфигурация голосового меню через API-интерфейс ivr.
...
Имя | Тип | Обязательный | Значение По Умолчанию | Описание | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
| Непосредственно определяет, что нужно сделать в этом правиле:
|
|
|
|
|
| Идентификатор звукового файла, который необходимо проиграть, | Проговорить указанные цифры (методом play_digits_method), обязателен при action= 'play_digits' |
| |
|
|
| Проговорить указанные цифры (методом play_digits_method), обязателен при action= 'play_sounddigits' | |||||||||
|
|
| Идентификатор звукового файла, который необходимо проиграть, обязателен при action= 'play_sound' | |||||||||
|
| нет | Обязателен при наличии идентификтора sound. Может принимать значения:
| |||||||||
|
|
| Обязателен при установленной опции digits. Может быть:
| |||||||||
|
|
| правило выполняется только в этом временном интервале | |||||||||
|
|
| определяет метод анализа источника вызова caller_id:
| |||||||||
|
|
| Правило будет работать только для вызовов, источник которых определяется этим полем. Поле заполняется в виде регулярного выражения PCRE. Например: "^(\+|)7812" будет соответствовать всем источникам, начинающимся на "+7812" или "7812" | |||||||||
|
|
| Определяет опцию контекста, в которую нужно перейти, при action='jump_to_context' | |||||||||
|
|
| Время (в миллисекундах) отсутствия каких-либо звуков со стороны АТС, обязателен при action= 'play_silence' | |||||||||
|
|
| Определяет идентификатор другого контекста, в который нужно перейти, обязателен при action='jump_to_context' | |||||||||
|
|
| Переадресация на указанный номер. Если нужна переадресация на несколько номеров одновременно (одновременный вызов), то эти номера перечисляются через пробел. Обязателен для action='transfer' | |||||||||
|
|
| Имя переменной, которая должна быть установлена. Должно начинаться с латинской буквы, может содержать латинские буквы, цифры, а также символы подчеркивания. Обязателен для action='set_variable | |||||||||
|
|
| Значение переменной, которая должна быть установлена. Обязателен для action='set_variable' | |||||||||
match_variable_name | string | нет | Имя переменной IVR, значение которой будет сравниваться со значением, заданным параметром match_variable_value. Если значения совпадут, то правило выполнится. Сравниваемая переменная может быть установлена системой, см. раздел "Предустановленные переменные в IVR", либо задана правилом опции контекста типа set_variable. | |||||||||
match_variable_value | string | нет | Значение, которое будет сравниваться со значением переменной, имя которой задано параметром match_variable_name. Если значения совпадут, то правило выполнится. Обязателен, если задан параметр match_variable_name. | |||||||||
|
|
| Имя переменной, значение которой будет использовано в качестве номера для переадресации. Если переменная не установлена, то действие не выполняется. Переменная может быть установлена с помощью действия set_variable, record_digits, либо с помощью функции Call Interactive. Обязателен при action= 'transfer_from_variable' | |||||||||
|
|
| Имя переменной, значение которой будет использовано для проигрывания цифр. Если переменная не установлена, то действие не выполняется. Переменная может быть установлена с помощью действия set_variable, record_digits, либо с помощью функции Call Interactive. Обязателен при action= 'play_digits_from_variable' | |||||||||
|
|
| Имя переменной, в которую будут записаны введённые цифры. Обязателен при action= 'record_digits' | |||||||||
| integer |
| Максимальное количество введённый цифр, который будут записаны в переменную. Обязателен при action= 'record_digits' | |||||||||
| max_rate | integer | нет | 5 | Максимальная оценка разговора, параметр, необходимый только для действия quality_rate | ||||||||
| integer |
| Идентификатор звукового файла, который может быть проигран перед записью ввёденных цифр в переменную. | |||||||||
|
|
| URL, на который будет осуществляться HTTP-запрос функцией Call Interactive. Должен начинаться с http:// или c https://. Обязателен для action='call_interactive' | |||||||||
|
|
| Метод, которым будет осуществляться HTTP-запрос функцией Call Interactive . Может принимать значение 'GET' или 'POST'. Обязателен для action='call_interactive' | |||||||||
|
|
| 5 | Время в секундах, в течение которого система будет ожидать ответ на HTTP-запрос функции Call Interactive. Если вызываемый URL не вернул ответ по истечении этого времени, то выполняется следующее правило. | ||||||||
|
|
| Номер звонящего для дальнейших переадресаций. Данный параметр может содержать в себе имена переменных, установленных в других действиях ранее, а также предустановленных переменных IVR. Имена переменных указываются в формате ${имя_переменной}. Обязателен при action= 'set_caller_id_number' | |||||||||
|
|
| Имя звонящего для дальнейших переадресаций. Данный параметр может содержать в себе имена переменных, установленных в других действиях ранее, а также предустановленных переменных IVR. Имена переменных указываются в формате ${имя_переменной}.Обязателен при action= 'set_caller_id_name' | |||||||||
| play_sound_from_variable | boolean | нет | false | Для правил play_sound, quality_rate, voice_helper доступен параметр play_sound_from_variable. В этой системной переменной может хранится приветствие, синтезированное с помощью действия text_to_speech в call interactive: Call Interactive#TTS В случае, если синтезированного приветствия нет, а play_sound_from_variable активен- будет проигран звуковой файл по-умолчанию, указанный в sound |
Предустановленные переменные в IVR
| Anchor | ||||
|---|---|---|---|---|
|
...