Вектор маршрутизации (route)

Описание

Вектор маршрутизации телефонных звонков и подписок на состояния, применяемый на первом этапе двухэтапного процесса маршрутизации.
Векторы анализируются в строго определенном порядке, соответствующему приоритетам.
Анализ вектора проводится через сопоставление условий с параметрами запроса. В случае, если все условия соблюдаются, происходит поиск правил маршрутизации внутри вектора – второй этап процесса маршрутизации.

Настроенная совокупность векторов и правил маршрутизации может быть протестирована через диагностическое API.

Ограничения

  • Коллекция недоступна в мастер-домене.

Поля

Структура сущности
{
  "id": uuid,
  "vector": str,
  "priority": int,
  "dir": str,
  "fromnumber": str,
  "fromdomain": str,
  "fromextaccount": str,
  "tonumber": str,
  "schedule": str,
  "periods": array<object>,
  "opts": {
    "title": str,
    "comment": str
  },
  "ext": {
    "ct": date,
    "lwt": date
  }
}

Описание характеристик спецификации

Table 1. Поля
Спецификация Описание

Поле: id
Режим: inout
Тип: uuid
По умолчанию: generated

Идентификатор. Может быть задан при создании, иначе генерируется системой.

Поле: vector
Режим: in
Тип: str
По умолчанию: required

Код вектора

Поле: priority
Режим: in
Тип: int
По умолчанию: required

Приоритет вектора. При совпадении приоритетов нескольких векторов, их проверка и применение происходит в случайном порядке. Меньшее значение означает более высокий приоритет.

Поле: dir
Режим: in
Тип: str
По умолчанию: "*"

Фильтр на основе среды инициатора звонка

Поле: fromnumber
Режим: in
Тип: str
По умолчанию: "*"

Маска-фильтр номера источника.
Проверяется результат модификации правилами на предыдущих шагах маршрутизации.
Изначально на проверку попадает номер источника из поля username заголовка Referred-By, а при его отсутствии заголовка From, SIP-запроса INVITE, либо результат более сложного определения номера абонента-инициатора (например sipuser phonenumber, результат применения sipuser extension, правил преобразования callerid на esg и др.).
Режимы работы фильтров.

Поле: fromdomain
Режим: in
Тип: str
По умолчанию: "*"

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

Поле: fromextaccount
Режим: in
Тип: str
По умолчанию: "*"

Маска-фильтр кода учетной записи провайдера в текущем домене.
Применяется на первом шаге маршрутизации в случае обработки звонка из внешней среды.
Режимы работы фильтров.

Поле: tonumber
Режим: in
Тип: str
По умолчанию: "*"

Маска-фильтр номера назначения.
Проверяется результат модификации правилами на предыдущих шагах.
Изначально на проверку попадает номер из поля username заголовка To SIP-запроса INVITE.
Режимы работы фильтров.

Поле: schedule
Режим: in
Тип: str
По умолчанию: "all"

Определяет расписание активности правила.
Рабочее/нерабочее время определяется в настройках текущего домена, либо в родительских доменах вплоть до мастер-домена.
Расписание работы.

Поле: periods
Режим: in
Тип: array<object>
По умолчанию: empty

Интервал активности в течение недели.
Применяется в режиме schedule = custom.
Каждый элемент списка охватывает определенный отрезок внутри недели: от времени в конкретный день недели до времени в другой конкретный день недели.
На основе совокупности этих отрезков формируется общее расписание.
Элемент списка еженедельного расписания.

Поле: opts
Режим: in
Тип: object
Составное поле

Поле: opts.title
Режим: in
Тип: str
По умолчанию: empty

Произвольный заголовок

Поле: opts.comment
Режим: in
Тип: str
По умолчанию: empty

Произвольный комментарий

Поле: opts.tab
Режим: in
Тип: array<object>
По умолчанию: []

Табличные данные для использования фильтров (и модификаторов) в рамках одной сессии поиска маршрута.
Каждый объект в списке содержит произвольные поля, которые могут использоваться в маске в виде строки {tab:some_field}.
Подробнее в разделе Режимы работы фильтра, пункт 'Таблица'".

"Поле: ext
Режим: inout
Тип: object
Составное поле

Позволяет расширять состав произвольными ключами и значениями

Поле: ext.ct
Режим: out
Тип: date
По умолчанию: generated

Время создания объекта

Поле: ext.lwt
Режим: out
Тип: date
По умолчанию: generated

Среда инициатора звонка

Table 2. Среда инициатора звонка
Значение Описание

"inner"

Вектор может быть применен только для звонков, инициированных внутри текущего домена

"outer"

