Redirect rule (redirectrule)
Description
Redirect rule assigned to numbers (SIP user accounts).
Applied by the B2BUA role server when making calls to internal SIP user numbers.
Includes several routing types: absolute, due to absence of registered devices, and due to various unsuccessful responses from called devices.
Sequential application of cascade forwarding A → B → C → D is possible.
Filtering by the call initiator number is supported.
Limitations
-
The collection is unavailable in the master domain.
-
When a SIP user account is used as a resource in queues, simultaneous forwarding may harm queue principles.
-
Does not apply to forwarding configured on the SIP device itself and initiated by receiving SIP responses with `3xx` codes.
Fields
{
"id": uuid,
"type": str,
"filter_number": str,
"tran_number": str,
"priority": int,
"enabled": intbool,
"schedule": str,
"periods": array<object>,
"opts": {
"title": str,
"comment": str
},
"ext": {
"ct": date,
"lwt": date
}
}
| Specification | Description |
|---|---|
Field: |
Identifier. Can be specified at creation, otherwise generated by the system. |
Field: |
Depending on the selected type, the rule can apply under different conditions and at different points in the device call process. When several account devices are called in parallel and all outcomes fail, the so-called best result is selected from all received SIP response codes: 603, 486, 6xx, 5xx, 4xx. The value may specify several types, comma-separated. |
Field: |
Number filter mask for the number the redirect rule belongs to. |
Field: |
Number filter mask for the number from which the call is made. |
Field: |
Modifier of the redirect destination number. |
Field: |
Priority. A lower value means higher priority. |
Field: |
Switch. The rule applies only if it is enabled. |
Field: |
Defines the rule activity schedule. |
Field: |
Activity interval during the week. |
Field: |
|
Field: |
Arbitrary title |
Field: |
Arbitrary comment |
Field: |
Tabular data for using filters within one rule search session. |
Field: |
Allows extending the compound with arbitrary keys and values |
Field: |
Object creation time |
Field: |
Time of last modification of the object |
Redirect rule condition types
| Value | Description |
|---|---|
|
The redirect rule always applies. Applied before the call starts. |
|
The redirect rule applies if the account has no registered devices at the time of the call. Applied before the call starts. |
|
The redirect rule applies after receiving a response mapped in general settings to the Busy result. By default the SIP response code is |
|
The redirect rule applies after the allowed call time expires (30 seconds by default, or as set in the SIP user account settings), or after receiving a |
|
The redirect rule applies after receiving a response mapped in general settings to the Declined result. By default the SIP response code is |
|
The redirect rule applies after receiving a response mapped in general settings to the DND (Do Not Disturb) result. By default the SIP response codes are |
|
The redirect rule applies after errors are detected during calls. |
|
The redirect rule applies after receiving SIP responses not mapped to other result types. |
Filter operation modes
| Mode | Description |
|---|---|
|
The value being checked is passed through the filter character by character.
If one of the service characters must be specified as a target, it should be enclosed in square brackets, e.g. For example, |
|
The substring
The following can be used as table field values:
Using the table modifier is allowed in combination with other control commands of per-character mode. For example, |
|
The Pattern template is applied to the source value. Structure of the regex template value: For example,- value:
All standard regular expression rules can be used when forming Pattern templates. |
|
"The value being checked is an integer and falls within the specified range of numeric values. Structure of the dia template value: For example,- value: |
Modifier operation modes
| Mode | Description |
|---|---|
|
The source value passes through the specified modifier character by character with accumulation. |
|
The substring The table links several filter and modifier fields. Based on sequential filter checks, fewer rows remain in the table, taking detected matches into account. Using the table modifier is allowed in combination with other control commands of per-character mode. |
|
The Pattern template with Opts options is applied to the source value, and the found block(s) are replaced with the Replace template. General structure of the regex modifier value: Options can be omitted or contain any combination of the characters:
For example,- value: When forming the Pattern and Replace templates, all standard regular expression rules can be used, including capture groups, backreferences, named group substitution, etc. |
Work schedule
| Value | Description |
|---|---|
|
The rule is always available for application |
|
The rule is never available for application |
|
The rule is available for application only during working hours |
|
The rule is available for application only outside working hours |
|
The rule defines an individual availability schedule in the rule |
Weekly schedule list element
| Field | Value | Description |
|---|---|---|
|
|
Day of week when the segment starts ( |
|
|
Day of week when the segment ends ( |
|
|
Start time of the segment within the day, in minutes |
|
|
End time of the segment within the day, in minutes |