meeting Scope to build a Meetings experience. This top level scope of the meeting describes settings and features that apply to the meeting as a whole. The meeting scope is sent over the REST API to create a meeting (See: REST API Operations).
The meeting scope contains the following attributes:
|name||A name to assign to this meeting, for tracking purposes.||blank|
|guestUsersAllowed||Indicates whether unauthenticated users can join the meeting.||Takes the Account Setting|
A reference to a CSS file available to all clients, to apply to the CaféX Meetings UI.
Secure URLs are required.
|Takes the Account Setting|
Indicates whether the default CSS file is kept on the page, in addition to the one being applied in styleLink.
This will cause the Meetings solution to fetch the CSS you've provided and compile a CSS to share with users.
|Takes the Account Setting|
|style||Inline CSS to apply to the Meetings UI||Takes the Account Setting|
|features||A feature block that defines the default state or availability for each feature in the Meetings UI.
See also: Features Scope
|participants||A keyed list of participant blocks that describes the participant-specific properties for each identified potential participant in the meeting.
The key is the identifying username for the participant. The key value has the following special cases:
The list of URLs to be available to share.
See also: URLs Scope
|startTime||Controls when the meeting starts, if left blank the meeting can be started at any future time. If defined and a participant joins before the meeting start the wait treatment will be applied.||blank|
|endTime||Controls when the conference concludes, a participant will not be able to join after this time.||blank|
Sets the initial value for the participant spotlight toggle.
See: Using Spotlights
You can override a participant's spotlight behavior, see: Participants Scope
If true, when the meeting starts, the meeting automatically begins recording.
Use this attribute when you want to archive a meeting recording after a meeting finishes.
Important: If you start another meeting with the same MeetingId, Meetings replaces your original meeting recording.
A JSON array of participant groups names. The order you list the groups is the order participant previews appear in the display. Use this attribute to prioritize types of participant previews in the display. Participants with no group appear at the end of the preview display.
To add participants to a group, apply the
If true, Meetings present a warning to the meeting owners about 5 minutes before the meeting
If the meeting has no
Using StartTime & EndTime attributes
- The startTime and endTime are entered in ISO 8601 format, as in the following examples:
- "startTime": "2017-06-01T08:00:10.470Z",
- "endTime": "2017-06-01T11:21:10.470Z",
- If you attempt to join a meeting when the
endTimeis in the past, and the meeting has ended, the API will receive a
joinFailedresponse. The Meetings window should be closed and an appropriate error sent to the user.
- To prevent additional participants joining the meeting, you can update a meeting and set the
endTimeto the present, if the
- To terminate the meeting and remove all participants, set the meeting
endTime, to the past.
- It is not necessary to specify both the
endTimeparameters. If neither
endTimeis specified, the meeting can be joined at any time, and will stay open indefinitely, unless it is terminated or deleted using the appropriate API calls.
- If a meeting is retrieved using the API
endTimeare returned in UTC ISO 8601 format, regardless of the timezone information that was input using the
POSTthat created the meeting.
This example, disables document sharing and screen sharing for users. The Participants Scope can be used to override these features. It also specifies the start and end times of the meeting.