Versions Compared

Version Old Version 28 New Version 29
Changes made by

Роман Сухов (Unlicensed)

Роман Сухов (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Имя

Тип

Обязательный

Значение По УмолчаниюОписание

digits

string

нет

 Проговорить указанные цифры (методом play_digits_method), обязателен при action= 'play_digits'

sound

integer

нет

 Идентификатор звукового файла, который необходимо проиграть, обязателен при action= 'play_sound'

sound_type

string

нет

 

Обязателен при наличии идентификтора sound. Может принимать значения:

  • 'background' пользователь может сделать донабор, пока звучит приветствие
  • 'foreground' пользователь должен прослушать приветствие до конца

play_digits_method

string

нет

 

Обязателен при установленной опции digits. Может быть:

  • 'pronounced' проговорить цифры как одно число
  • iterated' - проговорить цифры последовательно одна за другой

interval

integer

нет

 правило выполняется только в этом временном интервале

caller_id_action

string

нет

 

определяет метод анализа источника вызова caller_id:

  • 'matches' должен совпадать (caller_id должен быть задан)
  • 'not_matches' должен не совпадать (caller_id должен быть задан)
  • 'anonymous' источник скрыт
  • 'any' любой источник

caller_id

string

нет

 Правило будет работать только для вызовов, источник которых определяется этим полем. Поле заполняется в виде регулярного выражения PCRE. Например: "^(\+|)7812" будет соответствовать всем источникам, начинающимся на "+7812" или "7812"

context_option

string

нет

 

Определяет опцию контекста, в которую нужно перейти, при action='jump_to_context'

silence_time

integer

нет

 Время (в миллисекундах) отсутствия каких-либо звуков со стороны АТС, обязателен при action= 'play_silence'

context

integer

нет

 Определяет идентификатор другого контекста, в который нужно перейти, обязателен при action='jump_to_context'

transfer_dst

string

нет

 Переадресация на указанный номер. Если нужна переадресация на несколько номеров одновременно (одновременный вызов), то эти номера перечисляются через пробел. Обязателен для action='transfer'

set_variable_name

string

нет

 

Имя переменной, которая должна быть установлена. Должно начинаться с латинской буквы, может содержать латинские буквы, цифры, а также символы подчеркивания. Обязателен для action='set_variable

set_variable_value

string

нет

 Значение переменной, которая должна быть установлена. Обязателен для action='set_variable'
match_variable_namestringнет Имя переменной IVR, значение которой будет сравниваться со значением, заданным параметром match_variable_value. Если значения совпадут, то правило выполнится. Сравниваемая переменная может быть установлена системой, см. раздел "Предустановленные переменные в IVR", либо задана правилом опции контекста типа set_variable.
match_variable_valuestringнет Значение, которое будет сравниваться со значением переменной, имя которой задано параметром match_variable_name. Если значения совпадут, то правило выполнится. Обязателен, если задан параметр match_variable_name.

transfer_variable

string

нет

 Имя переменной, значение которой будет использовано в качестве номера для переадресации. Если переменная не установлена, то действие не выполняется. Переменная может быть установлена с помощью действия set_variable, record_digits, либо с помощью функции Call Interactive. Обязателен при action= 'transfer_from_variable'

play_digits_variable

string

нет

 Имя переменной, значение которой будет использовано для проигрывания цифр. Если переменная не установлена, то действие не выполняется. Переменная может быть установлена с помощью действия set_variable, record_digits, либо с помощью функции Call Interactive. Обязателен при action= 'play_digits_from_variable'

record_digits_variable

string

нет

 Имя переменной, в которую будут записаны введённые цифры. Обязателен при action= 'record_digits'

record_digits_max

integer

нет

 Максимальное количество введённый цифр, который будут записаны в переменную. Обязателен при action= 'record_digits'

record_digits_sound

integer

нет

 Идентификатор звукового файла, который может быть проигран перед записью ввёденных цифр в переменную.

call_interactive_url

string

нет

 URL, на который будет осуществляться HTTP-запрос функцией Call Interactive. Должен начинаться с http:// или c https://. Обязателен для action='call_interactive'

call_interactive_method

string

нет

 Метод, которым будет осуществляться HTTP-запрос функцией Call Interactive . Может принимать значение 'GET' или 'POST'. Обязателен для action='call_interactive'

call_interactive_timeout

integer

нет

 Время в секундах, в течение которого система будет ожидать ответ на HTTP-запрос функции Call Interactive. Если вызываемый URL не вернул ответ по истечении этого времени, то выполняется следующее правило.

caller_id_number

string

нет

 Номер звонящего для дальнейших переадресаций. Обязателен при action= 'set_caller_id_number'

caller_id_name

string

нет

 Имя звонящего для дальнейших переадресаций. Обязателен при action= 'set_caller_id_name'

action

string

да

 

Непосредственно определяет, что нужно сделать в этом правиле:

  • 'transfer' - выполнить перевод вызова (сделать переадресацию) на номер(а) из transfer_dst. Максимально возможное количество номеров передаресации – 10, для одновременной переадресации на большее количество номеров следует использовать действие group_call.
  • 'group_call' - перевод звонка (сделать переадресацию) на номер(а) из параметра transfer_dst. При данном типе переадресации правила входящего вызова для перечисленных в transfer_dst добавочных номеров не выполняются.
  • 'hangup' - повесить трубку
  • 'play_sound' - проиграть приветствие (параметр sound и sound_type)
  • 'play_silence' - тишина в background формате (параметр silence_time).
  • 'jump_to_context' - перейти в другой контекст (параметр context и context_option)
  • 'play_digits' - проиграть цифры (параметр digits и play_digits_method)
  • 'play_digits_from_variable' - проиграть цифры, содержащиеся в переменной (параметр play_digits_variable и play_digits_method)
  • 'record_digits' - записать набор цифр в переменную (параметры record_digits_variable, record_digits_max и record_digits_sound)
  • 'set_variable' - установить переменную в канале (параметры set_variable_name и set_variable_value).
  • 'transfer_from_variable' - перевод звонка на номер, содержащийся в переменной (параметр transfer_variable)
  • 'call_interactive' - функция Call Interactive – осуществить HTTP-запрос на определенный URL (параметры call_interactive_url и call_interactive_method)

...

  • 'set_caller_id_number' -установить номер звонящего для дальнейших переадресаций из IVR (параметр caller_id_number)
  • 'set_caller_id_name' - установить имен звонящего для дальнейших переадресаций из IVR (параметр caller_id_name)

Предустановленные переменные в IVR
Anchor
ivr_vars
ivr_vars

Имя переменнойОписание
called_didПубличный номер (DID), на который пришел вызов в систему. Если вызов локальный, переменная содержит номер IVR без префикса клиента.

...

Обновить ivr configuration

Параметры URL

Имя

Тип

extension_id

string

Параметры JSON

Имя

Тип

Обязательный

lifetime_exp_

transfer_dst

action

string

нет

lifetime

integer

нет

sleep_time

integer

нет

entry_context

integer

нет

lifetime_exp_

action

Имя

Тип

lifetime_exp_transfer_dst

string

transfer_dst

string

нет

Поля ответа

vm_enabled

boolean

нет

vm_greeting

integer

нет

lifetime

integer

sleep_time

integer

entry_context

integer

lifetime_exp_action

string

GET /extension/{extension_id}/ivr/

Получить ivr configuration

Параметры URL

Имя

Тип

extension_id

string

нет

vm_attach_file

boolean

нет

sleep_time

integer

нет

vm_mailto

string

нет

Поля ответа

Имя

Тип

lifetime_exp_

transfer_dst

action

string

lifetime

entry_context

integer

sleep_time

integer

entry_context

lifetime_exp_transfer_dst

string

vm_enabled

boolean

vm_greeting

integer

lifetime

_exp_action

integer

vm_attach_file

boolean

sleep_time

integer

vm_mailto

string

...

GET /extension/{extension_id}/ivr

...

/

Добавить Получить ivr contextconfiguration

Параметры URL

Имя

Тип

extension_id

string

...

Поля ответа

Имя

Тип

Обязательный

timeout

lifetime_exp_action

string

entry_context

integer

нет

allow_any_dial

boolean

нет

inter_digit_timeout

integer

нет

name

string

да

digit_len

integer

нет

Поля ответа

Имя

Тип

name

string

inter_digit_timeout

integer

id

integer

timeout

integer

allow_any_dial

boolean

options

array [string]

digit_len

integer

...

lifetime_exp_transfer_dst

string

vm_enabled

boolean

vm_greeting

integer

lifetime

integer

vm_attach_file

boolean

sleep_time

integer

vm_mailto

string

...

POST /extension/{extension_id}/ivr/context/

Получить Добавить ivr context list

Параметры URL

Имя

Тип

extension_id

string

...

Параметры JSON

Имя

Тип

nameinter_

Обязательный

string

timeout

integer

нет

allow_any_dial

boolean

нет

inter_digit_timeout

integer

id

нет

name

string

да

digit_len

integer

нет

Поля ответа

Имя

Тип

name

string

inter_digit_timeout

integer

timeout

integer

allow_any_dial

boolean

options

array [string]

id

integer

digit_len

integer

...

GET /extension/{extension_id}/ivr/context/

...

Обновить Получить ivr context list

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

...

Поля ответа

Имя

Тип

Обязательный

Имя

Тип

name

string

inter_digit_

name

string

inter_digit_timeout

integer

нет

allow_any_dial

boolean

нет

inter_digit_timeout

integer

нет

name

string

нет

digit_len

integer

нет

Поля ответа

timeout

integer

id

integer

timeout

integer

allow_any_dial

boolean

options

array [string]

id

integer

digit_len

integer

...

PUT /extension/{extension_id}/ivr/context/{context_id}

Получить Обновить ivr context

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

...

Параметры JSON

_

Имя

Тип

name

string

inter_digit

Обязательный

timeout

integer

id

нет

allow_any_dial

boolean

нет

inter_digit_timeout

integer

нет

name

string

нет

digit_len

integer

нет

Поля ответа

Имя

Тип

name

string

inter_digit_timeout

integer

timeout

integer

allow_any_dial

boolean

options

array [string]

id

integer

digit_len

integer

...

GET /extension/{extension_id}/ivr/context/{context_id}

Удалить Получить ivr context

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

Поля ответа

Имя

Тип

name

string

...

inter_digit_timeout

integer

timeout

integer

allow_any_dial

boolean

id

integer

digit_len

integer

DELETE /extension/{extension_id}/ivr/context/{context_id}

Удалить ivr context

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

...

POST /extension/{extension_id}/ivr/context/{context_id}/options/

Добавить context option

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

Параметры JSON

Имя

Тип

Обязательный

digits

string

да

Поля ответа

Имя

Тип

digits

object

GET /extension/{extension_id}/ivr/context/{context_id}/options/

Получить context options list

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

Поля ответа

Имя

Тип

digits

object

...

DELETE /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}

