Skip to main content

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.

AttributeData TypeDescription
attributesarray of objectsThe 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
stringThe date and time when the meeting was created.
duration
read only
integerThe number of seconds that have elapsed since the meeting was created.
holdMode
read only
integerWhether 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
integerThe meeting ID. Note that when using GET, PUT, and DELETE requests, the meetingNumber should be used instead of this value.
isRecording
read only
booleanDetermines whether or not recording is currently on.
isSecured
read only
booleanDetermines whether or not the meeting is secured.
meetingNumber
read only
integerThe meeting number. Note that this is the value used to target a specific meeting in GET, PUT, and DELETE requests.
muteMode
read only
integerThere are three mute states. The following values reflect which access level parties have been muted:
  • 32 for listeners have been muted.
  • 36 for listeners have muted themselves and participants have muted themselves.
  • 40 for participants and listeners have been muted.
Note that this value does not change in the Meeting object. It is reflective of the initial mute state when the meeting is started.
participantCount
read only
integerThe number of participants in the meeting.
qaMode
read only
integerThe state of a Q&A meeting. Values accepted in this field are:
  • 0 for meeting has not started yet.
  • 1 for active meeting.
  • 2 for talking to the next participant in the queue.
  • 4 for clearing the queue.
state
read only
integerThe state of the meeting. Values accepted in this field are:
  • 0 for completed meeting, or meeting that has not started yet.
  • 1 for on hold meeting.
  • 2 for active meeting.
subscriberName
read only
stringThe name of the first subscriber in the meeting.
type
read only
integerDefines 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.

AttributeData TypeDescription
descriptionstring

The description of the attribute.

enumValues
read only
string

If the type value is 5, this attribute will be automatically populated with possible values.

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:

  • 1 (0 bit) for Call Flow and DID Group
  • 2 (1 bit) for DID
  • 4 (2 bit) for Meeting Room
The combinations of the values can also be used:
  • 3 (1 + 2) for Call Flow, DID Group, and DID
  • 5 (1 + 4) for Call Flow, DID Group, and Meeting Room
  • 6 (2 + 4) for DID and Meeting Room
  • 7 (1 + 2 + 4) for Call Flow, DID Group, DID, and Meeting Room

name
read only
string

The attribute name.

type
read only
integer

The attribute type. Values accepted in this field are:

  • 0 for TYPE_STRING
  • 2 for TYPE_INT
  • 3 for TYPE_DTMF
  • 4 for TYPE_ROLE
  • 5 for TYPE_CHOICE
  • 6 for TYPE_DB_REFERENCE
  • 7 for TYPE_UPLOAD
  • * for any

valuestring

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
}