conference call (selector)

Table of Contents

Description
Limitations
Fields
- Selector status
- Selector operating modes
See also
- API
- Logical roles

Description

Selector meeting descriptor.

A conference call is a special kind of audio conference with a controlled topology. Control is performed by the lead participant via API (from the UI application). The participants of the conference call are called by the system.

A conference call can be started manually or automatically on a schedule.

A running selector meeting can exist for a maximum of 9800 sec. after which it will be stopped and deleted.

Limitations

After a scheduled conference call is held, it is automatically turned off, but remains in existence and available for restart.
The collection is managed and stored by sel. Does not reflect modification operations in change journal.
Represents both a descriptor and a rantime object of an active conference.

Fields

Entity structure

{
  "id": uuid,
  "state": str,
  "calldurationsec": int,
  "calltimeout": int,
  "timestartutc": date,
  "topology_mode": str,
  "displayname": str,
  "enabled": bool,
  "mediafile": null | str,
  "comment": str,
  "default_mic": bool,
  "default_spk": bool,
  "default_recall": bool,
  "ext": object
}

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: `state` Mode: `inout` Type: `str` Default: required	Status. modifier Available values.
Field: `calldurationsec` Mode: `in` Type: `int` Default: `0`	The duration of the time interval during which the participants are called, including repeated calls, in seconds. `0` - not limited.
Field: `calltimeout` Mode: `in` Type: `int` Default: `35`	Limit the duration of one specific call by any participant.
Field: `timestartutc` Mode: `in` Type: `date` Default: required	Date and time of automatic conference collection, in UTC. To force a selector meeting, you must assign a value in the past tense.
Field: `topology_mode` Mode: `in` Type: `str` Default: required	Topology Control Mode.
Field: `displayname` Mode: `in` Type: `str` Default: empty	The name of the selector meeting to be substituted when calling subscribers as displayname in the From SIP request header URI INVITE.
Field: `enabled` Mode: `in` Type: `bool` Default: `false`	Selector meeting switch.
Field: `mediafile` Mode: `in` Type: `str` Default: str_empty	Sound file name from the selector meeting file directory (API `/rest/v1/fs/targets/selector`). Used for automatic pre-playback to an answering party before joining the caller in a conference call.
Field: `comment` Mode: `in` Type: `str` Default: str_empty	Arbitrary comment
Field: `default_mic` Mode: `in` Type: `bool` Default: false	Microphone status for added participants.
Field: `default_spk` Mode: `in` Type: `bool` Default: `true`	Speaker state for added participants.
Field: `default_recall` Mode: `in` Type: `bool` Default: false	Status of allowing automatic chime for added participants.
Field: `ext` Mode: `inout` Type: `object` Compound field	Allows you to extend the compound with arbitrary keys and values

Selector status

Table 2. Selector status
Value	Description
`"initing"`	Initializing a runtime object after an entity is created.
`"connecting"`	Connecting to a conference server (role conf).
`"online"`	Active, calls/service to subscribers are being made.
`"waiting"`	Waiting for activation. By schedule or property enabled.
`"error"`	Error, pending changes (object properties, or occurrence of conference access).

Selector operating modes

Table 3. Selector operating modes
Value	Description
`"abonent"`	Simplified control mode through the roles of listeners: listener, speaker, prompting (assistant).
`"direct"`	Direct topology control mode.