Hunt group (hunt)
Description
Hunt group descriptor with a waiting queue. SIP users are assigned as queue resources.
Serviced by the huntq role, which builds waiting queues from descriptors, monitors resource states, and connects waiting objects with resources based on configured strategies.
Calls can be placed in the queue. Call placement in queues is managed by the IVR role through feature codes (featurecode) of type 'hunt' and 'queue'.
To organize personal and group queues, entities need not be created separately; they are dynamically recreated with default settings when a call arrives at a 'queue' feature code. If specific properties are needed for such a queue, it is enough to create an entity with the required parameters and specify the corresponding user’s or group’s number (or number filter mask) in the hunt entity’s 'opts.filter_number' field.
The object can be a template from which queue descriptors are dynamically built when a call arrives at the "queue" subscriber feature code.
Thus, one hunt entity instance can configure a unified format of different queues for several (or all) objects - users or groups. The entity is treated as a template if the 'opts.template_type' field is set to 'personal' or 'group'.
When a call arrives at the queue, the dialed number’s postfix (extension) is treated as the number for which a specific hunt entity is first searched, then a template, then a dynamic descriptor with standard default values is built.
Whether a specific template is applied for dynamic descriptor construction depends on the specified type ('opts.template_type') and number mask ('opts.filter_number'). Specifically, whether the mask specified in 'opts.filter_number' (and optionally 'opts.tab') matches the extension of the dialed number. If it matches, a sipuser or sipgroup account with the examined number is discovered, depending on the template type specified in 'opts.template_type'.
Limitations
-
The collection is unavailable in the master domain.
-
Licensed by a quantitative parameter: a license is consumed for the number of resources of the selected type.
Fields
{
"id": uuid,
"code": str,
"phonenumber": str,
"priority": int,
"type": str,
"resourses": array<object>,
"strategy": object,
"resmode": str,
"objmode": str,
"weight": int,
"wivrscript": str,
"qivrscript": str,
"preivrscript": str,
"reslimit": int,
"maxattempts": int,
"maxattemptstrannumber": str,
"resdialtimeout": int,
"timeout": int,
"timeouttrannumber": str,
"displayname": str,
"huntblock": object,
"resbansec": int,
"opts": {
"title": str,
"comment": str,
"exit_no_resource": bool
},
"ext": {
"ct": date,
"lwt": date
}
}
| Specification | Description |
|---|---|
Field: |
Identifier. Can be specified at creation, otherwise generated by the system. |
Field: |
Code. Used to associate with other entities. Unique value. |
Field: |
Phone number. It is the key when searching for the entity when a call arrives at a feature code of type 'hunt'. When forming a template, the field is not used and is filled automatically. |
Field: |
Queue priority. |
Field: |
|
Field: |
List of queue resources (participants) with their priorities. Composition of list element fields. |
Field: |
Strategy for adding participants for the object (subscriber). Field composition. |
Field: |
Resource (participant) selection strategy from free resources when a new object arrives in an empty queue |
Field: |
Queue object selection strategy when a resource is released |
Field: |
Queue weight. |
Field: |
IVR greeting script code in the call queue. |
Field: |
IVR waiting script code in the call queue. |
Field: |
IVR pre-playback script code for a call queue participant after their answer before connecting to the subscriber. |
Field: |
Number of simultaneously issued resources. |
Field: |
Maximum allowed number of resource (participant) calls. |
Field: |
Number to switch to when maxattempts is exceeded. |
Field: |
Dial attempt duration in seconds. |
Field: |
Maximum queue waiting time in seconds |
Field: |
Number to switch to when the maximum waiting time is exceeded. |
Field: |
DisplayName substituted into the call from the queue to the resource. |
Field: |
Mode for applying a temporary ban on using a SIP user resource after call servicing ends. Example:
Used when type = |
Field: |
Time in seconds for which the resource (participant) becomes blocked due to a connection failure. |
Field: |
|
Field: |
Arbitrary title |
Field: |
Arbitrary comment |
Flag for stopping waiting when no resources are available |
|
Field: |
Switch for early-media mode while waiting in the queue. For calls from an external network, providers may limit the time spent in Early Media state, for example 20 seconds, after which they terminate the session.
|
Field: |
Template mode. Not used by default. Value variants:
|
Field: |
Number filter mask for the number the redirect rule belongs to. |
Field: |
Tabular data for using filters within one entity search session. |
Field: |
Allows extending the compound with arbitrary keys and values |
Field: |
Object creation time |
Field: |
Time of last modification of the object |
Queue types
| Value | Description |
|---|---|
|
All resources are identifiers of the user object. |
|
All resources are identifiers of the sipuser object. |
Composition of resource list element fields
| Field | Value type | Description |
|---|---|---|
|
|
|
|
|
Resource (participant) priority at the time resmode is applied |
Composition of strategy fields
| Field | Value type | Description |
|---|---|---|
|
|
Strategy name:
|
|
|
List of time offsets for starting the next resource (participant) call, starting from the second. |
Resource (participant) selection strategies
| Value | Description |
|---|---|
|
Selects the highest-priority resource from the free ones, and if there are several, selects among them randomly |
|
Selects a random resource from those currently free |
|
Selects free resources exactly in the order they are listed in the resources field |
Object (subscriber) selection strategies
| Value | Description |
|---|---|
|
(Strict Priority Queueing) – queue selection mode based on priority |
|
(Weighted Fair Queueing) – queue selection mode based on weight |
|
queue selection mode based on priority, and among equal priority based on weight |
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: |