Meeting Room Object

In CarrierX API, the Meeting Room objects describe the meeting configurations.

The system returns a Meeting Room JSON object with the fields listed in the table below in response to one of the following successful requests:

• Create Meeting Room
• Get Meeting Rooms
• Get Meeting Room by SID
• Update Meeting Room

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
access_codes createupdate	array of objects	An array of Meeting Key objects containing the information about the access codes and their matching roles. Please note that access codes must be unique across all the meeting rooms within a single conference endpoint.
account_sid read only	string	The secure ID of the account associated with the meeting room.
properties createupdate	object	The call flow properties which will be overriden at the meeting room level. Refer to this section for more details on various conference v2 call flow properties.
did_group_sid createupdate	string	The secure ID of the DID group associated with the meeting room.
meeting_room_sid read only	string	The secure ID of the meeting room.
name createupdate	string	The meeting room name. This is a human-readable nickname for the meeting room.

Meeting Key Object

note

The access codes must be unique across all the meeting rooms within a single conference endpoint.

Attribute	Data Type	Description
access_code createupdate	string	The access code which the calling party must enter to gain the abilities of the corresponding role.
role createupdate	string	The roles that the calling party will have in the conference. Values accepted in this field are: host for the users that have the moderator access role. listener for the users that have a limited listener access role, cannot take a full-fledged part in the meeting, but can only listen to what others say. participant for the users that have a normal user access role.

Sample Meeting Room Object

{
    "access_codes": [
        {
            "access_code": "890671",
            "role": "host"
        },
        {
            "access_code": "265423",
            "role": "listener"
        },
        {
            "access_code": "143623",
            "role": "participant"
        }
    ],
    "account_sid": "a1f38bf7-5879-49c1-be72-50ffa7f249a6",
    "properties": {},
    "did_group_sid": null,
    "meeting_room_sid": "2652635f-10a6-4b2a-a46b-2eeb75ddeab6",
    "name": "N/A"
}