Удалить context option

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

option_digits

string

...

POST /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/

Добавить context rule

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

option_digits

string

Параметры JSON

Имя

Тип

Обязательный

digits

transfer_variable

string

нет

sound

call_status

integer

string

нет

sound

play_digits_

type

method

string

нет

interval

integer

нет

transfer_dst

caller_id

string

нет

match_variable_

name

value

string

нет

context

play_digits_

option

variable

string

нет

call_interactive_

url

method

string

нет

caller

record_

id

digits_

action

max

string

integer

нет

caller

match_variable_

id

name

string

нет

play

caller_

digits

id_

method

action

string

нет

call

context_

interactive_timeout

integer

нет

call_interactive_method

option

string

нет

silence_time

integer

нет

match

set_variable_

value

name

string

нет

context

integer

caller_id_number

string

нет

set_variable_name

string

final

boolean

нет

action

sound

string

integer

да

нет

position

sound_type

integer

string

нет

set

call_

variable

interactive_

value

url

string

нет

transfer

caller_id_

variable

name

string

нет

name

digits

string

нет

...

name

Имя

string

Тип

нет

record_digits_variable

string

нет

sound

interval

integer

sound

нет

transfer_

type

dst

string

interval

нет

context

integer

нет

transfer_dst

action

string

match

