# Webcast (Zoom) API

The Meeting Webcast APIs can be used to retrieve information about the Meeting's associated Zoom Meeting or Webinar.

# Webcast Endpoints

# Get Zoom webcast info

Get the Zoom webcast info for the specified meeting. The castProvider property will indicate whether the webcast is set as a Zoom Webinar or Meeting.

zoom: Zoom Webinar
zoom-meeting Zoom Meeting

GET /Meetings/{shortCode}/webcast

# Path Params

Property	Type	Description
shortCode	string	The meeting's unique short code

# Response

{
  "key": "58a0ff38-5eea-41c9-a7c3-af54968c2476",
  "castProvider": "zoom-meeting",
  "castId": 901453234,
  "meta": {},
  "rehearsalAt": "2022-03-12T04:28:52.719Z",
  "rehearsalTimezone": "America/Toronto",
  "rehearsalDuration": 30,
  "recordingsAt": "2022-03-12T04:28:52.719Z",
  "reportsAt": "2022-03-12T04:28:52.719Z",
  "status": "not-started",
  "createdAt": "2018-02-22T19:05:04.931Z",
  "updatedAt": "2018-02-22T19:05:04.931Z"
}

# Launch the Zoom Meeting

Calling this endpoint will return a URL that when followed, will take you to the Zoom website to launch the meeting. You can then choose to launch it in the Zoom Desktop client.

The URL will allow you to join the Zoom conference as the host of the meeting. Once inside the Zoom Meeting or Webinar, you can control the virtual conference directly via the client.

POST /Meetings/{shortCode}/webcast/launch

# Path Params

Property	Type	Description
shortCode	string	The meeting's unique short code

# Response

{
  "startUrl": "https://zoom.us/j/?t=........",
  "meetingCapacity": 300,
  "webinarCapacity": 500,
  "isInUse": true,
  "capacityWarning": true
}

← Proxies API