Participant (participant)

Description

Subscriber registered to participate in a selective meeting. Called by the system when the selective meeting starts and connected to the conference.

In particular, a participant can be an IVR script that records what the configured topology opens to it.

Limitations

  • It is a child composite object of the selective meeting entity. Deleted together with it.

  • When added via the API, one object can represent a contact group (number "group#<CODE>", where <CODE> is the contact group code) and is automatically expanded into several subscribers belonging to 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

Subscriber phone number for calling from the selective meeting.

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

Subscriber state.

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

Hold state

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

Participant microphone switch

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

Participant speaker switch

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

Switch for automatic redial mode on disconnect or failed call.

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

Participant role in the selective meeting for simplified topology management.

  • listener – Listener. Hears all speakers.

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

  • assistant – Assistant. Hears all speakers.

Applied when the selective meeting topology management mode is set to abonent.

Field: ext
Mode: inout
Type: object
Compound field

Allows extending the compound with arbitrary keys and values

See also

Logical roles

  • sel manages selective meetings.

  • conf directly manages the conference as a SIP UA.

  • mg services the conference media context and adds/removes terminations.