да

set_variable_

name

value

string

context_option

нет

string

call_interactive_

url

timeout

integer

string

нет

caller_id_action

record_digits_sound

integer

нет

Поля ответа

Имя

Тип

transfer_variable

string

caller

call_

id

status

string

play_digits_method

string

caller_id

string

match_variable_value

string

call

play_

interactive

digits_

timeout

variable

integer

string

call_interactive_method

string

silence_time

id

integer

match

record_

variable

digits_

valueset

max

string

context

integer

transfer_variable

match_variable_name

string

caller_id_action

string

set_variable_value

string

context_option

string

silence_time

integer

set_variable_name

string

caller_id_number

string

final

boolean

sound

integer

name

Имя

Тип

context_id

integer

extension_id

string

option_

sound_type

string

GET /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/

Получить context rules list

Параметры URL

call_interactive_url

string

caller_id_name

string

digits

string

...

name

Имя

string

Тип

record_digits_variable

string

sound

interval

integer

sound

transfer_

type

dst

string

interval

context

integer

transfer_dst

action

string

match

set_variable_

name

value

string

context

call_interactive_

option

timeout

string

integer

call

record_

interactive

digits_

url

sound

string

caller_id_action

string

caller_id

string

play_digits_method

string

call_interactive_timeout

integer

