GET https://kumarp10zimbrasupportlabcom.chat.kumarp05.zimbrasupportlab.com/api/v1/calls/bigbluebutton/create
Create a video call URL for a BigBlueButton video call.
Requires BigBlueButton 2.4+
to be configured on the Zulip server.
The acting user will be given the moderator role on the call.
Changes: Prior to Zulip 10.0 (feature level 337), every
user was given the moderator role on BigBlueButton calls, via
encoding a moderator password in the generated URLs.
Usage examples
curl -sSX GET -G https://kumarp10zimbrasupportlabcom.chat.kumarp05.zimbrasupportlab.com/api/v1/calls/bigbluebutton/create \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
--data-urlencode 'meeting_name=test_channel meeting' \
--data-urlencode voice_only=true
Parameters
meeting_name string required
Example: "test_channel meeting"
Meeting name for the BigBlueButton video call.
voice_only boolean optional
Example: true
Configures whether the call is voice-only; if true,
disables cameras for all users. Only the call
creator/moderator can edit this configuration.
Changes: New in Zulip 10.0 (feature level 337).
Response
Return values
Example response(s)
Changes: As of Zulip 7.0 (feature level 167), if any
parameters sent in the request are not supported by this
endpoint, a successful JSON response will include an
ignored_parameters_unsupported array.
A typical successful JSON response may look like:
{
"msg": "",
"result": "success",
"url": "/calls/bigbluebutton/join?meeting_id=%22zulip-something%22&password=%22something%22&checksum=%22somechecksum%22"
}