...
Ресурс служит для задания правил обработки входящих вызовов, например, установления переадресации. Правила можно добавлять для добавочных любых типов.
На входящий вызов можно создавать несколько правил (максимальное количество определяется ресурсом limits).
...
| Имя | Тип | Обязательное | Значение По Умолчанию | Описание | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| да | Уникальный идентификатор правила (в пределах добавочного) | |||||||
type | string | да |
| |||||||
name | string | нет | null | Имя правила, не обязательно уникальное. | ||||||
playfile_sound | integer | нет | null | Идентификатор звукового файла для правила типа playfile. | ||||||
transfer_dst | string | нет | null | Актуален для "type": "transfer". Переадресация на указанный номер. Если нужна переадресация на несколько номеров одновременно (одновременный вызов), то эти номера перечисляются через пробел. | ||||||
|
| нет | 60 | Актуален для "type": "transfer" и "type": "cascade". Время в секуднах, в течении которого будет пытаться осуществиться перевод. Если время истекло, а перевода не произошло, то происходит переход к обработке следующего правила | ||||||
cascade_numbers
| array | нет | [ ] | Актуален для "type": "cascade". Задает последовательность подключаемых к вызову номеров и время подключения каждого нового номера в виде массива cascade_number элементов: cascade_number:
Например: Примечание: при каскадном вызове сразу начинает звонить номер с минимальным delay, независимо от его фактического значения. Например: | ||||||
allow_public_transfer | boolean | нет | false | Если переадресация была на внешний номер (не добавочный внутри сети), то указывает, можно ли с него будет делать трансфер звонка. | ||||||
caller_id | string | нет | null | Правило будет работать только для вызовов, источник которых определяется этим полем. Поле заполняется в виде регулярного выражения PCRE. Например: "^(\+|)7812" будет соответствовать всем источникам, начинающимся на "+7812" или "7812" | ||||||
|
| нет | 'any' | определяет метод анализа источника вызова caller_id:
| ||||||
|
| нет | 'any' | Правило отработает только в случае:, если статус предыдущего вызова (самого добавочного либо предыдущего правила переадресации) соответствует значению, переданному в этом параметре
| ||||||
extension_call_status |
| нет | 'any' | Правило отработает только в случае, если статус вызова добавочного (если он вызывался) соответствует значению, переданному в этом параметре.
| ||||||
|
| нет | 'any' | Правило отработает лишь при таком статусе добавочного. Принимает одно из значений:
| ||||||
|
| нет | null | Правило отработает при попадании во временной интревал | ||||||
|
| нет | true | Опция позволяет включать/выключать существующие правила | ||||||
|
| нет | true | Не транслировать вызывающему абоненту "early media". Может быть полезно, если происходит серия последовательных переадресаций на разные номера и вызывающий абонент может слышать автоответчик вида "номер не доступен" | ||||||
|
| нет | true | Это правило является последним и последующие обрабатывать не нужно | ||||||
enable_call_screening | boolean | нет | false | Включение функции call_screening для данного правила переадресации. Параметр применим только к правилами типа transfer и cascade. |
...
Примеры использования
Настроим правила для добавочного типа "phone"с идентификатором 54. Для начала убедимся, что на данный момент нет никаких настроек
...
Время, после которого вызов на добавочный считается не отвеченным (hangup-timeout) является свойством самого добавочного типа 'phone' и настраивается ресурсом phone.
Для начала нужно создать (или выбрать из имеющихся) временной интервал. Пусть это будет интервал с идентификатором 32. Создание правила:
...
метод | ресурс | данные | ответ |
|---|---|---|---|
| PUT | /extension/54/incom_rule/order/ | { | { |
Ресурсы раздела "Добавочный"
POST /extension/{extension_id}/incom_rule/
Добавить правило входящего вызова добавочного
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/incom_rule/
Получить список правил входящего вызова добавочного
Параметры URL
Имя | Тип |
|---|---|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
...
PUT /extension/{extension_id}/incom_rule/order/
Обновить порядок правил входящего вызова добавочного
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
GET /extension/{extension_id}/incom_rule/order/
Получить порядок правил входящего вызова добавочного
Параметры URL
Имя | Тип |
|---|---|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
...
PUT /extension/{extension_id}/incom_rule/{rule_id}
Обновить правило входящего вызова добавочного
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/incom_rule/{rule_id}
Получить правило входящего вызова добавочного
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
Имя | Тип |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DELETE /extension/{extension_id}/incom_rule/{rule_id}
Удалить правило входящего вызова добавочного
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
...
Похожие разделы
| Related Labels |
|---|