Create Webex video call

POST https://chat.zulip.org/api/v1/calls/webex/create

Create a video call URL for a Webex video call.

Requires Webex integration to be configured on the Zulip server.

Clients should confirm that the user has completed the OAuth process with Webex and has a Webex token before attempting to create a video call URL. See the has_webex_token field in the POST /register response, as well as the has_webex_token event type.

Changes: New in Zulip 12.0 (feature level 493).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX POST https://chat.zulip.org/api/v1/calls/webex/create \
    -u EMAIL_ADDRESS:API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

  • url: string

    The URL for the Webex meeting.

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": "https://xxkk-7xpz.webex.com/xxkk-7xpz/j.php?MTID=mebb3ba1f366f683bcaec9d32773ce034"
}