Meeting Room Object

This section outlines the Meeting Room object.

Meeting Room 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 create update	array of objects	Preset attributes that can be modified. Please refer to the Meeting Attributes section for a comprehensive list of attributes.
created read only	integer	The UNIX time stamp of the meeting room creation time.
description create update	string	The meeting room description.
didGroupReferences create update	array of objects	Data about the DID Group associated with the meeting room. This information includes the `didGroupId` and `state`. Refer to the table below for more information.
keychain create update	array of objects	Contains the access codes and matching roles. The keychain array can be modified through a `PUT` request. When creating a `PUT` request, include `accessCode` and `role`. Refer to the Meeting Key Object for more information.
meetingNumber create update	integer	The meeting number. This number is used in `GET`, `PUT`, and `DELETE` requests.
primaryDidGroupId create update	integer	The DID group associated with the meeting.
subscriberSid read only	string	The secure ID of the subscriber. This ID is unique to each subscriber and is used to identify them within the system.

Sample Meeting Room Object

{
    "attributes": [],
    "created": 1544482680000,
    "description": "Test Meeting",
    "didGroupReferences": [
        {
            "didGroupId": 219,
            "state": 0
        }
    ],
    "keychain": [
        {
            "accessCode": "463516",
            "id": 3464,
            "role": 3
        }
    ],
    "meetingNumber": 273751,
    "primaryDidGroupId": 219,
    "subscriberSid": "yIMW9.jKxffi2EyM.afDmeO.gke.9fe0"
}

DID Group Reference Object

The didGroupReferences array contains the didGroupId and state. The didGroupId references the DID group containing the phone numbers that can be dialed to access a Meeting Room.

Attribute Data Type Description

Attribute	Data Type	Description
didGroupId create update	string	The DID group ID. This is a unique identifier assigned to a group of Decentralized Identifiers (DIDs). It is used to reference and manage collections of DIDs within the system, enabling operations such as grouping, access control, and batch processing. The DID group ID ensures that related DIDs can be efficiently organized and accessed as a single entity.
state create update	integer	The state of the DID group. Values accepted in this field are: `0` for active (default) `1` for invalidated `2` for disabled

didGroupId

create update

string

The DID group ID. This is a unique identifier assigned to a group of Decentralized Identifiers (DIDs). It is used to reference and manage collections of DIDs within the system, enabling operations such as grouping, access control, and batch processing. The DID group ID ensures that related DIDs can be efficiently organized and accessed as a single entity.

state

create update

integer

The state of the DID group. Values accepted in this field are:

0 for active (default)
1 for invalidated
2 for disabled