Web Meetings SDK | Unified Space Meetings (USM)
Webex Meeting today has three distinct meeting experiences: Personal Meeting Rooms (PMR), Scheduled Meetings, and Space Meetings. Each of those meeting types has distinct experiences. Unified Space Meetings (USM) consolidates the experiences of Space Meetings with Webex Meetings and melds them together.
This article explains how to enable USM, how to start ad-hoc meetings, including information on password and captcha support.
anchorWebex Meeting Types
anchorWebex meetings can be broadly classified as:
- Webex Meetings
- Scheduled Webex Meetings - The meeting is created first and then the meeting information such as the meeting ID, pass code, and unique meeting link is sent to the invitees.
- PMR (personal meeting room or "instant meeting") - A meeting with a static URL that can be attached to a meeting schedule as well as sent out as a message for anyone to join.
- Space Meetings
- Scheduled Space Meetings - The meeting is created first and then the meeting information such as the meeting ID, pass code, and unique meeting link is sent to the members of the space.
- Ad-hoc Space Meetings - The meeting can be started instantly from a team space, without any pre-scheduled meeting links. Although these meetings are instant and do not have a meeting ID or URL when they're started, Webex creates both which can be obtained via the Meeting Info API.
anchorPrerequisites for USM
anchorThe only prerequisite is that unified meetings must be enabled.
In the SDK, the default values for enableUnifiedMeetings
and enableAdhocMeetings
have been set to true
.
anchorVerify that USM is Enabled
anchorTo verify that USM is enabled, check to see that the following statement returns true
:
webex.meetings.config.experimental.enableUnifiedMeetings;
anchorEnabled USM if It's Disabled
anchorTo toggle USM on or off:
webex.meetings._toggleUnifiedMeetings(changeState);
Asynchronous | No |
Parameters | changeState<Boolean (true / false)> |
Returns | undefined |
You can also change the configuration by toggling the following values:
Meetings :{
experimental: {
enableUnifiedMeetings: false,
enableAdhocMeetings: false
}
}
anchorCreate an Ad-hoc Space Meeting
anchorCreate an ad-hoc space meeting using a room ID via the Webex REST Room API.
Here's a typical room object:
{
"id": "Y2lzY29zcGFyazovL3VzL1JPT00vYzVlNjgxODAtMDkxMy0xMWVkLWFmZjQtYTc5YzYwNWU1MEKl",
"title": "Example Room",
"type": "group",
"isLocked": false,
"lastActivity": "2022-08-25T07:30:18.466Z",
"creatorId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zNDRlYTE4My05ZDVkLTRlNzctYWVkMi1jNGYwMDRhZmR6NUV",
"created": "2022-07-21T16:40:04.760Z",
"ownerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGVyNHZ",
"isPublic": false
}
Pass the id
to the Meetings
object's create()
method to create a new meeting:
webex.meetings.create(roomId);
Asynchronous | Yes |
Mandatory Parameters | roomId |
Returns | A promise that gets resolved and returns a Meeting object. |
anchorJoin an Ad-hoc Meeting in Progress
anchorWhen an ad-hoc meeting is created, Webex generates a meeting ID and a URL, which then can be shared with others who can then join using that information.
To retrieve that meeting information, access the Meeting
object's meetingInfo
instance variable:
meeting.meetingInfo;
For a working example, see the Kitchen Sink App.
anchorJoin a Meeting by Entering a Password/Captcha
anchorIf the user is not a member of the space where the has been created, the user is prompted for the meeting password. If the user enters the password incorrectly too many times, captcha information is provided along with an informational error code.
For more information see: