Group number (sipgroup)

Table of Contents

Description
Limitations
Fields
- Group call mode
- List item dialplan
See also
- API
- Logical roles

Description

Defines a phone number consisting of multiple SIP user accounts, external numbers, or other groups, and the order in which they are called.

Calling subscribers of a group is carried out through the mechanism of forwarding and building a two-level list. The subscribers of the first group are called first, in case of failure on all the subscribers of the second group are called, etc.

Each of the subscribers can have its own customized forwarding rules. They are applied according to the application rules.

There are no restrictions on the number and type of simultaneously or sequentially called subscribers. Initially, the two-level list is filtered by coincidences to avoid multiple calls. Absolute and unregistered call forwardings are taken into account. Other types of conditional redirections are applied after receiving responses to sent requests INVITE.

Limitations

The collection is not available in the master domain.

Fields

Entity structure

{
  "id": uuid,
  "phonenumber": str,
  "type": str,
  "dialplan": array<object>,
  "pickup": intbool,
  "opts": {
    "title": str,
    "comment": str
  },
  "ext": {
    "ct": date,
    "lwt": date
  }
}

Description of the specification’s characteristics

Table 1. Fields
Specification	Description
Field: `id` Mode: `inout` Type: `uuid` Default: generated	Identifier. Can be specified at creation, otherwise generated by the system.
Field: `phonenumber` Mode: `in` Type: `str` Default: required	Group number
Field: `type` Mode: `in` Type: `str` Default: `"cascade"`	Group calling mode
Field: `dialplan` Mode: `in` Type: `array<object>` Default: empty	Group number composition and subgroup calling order. Each object in the list represents a subset of simultaneously called extension numbers. List item dialplan.
Field: `pickup` Mode: `in` Type: `intbool` Default: `true`	Availability feature for featurecode type `pickupgroup`
Field: `opts` Mode: `in` Type: `object`	Composite field
Field: `opts.title` Mode: `in` Type: `str` Default: empty	Arbitrary header
Field: `opts.comment` Mode: `in` Type: `str` Default: empty	Arbitrary comment
Field: `opts.filter_mode` Mode: `in` Type: `str` Default: "all	Mode of filtering duplicate URIs when creating forks. all, inner, outer, none - filter all, filter only inner, filter only outer, filter none
Field: `ext` Mode: `inout` Type: `object`	Composite field allowing to extend the composition with arbitrary keys and values
Field: `ext.ct` Mode: `out` Type: `date` Default: generated	Object creation time
Field: `ext.lwt` Mode: `out` Type: `date` Default: generated	Time of last modification of the object

Group call mode

Table 2. Group call mode
Value	Description
`"cascade"`	Sequentially invoke the constituent accounts strictly in the order listed in the `dialplan` field. The next account is invoked only after the previous account has failed to invoke or has failed.
`"parallel"`	All elements of the group are called at the same time
`"random"`	Sequentially randomized order. Randomization is performed independently for each call.

List item dialplan

Table 3. List item dialplan
Field	Value Type	Description
`dial`	`array<str>`	A list of numbers to be called simultaneously within a subgroup. The list cannot be empty. The numbers must be available for routing. These can be external numbers, user account numbers, numbers of other groups.
`timeout`	`int`	Time for calling the subgroup in milliseconds. If the field is absent, the standard timeout for forks - 30 seconds - is applied.