Правила записи (recordrule)

Содержание

Описание
Ограничения
Поля
См. также
- API
- Функциональные роли

Описание

Правило применения записи телефонного звонка.
Применяется в момент соединения после успешного вызова, когда определились стороны диалога.

В одном телефонном разговоре участники могут принадлежать разным доменам.
Процесс принятия решения о записи состоит из
(1) Определения участников звонка и их доменов и подготовки параметров поиска.
(2) Определение правила записи в домене инициатора.
(3) В случае кросс-доменного звонка определение правила записи в домене вызываемого абонента.
(4) Принятие решения о записи на основе положительного решения о записи хотя бы в одном из доменов.
По умолчанию разговоры не записываются.

Ограничения

Сущность недоступна в мастер-домене.

Поля

Структура сущности

{
  "id": uuid,
  "priority": int,
  "dir": str,
  "fromnumber": str,
  "tonumber": str,
  "crossdomain": str,
  "rec": intbool,
  "storageruleid": uuid,
  "schedule": str,
  "periods": array<object>,
  "opts": {
    "title": str,
    "comment": str
  }
  "ext": {
    "ct": date,
    "lwt": date
  }
}

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

Table 1. Поля
Спецификация	Описание
Поле: `id` Режим: `inout` Тип: `uuid` По умолчанию: generated	Идентификатор. Может быть задан при создании, иначе генерируется системой «R».
Поле: `priority` Режим: `in` Тип: `int` По умолчанию: required	Приоритет. Меньшее значение означает более высокий приоритет.
Поле: `dir` Режим: `in` Тип: `str` По умолчанию: `"*"`	Фильтр по направлению звонка.
Поле: `fromnumber` Режим: `in` Тип: `str` По умолчанию: `"*"`	Маска-фильтр номера инициатора вызова. Режимы работы фильтров.
Поле: `tonumber` Режим: `in` Тип: `str` По умолчанию: `"*"`	Маска-фильтр вызываемого абонента. Режимы работы фильтров.
Поле: `crossdomain` Режим: `in` Тип: `str` По умолчанию: `"*"`	Маска-фильтр другого домена. Применяется только в ходе обслуживания кросс-доменных звонков. Режимы работы фильтров.
Поле: `rec` Режим: `in` Тип: `intbool` По умолчанию: required	Определитель действия. `1` – записывать, `0` – не записывать. В случае если кросс-доменный звонок в обоих доменах обнаруживает разные действия, запись осуществляется, но не попадает в домен, отказавшийся от записи.
Поле: `storageruleid` Режим: `in` Тип: `guid` По умолчанию: required	Правило хранения записи, применяемое в данном домене. Применяется только если rec = `1`.
Поле: `schedule` Режим: `in` Тип: `str` По умолчанию: `"all"`	Расписание работы
Поле: `periods` Режим: `in` Тип: `array<object>` По умолчанию: empty	Интервал активности в течение недели. Применяется в режиме schedule = `custom`. Каждый элемент списка охватывает определенный отрезок внутри недели: от времени в конкретный день недели до времени в другой конкретный день недели. На основе совокупности этих отрезков формируется общее расписание. Элемент списка еженедельного расписания.
Поле: `opts` Режим: `in` Тип: `object` Составное поле
Поле: `opts.title` Режим: `in` Тип: `str` По умолчанию: empty	Произвольный заголовок
Поле: `opts.comment` Режим: `in` Тип: `str` По умолчанию: empty	Произвольный комментарий
Поле: `ext` Режим: `inout` Тип: `object` Составное поле	Позволяет расширять состав произвольными ключами и значениями
Поле: `ext.ct` Режим: `out` Тип: `date` По умолчанию: generated	Время создания объекта
Поле: `ext.lwt` Режим: `out` Тип: `date` По умолчанию: generated	Время последней модификации объекта

Варианты фильтров по направлению звонка

Table 2. Варианты фильтров по направлению звонка
Значение	Описание
`"inner"`	Правило может применяться только для внутри-доменных звонков, где обе стороны являются абонентами текущего домена
`"incoming"`	Правило может применяться только для кросс-доменных звонков, где вызываемой стороной является абонент текущего домена
`"outgoing"`	Правило может применяться только для кросс-доменных звонков, где инициирующей стороной является абонент текущего домена
`"*"`	Правило может применяться для всех звонков, где по крайней мере одной из сторон является абонент текущего домена

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

Table 3. Режимы работы фильтров
Режим	Описание
`Посимвольный`	Подвергаемое проверке соответствия значение посимвольно проводится через фильтр. Могут применяться следующие спец-символы и сочетания: `X` – любой символ; `*` – все оставшиеся символы; `{F}` и `{f}` – значение From username целиком; `{T}` и `{t}` – значение To username целиком; `{E}` и `{e}` – пустое значение. При необходимости указать один из служебных символов как целевой, его следует заключать в квадратные скобки, например `[X]`. Например, `XX[X]` – любое трехсимвольное значение, с символом `X` на конце.

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

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

/rest/v1/uc/recordrules

Функциональные роли

b2b проводит применение правил записи и инициацию записи.
jrnl применяет правило записи при распределении записей разговоров по доменам.