Update Live Stream Status

Zoom allows users to live stream a meeting to a custom platform. Use this API to update the status of a meeting's live stream.

Prerequisites:

Meeting host must have a Pro license.
Scopes: meeting:write:admin meeting:write
Rate Limit Label: Light

请求参数

Path 参数

meetingId

integer <int64>

必需

The meeting ID in long format. The data type of this field is "long"(represented as int64 in JSON).

While storing it in your database, store it as a long data type and not as an integer, as the Meeting IDs can be longer than 10 digits.

Body 参数multipart/form-data

action

enum<string>

可选

Update the status of a livestream.

The value can be one of the following:
start: Start a live stream.
stop: Stop an ongoing live stream.

枚举值:

startstop

settings

object

可选

Update the settings of a live streaming session. The settings can only be updated for a live stream that has been stopped. You can not update the settings of an ongoing live stream.

active_speaker_name

boolean

可选

Display the name of the active speaker during a live stream.

display_name

string

可选

Display name of the live stream.

>= 1 字符<= 50 字符

返回响应

🟢204**HTTP Status Code:** `204` Meeting live stream updated.

application/json

Body

object {0}

🔵300**Error Code:** `300` Missing meetingId. Invalid meetingId

🟠400**HTTP Status Code:** `400` **Error Code:**`3000` Cannot access webinar info. **Error Code:**`1010` User does not belong to this account: {accountId}.

🟠404**HTTP Status Code:** `404` **Error Code:**`1001` User {userId} does not exist.

🟠429**HTTP Status Code:** `429` Too many requests submitted to start the live stream of this meeting: {meetingId}. If the live stream has not already started, retry making a new request after 30 seconds.