Functional group (sipkit)
Description
Defines a group of SIP user accounts whose calls are serviced according to the group algorithm.
The following functional types are available: redirect group, reject group, call option setting group, parallel call group, chief-secretary group.
Fields
{
"id": uuid,
"name": str,
"type": str,
"enabled": bool,
"cascade": bool,
"priority": int,
"details": 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: |
Group name. Displayed during tracing. |
Field: |
Group type. Specific settings are defined for each type in the 'details' field.
|
Field: |
Group switch. |
Field: |
Cascade mode switch. |
Field: |
Group application priority. |
Field: |
Object with typed settings. More in Group types. |
Field: |
Compound field |
Field: |
Arbitrary title |
Field: |
Arbitrary comment |
Default: empty" |
Arbitrary comment |
Field: |
Compound field allowing extension with arbitrary keys and values |
Field: |
Object creation time |
Field: |
Time of last modification of the object |
Group types
Depending on the configured group type, a special 'details' parameter is set and the corresponding logic is implemented on a call.
Redirect group (redirect)
Call redirect group.
The 'filter_from' filter is applied to the original initiating subscriber number without regard to forwarding and transfers. The number of the subscriber who forwarded the call can be filtered by the 'filter_by' field.
Field: filter_fromMode: inType: strDefault: * |
Source number filter mask. The result of modification by routing rules applied at previous steps is checked. Initially the source number from the username field of the Referred-By header, or, if absent, the From header of the SIP INVITE request, or the result of a more complex determination of the initiating subscriber number (e.g. sipuser phonenumber, the result of sipuser extension, callerid transformation rules on esg, etc.) is checked. Filter operation modes. |
|---|---|
|
Filter mask for the number of the subscriber who forwarded the call. |
|
List of numbers on whose call the group is activated. |
|
Number for redirect. |
{
"filter_from": "*",
"filter_by": "*",
"redirect_number": "122"
}
Reject group (reject)
Call rejection group.
The 'filter_from' filter is applied to the original initiating subscriber number without regard to forwarding and transfers. The number of the subscriber who forwarded the call can be filtered by the 'filter_by' field.
Field: filter_fromMode: inType: strDefault: * |
Source number filter mask. The result of modification by routing rules applied at previous steps is checked. Initially the source number from the username field of the Referred-By header, or, if absent, the From header of the SIP INVITE request, or the result of a more complex determination of the initiating subscriber number (e.g. sipuser phonenumber, the result of sipuser extension, callerid transformation rules on esg, etc.) is checked. Filter operation modes. |
|---|---|
|
Filter mask for the number of the subscriber who forwarded the call. |
|
List of numbers on whose call the group is activated. |
|
Response code. |
|
Rejection reason. |
{
"filter_from": "*",
"filter_by": "*",
"sip_code": 603,
"sip_reason": "Some reason"
}
Call option setting group (options)
The group forms a change of call options for the leg and child legs (calls initiated by forwarding and/or parallel calls within the current routing process).
In particular, it allows setting:
-
dialog_timeoutsec- conversation duration limit (from 5 to 7200). -
fork_timeoutsec- specific leg call time (from 3 to 180). -
fork_fromuri- calling subscriber representation.
The set value applies to all child legs unless an individual setting from another group is applied to them later in the routing process.
The default value does not apply the group parameter. The value "undefined" resets a previously applied parameter.
The 'filter_from' filter is applied to the original initiating subscriber number without regard to forwarding and transfers. The number of the subscriber who forwarded the call can be filtered by the 'filter_by' field.
Field: filter_fromMode: inType: strDefault: * |
Source number filter mask. The result of modification by routing rules applied at previous steps is checked. Initially the source number from the username field of the Referred-By header, or, if absent, the From header of the SIP INVITE request, or the result of a more complex determination of the initiating subscriber number (e.g. sipuser phonenumber, the result of sipuser extension, callerid transformation rules on esg, etc.) is checked. Filter operation modes. |
|---|---|
|
Filter mask for the number of the subscriber who forwarded the call. |
|
List of numbers on whose call the group is activated. |
|
Maximum dialog duration, seconds. Value |
|
Leg call timeout, seconds. Applied to all legs child relative to the current call within the current routing process. Value |
|
Calling subscriber representation. Applied to all legs child relative to the current call within the current routing process. Only username and displayname are used. |
{
"filter_from": "*",
"filter_by": "*",
"numbers_to": ["205","206"],
"fork_timeoutsec": 3,
"fork_fromuri": "\"DISPLAY NAME\" <sip:username@domain>"
}
Parallel call group (parallel)
Group for parallelizing a call depending on the call initiator mask and optionally the call transfer initiator.
Any call to an account number listed in 'numbers_to' causes simultaneous calling of the parallel numbers specified in 'numbers_parallel'.
Any means direct, group, transferred, forwarded, or from a script.
If such a number is called as a parallel one from another functional group, the application of its parallel numbers depends on the cascade property of the functional group.
It is a general alternative to configuring an individual parallel call in the SIP user account.
In this case the call in statistics is bound to the real owner of the destination number.
The 'filter_from' filter is applied to the original initiating subscriber number without regard to forwarding and transfers. The number of the subscriber who forwarded the call can be filtered by the 'filter_by' field.
Field: filter_fromMode: inType: strDefault: * |
Source number filter mask. The result of modification by routing rules applied at previous steps is checked. Initially the source number from the username field of the Referred-By header, or, if absent, the From header of the SIP INVITE request, or the result of a more complex determination of the initiating subscriber number (e.g. sipuser phonenumber, the result of sipuser extension, callerid transformation rules on esg, etc.) is checked. Filter operation modes. |
|---|---|
|
Filter mask for the number of the subscriber who forwarded the call. |
|
List of numbers on whose call the group is activated. |
|
List of numbers used to initiate a parallel call. In any case, calls are sent to each destination number once. |
{
"filter_from": "*",
"filter_by": "*",
"numbers_to": ["205","206"],
"numbers_parallel": ["205","206","207"]
}
Chief-secretary group (chief)
When a call arrives at the chief from numbers not in the direct access list, the secretaries are called.
The decision whether the initiator may call the chief directly is made based on a filter applied to the number of the subscriber who transferred or forwarded the call to the chief.
At the same time, the group allows call pickup, BLF subscription between the chief and secretaries, and places incoming call details in BLF notifications for display on device panels so that group subscribers can see the call initiator and pick up.
Thus there is no need to configure separate permissions between the chief and secretaries with featurerule rules for the following function types:
* pickup, callwaiting, blf, blf_details - in all directions;
* intercom, barge - in the direction from the chief to the secretaries.
For the mode to work fully, you must:
* enable the 'blf_details_enabled' option in domain settings;
* configure BLF subscriptions on the chief’s and secretaries' phones as needed (so that secretaries see the chief’s state and the chief sees the secretaries' states);
* configure the display of call initiator information on the chief’s and secretaries' phones upon receiving a BLF message (Yealink: account.X.dialoginfo_callpickup=1, features.pickup.blf_visual_enable=1);
* restrict the application of BLF visualization on the chief’s and secretaries' phones to a specific list of numbers (Yealink: features.pickup.blf_visual.list=101,102,103 or any);
* if audio notification of a call to the chief’s number is needed, configure the secretaries' phones to play a melody upon receiving a BLF message (Yealink: features.pickup.blf_audio_enable=1), set the melody, and specify restrictions on BLF audio notification for a specific list of numbers (Yealink: features.pickup.blf_audio.list=101,102,103 or any).
With the above settings, the subscriber’s phone displays incoming calls of the monitored subscriber, providing the ability to pick up the selected one.
Pickup is performed by sending an INVITE with a Replaces header (rather than by calling a subscriber feature code, since in this mode it is impossible to specify a specific call to pick up).
There is an alternative configuration with pickup via a subscriber feature code:
* create a subscriber feature code of type "pickup by number" and configure its availability in routing rules;
* configure pickup function support on the chief’s and secretaries' phones - set the corresponding feature code number (Yealink: account.x.direct_pickup_code);
* when configuring BLF subscriptions on the chief’s and secretaries' phones, specify the pickup number for each (the same subscriber feature code).
For the feature code pickup mode to work, the phone option must be disabled (Yealink: account.X.dialoginfo_callpickup=0).
When using a 'pickup' feature code, it is impossible to specify a specific call to pick up if several calls arrive at the monitored device.
Therefore, to improve performance, it is advisable not to use BLF notification details, disabling the 'blf_details_enabled' option in domain settings.
Field: modeMode: inType: strDefault: cascade |
Operation algorithm. Possible variants: * parallel - when the chief’s number is called from any number not mentioned in the group, the call is redirected to both assistants in parallel.* cascade - when the chief’s number is called from any number not mentioned in the group, the call is redirected sequentially to the first assistant, then to the second.* direct - when the chief’s number is called from any number, the call proceeds without redirection. |
|---|---|
|
Chief’s number. |
|
First assistant’s number. |
|
Second assistant’s number. |
|
List of numbers that go directly to the chief. Applied to the result of from/referred-by transformation by routing rules. |
|
Chief’s mobile number. The number is used to automatically publish the state of the subscriber participating in the dialog. Example case: a secretary connects the chief on a mobile number sequentially with several subscribers. Extends the list of external numbers whose states are tracked, which is specified in domain settings. |
{
"mode": "cascade",
"chief_number": "101",
"assistant1_number": "102",
"assistant2_number": "103",
"direct_numbers": ["115", "123"]
}
Custom group (custom)
Used to implement project logic.
Field: filter_fromMode: inType: strDefault: * |
Source number filter mask. The result of modification by routing rules applied at previous steps is checked. Initially the source number from the username field of the Referred-By header, or, if absent, the From header of the SIP INVITE request, or the result of a more complex determination of the initiating subscriber number (e.g. sipuser phonenumber, the result of sipuser extension, callerid transformation rules on esg, etc.) is checked. Filter operation modes. |
|---|---|
|
Filter mask for the number of the subscriber who forwarded the call. |
|
List of numbers on whose call the group is activated. |
|
Project group type. Determines the set of other detail parameters. |
Additionally
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: |