call_interactive

integer

GET /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/

Получить context rules list

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

option_digits

string

Поля ответа

Имя

Тип

transfer_variable

string

call_status

string

play_digits_method

string

silence

caller_

time

id

integer

string

match_variable_value

string

play_digits_variable

string

call_interactive_method

string

context

id

integer

set

record_

variable

digits_

name

max

string

action

match_variable_name

string

set

caller_

variable

id_

value

action

string

transfer

context_

variable

option

string

id

silence_time

integer

set_variable_name

string

...

caller_id

...

Обновить context rule

Параметры URL

Имя

Тип

context_id

integer

option_digits

string

rule_id

integer

extension_id

string

Параметры JSON

Имя

Тип

Обязательный

digits

string

нет

sound

integer

нет

sound_type

string

нет

interval

integer

нет

transfer_dst

string

нет

match_variable_name

string

нет

context_option

string

нет

call_interactive_url

string

нет

caller_id_action

string

нет

caller_id

string

нет

play_digits_method

string

нет

call_interactive_timeout

integer

нет

call_interactive_method

string

нет

silence_time

integer

нет

match_variable_value

string

нет

context

integer

нет

set_variable_name

string

нет

action

string

нет

position

integer

нет

_number

string

final

boolean

sound

integer

sound_type

string

call_interactive_url

string

caller_id_name

string

digits

string

name

string

record_digits_variable

string

interval

integer

transfer_dst

string

context

integer

action

string

set_variable_value

string

call_interactive_timeout

integer

record_digits_sound

integer

...

PUT /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/order/

Udpate context option rules order

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

option_digits

string

Параметры JSON

Имя

Тип

Обязательный

rules_ids

array [integer]

да

Поля ответа

Имя

Тип

rules_ids

array [integer]

GET /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/order/

Получить context option rules order

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

option_digits

string

Поля ответа

Имя

