获取网络研讨会详细信息

从实时或过去的网络研讨会中检索详细信息。

** 先决条件: **

商业、教育或API计划与网络研讨会插件。

** 范围: ** 'dashboard_webinars:master'

** [速率限制标签](https://marketplace.zoom.us/docs/api参考/速率限制 # 速率限制):** “沉重”

请求参数

Path 参数

webinarId

string

必需

网络研讨会的ID或通用唯一ID (UUID)。

如果您提供网络研讨会ID，API将返回最新网络研讨会实例的响应。

如果您提供的网络研讨会UUID以 “/” 字符开头或包含 “//” 字符，在发起api请求之前，您必须 ** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/# meeting-id-and-uuid) 网络研讨会UUID。

accountId

string

帐户的唯一标识符。

必需

Query 参数

type

string

可选

要查询的网络研讨会的类型:

'过去'-所有过去的网络研讨会。

'live'-所有实时网络研讨会。

此值默认为 “live”。

返回响应

🟢200** HTTP状态代码: ** '200' 返回了网络研讨会详细信息。仅适用于已启用仪表板功能的付费帐户。

application/json

Body

网络研讨会度量详细信息。

has_automated_captions

boolean

可选

指示会议中是否启用了自动标题。

示例值:

true

audio_quality

enum<string>

可选

网络研讨会的音频质量分数:

'好'-音频几乎完美无瑕，质量非常好。

'公平'-音频偶尔会出现失真，噪音和其他问题，但内容基本上是连续的。参与者可以正常交流。

“差”-音频经常有失真，噪音和其他问题，但内容基本上是连续的。参与者可以正常交流。

“坏”-声音质量极差，音频内容几乎听不见。

枚举值:

goodfairpoorbad

示例值:

good

has_voip

boolean

可选

指示网络研讨会是否使用了VoIP。

示例值:

true

custom_keys

array [object {2}]

可选

分配给网络研讨会的自定义键和值。

<= 10 items

value

string

可选

与网络研讨会关联的自定义密钥的值。

<= 256 字符

示例值:

value1

key

string

可选

与网络研讨会关联的自定义密钥。

<= 64 字符

示例值:

key1

has_recording

boolean

可选

指示是否将录制用于网络研讨会。

示例值:

true

uuid

string

可选

网络研讨会UUID。

示例值:

NknQtFSgSUSEYt2a9gc13A==

has_video

boolean

可选

指示视频是否用于网络研讨会。

示例值:

true

duration

string

可选

网络研讨会持续时间，格式为hh:mm:ss，例如: “10:00” 十分钟。

示例值:

55:01

user_type

string

用户类型。

可选

示例值:

Licensed

host

string

用户显示名称。

可选

示例值:

user@example.com

integer <int64>

可选

“** long **” 格式的网络研讨会ID (在JSON中表示为int64数据类型)，也称为网络研讨会编号。

示例值:

99264817135

has_3rd_party_audio

boolean

可选

使用TSP进行网络研讨会。

示例值:

true

string

用户电子邮件。

可选

示例值:

user@example.com

participants

integer

可选

网络研讨会参与者计数。

示例值:

has_archiving

boolean

可选

网络研讨会中是否使用了存档功能。

示例值:

true

has_pstn

boolean

可选

指示网络研讨会是否使用了PSTN。

示例值:

true

video_quality

enum<string>

可选

网络研讨会的视频质量分数:

'好'-视频几乎完美无瑕，质量非常好。

'公平'-视频清晰度很高，偶尔会卡住，快或慢，或其他问题，但频率很低，视频质量很好。

'poor'-视频清晰度不高，但不存在很多问题。视频质量一般。

“坏”-图片非常模糊，经常被卡住。

枚举值:

goodfairpoorbad

示例值:

good

end_time

string <date-time>

可选

网络研讨会结束时间。

示例值:

2022-01-13T07:00:46Z

dept

string

部门的主机。

可选

示例值:

Developers

has_manual_captions

boolean

可选

指示会议中是否启用了手动标题。

示例值:

true

has_screen_share

boolean

可选

指示网络研讨会是否使用了屏幕共享。

示例值:

true

start_time

string <date-time>

可选

网络研讨会开始时间。

示例值:

2022-01-13T05:27:11Z

topic

string

网络研讨会主题。

可选

示例值:

my webinar

has_sip

boolean

可选

指示网络研讨会是否使用了SIP。

示例值:

true

screen_share_quality

enum<string>

可选

网络研讨会的屏幕共享质量分数:

'好'-视频几乎完美无瑕，质量非常好。

'公平'-视频清晰度很高，偶尔会卡住，快或慢，或其他问题，但频率很低，视频质量很好。

'poor'-视频清晰度不高，但不存在很多问题。视频质量一般。

“坏”-图片非常模糊，经常被卡住。

枚举值:

goodfairpoorbad

示例值:

good

示例

{
    "has_automated_captions": true,
    "audio_quality": "good",
    "has_voip": true,
    "custom_keys": [
        {
            "value": "value1",
            "key": "key1"
        }
    ],
    "has_recording": true,
    "uuid": "NknQtFSgSUSEYt2a9gc13A==",
    "has_video": true,
    "duration": "55:01",
    "user_type": "Licensed",
    "host": "user@example.com",
    "id": 99264817135,
    "has_3rd_party_audio": true,
    "email": "user@example.com",
    "participants": 1,
    "has_archiving": true,
    "has_pstn": true,
    "video_quality": "good",
    "end_time": "2022-01-13T07:00:46Z",
    "dept": "Developers",
    "has_manual_captions": true,
    "has_screen_share": true,
    "start_time": "2022-01-13T05:27:11Z",
    "topic": "my webinar",
    "has_sip": true,
    "screen_share_quality": "good"
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误码: ** '12702' 一年前无法访问网络研讨会。

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '3001' 网络研讨会尚未结束或网络研讨会ID无效。 此网络研讨会的详细信息不可用。

获取网络研讨会详细信息

请求参数

示例代码

返回响应