Group number (sipgroup)

Description

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

Group subscribers are called through the forwarding mechanism and a two-level list. First, subscribers of the first group are called; if all fail, subscribers of the second group are called, and so on.

Each subscriber may have its own configured 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 matches to avoid duplicate calls. Absolute and no-registration forwarding are taken into account. Other types of conditional forwarding are applied after responses to sent INVITE requests are received.

Limitations

  • The collection is unavailable 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
  }
}
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"

Field: dialplan
Mode: in
Type: array<object>
Default: empty

Group number composition and subgroup call order.
Each object in the list represents a subgroup of simultaneously called internal numbers.
Dialplan list element.

Field: pickup
Mode: in
Type: intbool
Default: true

Availability flag for featurecode of type pickupgroup

Field: opts
Mode: in
Type: object

Compound field

Field: opts.title
Mode: in
Type: str
Default: empty

Arbitrary title

Field: opts.comment
Mode: in
Type: str
Default: empty

Arbitrary comment

Field: opts.filter_mode
Mode: in
Type: str
Default: "all

URI duplicate filtering mode when creating forks: all, inner, outer, none - filter all, filter only internal, filter only external, do not filter

Field: ext
Mode: inout
Type: object

Compound field allowing extension 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"

Sequential calling of the accounts in strict order of their listing in the dialplan field. The next account is called only after the previous call fails or is declined.

"parallel"

All group elements are called simultaneously

"random"

Sequential random order. Randomization is performed independently on each call.

Dialplan list element

Table 3. Dialplan list element
Field Value type Description

dial

array<str>

List of numbers to be called simultaneously within the subgroup. The list cannot be empty. Numbers must be routable. These can be external numbers, user account numbers, or numbers of other groups.

timeout

int

Subgroup call time in milliseconds. If the field is absent, the standard fork timeout of 30 seconds is used.

See also

Logical roles

  • b2b performs routing and applies the group number to organize forks.

  • mdc and sdc search for the group number.