Вектор может быть применен только для звонков, пришедших снаружи через учетную запись провайдера в текущем домене

"cross"

Вектор может быть применен только для звонков, пришедших из другого домена

"*"

Фильтр не применяется, вектор подходит для всех сред инициаторов звонков

Режимы работы фильтров

Table 3. Режимы работы фильтров
Режим Описание

Посимвольный

Подвергаемое проверке соответствия значение посимвольно проводится через фильтр.
Могут применяться следующие спец-символы и сочетания:

  • X – любой символ;

  • * – все оставшиеся символы;

  • {F} и {f} – исходное значение From username целиком;

  • {T} и {t} – исходное значение To username целиком;

  • {E} и {e} – пустое значение.

  • '?' - для фильтра по доменам. Любой символ кроме точки - разделителя доменных имен.

  • '$' - для фильтра по доменам. Любая последовательность символов кроме точки - разделителя доменных имен.

При необходимости указать один из служебных символов как целевой, его следует заключать в квадратные скобки, например [X].

Например, XXX – любое трехсимвольное значение.

Таблица

Может применяться подстрока {tab:…​}. С помощью нее можно выделить группу символов в проверяемом значении и сопоставить их с таблицей, встроенной в правило (opts.tab).
Например, {tab:a} - выделение подстроки и сопоставление ее с полем a всех объектов/строк в таблице.
Таблица служет связке нескольких полей фильтров и модификаторов. На основании последовательной проверки фильтров в таблице остается меньшее количество строк с учетом обнаруженных совпадений.
Первая из оставшихся строк служит для применения в модификаторах. При условии что в таблице не осталось строк - правило отклоняется.
Захват символов из проверяемого значения на основе маски может происходить автоматически, либо со строгим указанием длины подстроки:

  • {tab:KEY} - Автоматический захват из проверяемого значения.

  • {tab:KEY:LENGTH} - Захват указанного количества символов из проверяемого значения.

В качестве значений полей в таблице могут применяться:

  • константы;

  • регулярные выражения (для этого необходимо задать значение в формате /reg/EXPRESSION, например /reg/^1[1-4]$);

  • сопоставления с другими полями таблицы (для этого необходимо задать значение в формате /tab/FIELD, например /tab/a). Режим используется для связывания значений различных полей. Например, чтобы разрешить звонки только на собственный ящик голосовой почты. Необходимо строго соблюдать порядок связывания: если поле таблицы, на которое производится ссылка, еще не проверялось и не было заполнено реальным значением другого поля сущности, то сопоставление не пройдет. Порядок проверки полей сущности: fromnumber, tonumber, fromdomain, fromextaccount.

  • любое значение, применяемого без регулярного выражения (для этого необходимо задать /any). Режим полезен исключительно при организации прямых сопоставлений со значениями других полей без дополнительных фильтров.

Применение табличного модификатора допускается в комбинации с другими управляющими командами посимвольного режима.
Допускается кратное указание полей в одном модификаторе, повторение, указание несуществующих полей.

Например, {tab:a:3}XXXXX{tab:b} - позволяет выделить в номере 3-символьный код города и сопоставить с полем a в таблице, и одновременно выделить хвост начиная с 9 символа и сопоставить с полем b таблицы.

Regex

К исходному значению применяется шаблон Pattern.

Структура значения regex-шаблона:
/reg/Pattern1.

Например,- значение: "302"
- маска: "/reg/0"
- результат: true.

  • значение: "302"

  • маска: "/reg/^0$"

  • результат: false.

  • значение: "302"

  • маска: "/reg/^302$"

  • результат: true.

  • значение: "302"

  • маска: "/reg/^(301|302|305)$"

  • результат: true.

При формировании шаблонов Pattern могут применяться все стандартные правила регулярных выражений.

Расписание работы

Table 4. Расписание работы
Значение Описание

"all"

Вектор доступен для применения всегда

"work"

Вектор доступен для применения только в рабочее время

"non-work"

Вектор доступен для применения только в нерабочее время

"custom"

Вектор определяет индивидуальное расписание доступности в поле periods вектора

Элемент списка еженедельного расписания

Table 5. Элемент списка еженедельного расписания
Поле Значение Описание

daystart

1 – 7

День недели начала отрезка (1 – пн, 7 – вс)

daystop

1 – 7

День недели конца отрезка (1 – пн, 7 – вс)

timestart

0 – 1440

Время начала отрезка внутри дня в минутах

timestop

0 – 1440

Время конца отрезка внутри дня в минутах

См. также

API

Логические роли

  • b2b проводит маршрутизацию.

  • mdc и sdc производит поиск векторов и правил.

  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт