Meeting Object

In CarrierX API, the Meeting objects describe the temporary entities which represent the meetings.

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

• Get Meetings
• Get Meeting by SID
• Update Meeting

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
account_sid read only	string	The secure ID of the account associated with the meeting.
attendees read only	object	The attendees currently present at the meeting. The returned object contains the list of the meeting attendees (host, participant, and listener) and the quantity of each of the attendees.
date_created read only	string	The date and time when the meeting was created.
duration read only	integer	The meeting duration in seconds.
locked read only	boolean	Whether the meeting allows more participants and listeners to join. Hosts can join the meeting with any value in this field. Values accepted in this field are true or false.
meeting_room_sid read only	string	The secure ID of the meeting room associated with the meeting.
meeting_sid read only	string	The meeting secure ID.
on_hold update	string	The meeting participants for whom the meeting is currently put on hold. Values accepted in this field are p, l, and any combinations of them.
participant_muted update	string	Specifies whether the meeting participants are muted. Values accepted in this field are: false to show that only the users with the listener access role are muted. The users with the participant and host roles can talk. relaxed to show that the users with the participant and listener access roles are muted. The users with the participant roles can unmute themselves. true to show that the users with the participant and listener access roles are muted by the host or the conference property settings and cannot unmute themselves.
recording read only	boolean	Whether the meeting is currently being recorded or not. Values accepted in this field are true or false.

Sample Meeting Object

{
    "account_sid": "a1f38bf7-5879-49c1-be72-50ffa7f249a6",
    "attendees": {
        "hosts": 1,
        "listeners": 0,
        "participants": 0
    },
    "date_created": "2021-06-23T17:36:37.000Z",
    "duration": 35,
    "locked": false,
    "meeting_room_sid": "e1b86c9b-d758-4e3a-9bd4-a0016a3b10b1",
    "meeting_sid": "69057c3e-bb90-4ed3-9c53-000000944173",
    "on_hold": "pl",
    "participant_muted": "false",
    "recording": false
}