Create BigBlueButton video call

GET https://zulip.fairsharing.org/api/v1/calls/bigbluebutton/create

Create a video call URL for a BigBlueButton video call. Requires BigBlueButton to be configured on the Zulip server.

Usage examples

curl -sSX GET -G https://zulip.fairsharing.org/api/v1/calls/bigbluebutton/create \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode 'meeting_name=test_channel meeting'

Parameters

meeting_name string required

Example: "test_channel meeting"

Meeting name for the BigBlueButton video call.


Response

Return values

  • url: string

    The URL for the BigBlueButton video call.

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"
}