Тип

rules_ids

array [integer]

...

PUT /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/{rule_id}

Обновить context rule

Параметры URL

Имя

Тип

context_id

integer

option_digits

string

rule_id

integer

extension_id

string

Параметры JSON

Имя

Тип

Обязательный

transfer_variable

string

нет

call_status

string

нет

play_digits_method

string

нет

caller_id

string

нет

match_variable_value

string

нет

play_digits_variable

string

нет

call_interactive_method

string

нет

record_digits_max

integer

нет

match_variable_name

string

нет

caller_id_action

string

нет

context_option

string

нет

silence_time

integer

нет

set_variable_name

string

нет

caller_id_number

string

нет

final

boolean

нет

sound

integer

нет

sound_type

string

нет

call_interactive_url

string

нет

caller_id_name

string

нет

digits

string

нет

name

string

нет

record_digits_variable

string

нет

interval

integer

нет

transfer_dst

string

нет

context

integer

нет

action

string

нет

set_variable_value

string

нет

transfer

call_interactive_

variable

timeout

string

integer

нет

name

string

record_digits_sound

integer

нет

Поля ответа

Имя

Тип

transfer_variable

string

call_status

string

play_digits_method

string

sound

integer

sound_type

caller_id

string

match_variable_value

string

play_digits_variable

string

call_interactive_method

string

interval

id

integer

transfer

record_digits_

dst

max

string

match_variable_name

string

caller_id_action

string

context_option

string

call_interactive_url

silence_time

integer

set_variable_name

string

caller_id_

action

number

string

caller_id

final

boolean

sound

integer

sound_type

string

play

call_

digits

interactive_

method

url

string

call

caller_

interactive_timeout

integer

call_interactive_method

string

silence_time

integer

match_variable_value

id_name

string

digits

string

name

string

record_digits_variable

string

interval

integer

transfer_dst

string

context

integer

set_variable_name

string

action

string

set_variable_value

string

transfer

call_interactive_

variable

timeout

string

id

integer

record_digits_sound

integer

name

string

GET /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/{rule_id}

Получить context rule

Параметры URL

Имя

Тип

context_id

integer

option_digits

string

rule_id

integer

extension_id

string

Поля ответа

interval

integer

Имя

Тип

digits

string

sound

integer

sound_type

string

Имя

Тип

transfer_

dst

string

match_

variable

_name

string

context

call_

option

status

string

call

play_

interactive

digits_

url

method

string

caller_id

_action

string

caller

match_variable_

id

value

string

play_digits_

method

variable

string

call_interactive_timeout

integer

call_interactive_method

string

silence_time

id

integer

match

record_

variable

digits_

value

max

string

context

integer

set

match_variable_name

string

caller_id_action

string

set

context_

variable_value

option

string

transfer

silence_

variablestring

time

id

integer

set_variable_name

string

...

caller_id

...

Удалить context rule

Параметры URL

Имя

Тип

context_id

integer

option_digits

string

rule_id

integer

extension_id

string

PUT /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/order/

Udpate context option rules order

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

option_digits

string

Параметры JSON

Имя

Тип

Обязательный

rules_ids

array [integer]

да

Поля ответа

Имя

Тип

rules_ids

array [integer]

...

_number

string

final

boolean

sound

integer

sound_type

string

call_interactive_url

string

caller_id_name

string

digits

string

name

string

record_digits_variable

string

interval

integer

transfer_dst

string

context

integer

action

string

set_variable_value

string

call_interactive_timeout

integer

record_digits_sound

integer

DELETE /extension/{extension_id}/ivr/context/{context_id}/options/{option_digits}/rules/

...

{rule_id}

Удалить context rule

Параметры URL

Имя

Тип

context_id

integer

extension_id

string

Имя

Тип

rules_ids

array [integer]

option_digits

string

Поля ответа

rule_id

integer

extension_id

string

...

Теги по теме

Related Labels