State for known conferences
Properties:
| Name | Type | Description |
|---|---|---|
states |
Map.<string, ConferencesState.ConferenceState> | active conferences states by conference SID |
Type Definitions
Conference
Conference type
Properties:
| Name | Type | Description |
|---|---|---|
sid |
string | SID of the task |
status |
ConferencesState.ConferenceStatus | status of the conference |
conferenceSid |
string | SID of the conference |
participants |
Array.<ConferencesState.ConferenceParticipant> | participants in the conference, including the ones who have left |
liveParticipantCount |
number | count of currently live participants |
liveWorkerCount |
number | count of currently live workers |
liveWorkers |
Array.<ConferencesState.ConferenceParticipant> | active worker participants in the conference |
ConferenceParticipant
Conference participant
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
queue |
IQueue |
<optional> |
queue associated with the participant (in case of transfer to queue) |
worker |
IWorker |
<optional> |
worker associated with the participant |
callSid |
string | call SID associated with the voice connection of the participant | |
isMyself |
boolean | is participant associated with the currently logged in user | |
onHold |
boolean | is participant on hold | |
muted |
boolean | is participant muted | |
connecting |
boolean | is participant in connecting state | |
status |
ConferencesState.ParticipantStatus | status of the participant | |
participantType |
ConferencesState.ParticipantType | type of the participant | |
reservationSid |
string | reservation SID for the participant | |
workerSid |
string | SID of the worker |
ConferenceState
Conference state
Properties:
| Name | Type | Description |
|---|---|---|
source |
ConferencesState.Conference | source object of the conference |
"left"
|
"joined"
|
"recently_left"
ConferenceStatus
Conference status
"left"
|
"joined"
|
"recently_left"
ParticipantStatus
Participant status
"worker"
|
"customer"
|
"transfer"
|
"supervisor"
|
""
ParticipantType
Participant type