Routing vector (route)
Description
Routing vector for telephone calls and state subscriptions, applied at the first stage of the two-stage routing process.
Vectors are analyzed in a strictly defined order corresponding to priorities.
A vector is analyzed by matching conditions against request parameters. If all conditions are met, routing rules are searched within the vector — the second stage of the routing process.
The configured set of vectors and routing rules can be tested through the diagnostic API.
Fields
{
"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
}
}
| Specification | Description |
|---|---|
Field: |
Identifier. Can be specified at creation, otherwise generated by the system. |
Field: |
Vector code |
Field: |
Vector priority. If several vectors have the same priority, their check and application occur in random order. A lower value means higher priority. |
Field: |
Filter based on the call initiator environment |
Field: |
Source number filter mask. |
Field: |
Source domain filter mask. |
Field: |
Filter mask for the provider account code in the current domain. |
Field: |
Destination number filter mask. |
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 (and modifiers) within one route search session. |
Field: |
Probabilistic route application coefficient. Example. To make three routes in a group apply with equal probability, they should be assigned adjacent but different priorities. Set the first rule probability to 33.33%, the second to 50%, and the third to 100%. Then the probability of applying the third rule is 1 * (1 - 0.5) * (1 - 0.333) ~ 33.33%. |
Field: |
Allows extending the compound with arbitrary keys and values |
Field: |
Object creation time |
Field: |
Time of last modification of the object |
Call initiator environment
| Value | Description |
|---|---|
|
The vector can be applied only to calls initiated within the current domain |
|
The vector can be applied only to calls arriving from outside through a provider account in the current domain |
|
The vector can be applied only to calls arriving from another domain |
|
The filter is not applied; the vector is suitable for all call initiator environments |
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: |
Work schedule
| Value | Description |
|---|---|
|
The vector is always available for application |
|
The rule is never available for application |
|
The vector is available for application only during working hours |
|
The vector is available for application only outside working hours |
|
The vector defines an individual availability schedule in the vector |
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 |