Meeting Object
This section outlines the Meeting object.
Meeting Object Attributes
The fields listed in the table below will be returned in a JSON object when a successful request has been made.
Attribute | Data Type | Description |
---|---|---|
attributes | array of objects | The meeting attributes. These attributes define the call flow of the meeting. They can be overridden in the DID, DID Group, and Meeting Room objects. Refer to the attributes table below for a description of the object structure. Additionally, refer to the Meeting Attributes section for a comprehensive list of the attributes. |
created read only | string | The date and time when the meeting was created. |
duration read only | integer | The number of seconds that have elapsed since the meeting was created. |
holdMode read only | integer | Whether meeting participants and listeners are on hold. Values accepted in this field are either 0 or 40 . 0 means that no parties are on hold. 40 means that participants and listeners have been placed on hold by the meeting host. When callers are on hold, they will hear music while the hosts have a private discussion. Note that this value does not change. It is reflective of the initial hold state when the meeting starts. |
id read only | integer | The meeting ID. Note that when using GET , PUT , and DELETE requests, the meetingNumber should be used instead of this value. |
isRecording read only | boolean | Determines whether or not recording is currently on. |
isSecured read only | boolean | Determines whether or not the meeting is secured. |
meetingNumber read only | integer | The meeting number. Note that this is the value used to target a specific meeting in GET , PUT , and DELETE requests. |
muteMode read only | integer | There are three mute states. The following values reflect which access level parties have been muted:
|
participantCount read only | integer | The number of participants in the meeting. |
qaMode read only | integer | The state of a Q&A meeting. Values accepted in this field are:
|
state read only | integer | The state of the meeting. Values accepted in this field are:
|
subscriberName read only | string | The name of the first subscriber in the meeting. |
type read only | integer | Defines whether or not the meeting is participating in distributed meetings. If yes, the field value will be 1 and if no, the field value will be 0 . |
Attribute Object
This object is used in attributes
.
Refer to the Meeting Attributes section for a comprehensive list of the attributes. This section describes the structure of the attribute
objects.
Attribute | Data Type | Description |
---|---|---|
description | string | The description of the attribute. |
enumValues read only | string | If the |
group read only | integer | Defines the levels at which the call flow attribute value can be overridden. Integer values denote that the call flow attribute can be overridden at the following object levels:
|
name read only | string | The attribute name. |
type read only | integer | The attribute type. Values accepted in this field are:
|
value | string | The attribute value. |
Sample Meeting Object
{
"attributes": [],
"created": 1544729701000,
"duration": 48,
"holdMode": 0,
"id": 196938,
"isRecording": false,
"isSecured": false,
"meetingNumber": 106131,
"muteMode": 32,
"participantCount": 1,
"qaMode": 0,
"state": 2,
"subscriberName": "John Smith",
"type": 1
}