Participant (participant)

Description

A subscriber registered to participate in a conference call. Called by the system when the conference call starts and is connected to the conference.

In particular, the subscriber may be an IVR script that records what the customized topology reveals to it.

Limitations

  • Is a child composite object of the selector meeting entity. It is deleted together with it.

  • When added via the API, a single object can represent a contact group (number "group#<CODE>", where <CODE> is the code contactgroup) and automatically expand into multiple subscribers within it.

Fields

Entity structure
{
  "id": uuid,
  "name": str,
  "number": str,
  "state": str,
  "hold": bool,
  "mic": bool,
  "spk": bool,
  "recall": bool,
  "topology_type": str,
  "ext": object
}
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: name
Mode: in
Type: str
Default: empty

Subscriber Name

Field: number
Mode: in
Type: str
Default: empty

Telephone number of the subscriber to call from the conference call.

Field: state
Mode: out
Type: str
Default: required

Subscriber status.

Field: hold
Mode: out
Type: bool
Default: false

Hold status

Field: mic
Mode: in
Type: bool
Default: true

Participant microphone off switch

Field: spk
Mode: in
Type: bool
Default: true

Participant speaker switch

Field: recall
Mode: in
Type: bool
Default: false

Switch for automatic recall mode when a call breaks or fails.

Field: topology_type
Mode: in
Type: str
Default: required

Caller role in a conference call for simplified topology management.

  • listener – Listener. Hears all the speakers.

  • speaker – Speaker. Hears other speakers and all assistants.

  • assistant – Assistant. Hears all speakers.

Applies when the selector meeting topology control mode is set: abonent.

Field: ext
Mode: inout
Type: object
Compound field

Allows you to extend the compound with arbitrary keys and values

See also

Logical roles

  • sel conducts conference call management.

  • conf Directly manages the conference as SIP UA.

  • mg Conducts media context maintenance for the conference, adds/removes termneisons.