更新实时流状态 - Zoom API 中文版

Zoom允许用户将会议直播到自定义平台。更新会议直播的状态。

** 先决条件: **

会议主持人必须具有Pro许可证。

** 范围: ** 'meeting:master'

** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'Light'

请求参数

Path 参数

meetingId

integer

必需

会议的ID。

在数据库中存储此值时，必须将其存储为长格式整数，而不是整数。会议id可以超过10位数。

accountId

string

帐户的唯一标识符。

必需

Body 参数application/json

会议实时流状态。

settings

object

可选

更新实时流会话的设置。只能为已停止的实时流更新设置。您无法更新正在进行的实时流的设置。

active_speaker_name

boolean

可选

在直播期间显示活动发言人的名称。

示例值:

true

display_name

string

直播流的显示名称。

可选

>= 1 字符<= 50 字符

示例值:

Jill Chill

action

enum<string>

可选

更新直播流的状态。

该值可以是以下值之一:

'开始': 开始直播。

“停止”: 停止正在进行的直播。

枚举值:

startstop

示例值:

start

示例

{
    "settings": {
        "active_speaker_name": true,
        "display_name": "Jill Chill"
    },
    "action": "start"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢204** HTTP状态代码: ** '204' 会议直播已更新。

application/json

Body

object {0}

示例

{}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误码: ** '3000' 无法访问网络研讨会信息。 ** 错误代码: ** '1010' 用户不属于此帐户: {accountId}。 ** 错误代码: ** '3161' 您的用户帐户不允许使用会议托管和日程安排功能。

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '1001' 用户 {userId} 不存在。