列出网络研讨会

列出指定时间段内的所有实时或过去的网络研讨会。

** 先决条件: **

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

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

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

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Query 参数

type

string

可选

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

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

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

此值默认为 “live”。

from

string

必需

以 'yyyy-mm-d' 格式的开始日期。“从” 和 “到” 参数定义的日期范围应该只有一个月，因为报告一次只包括一个月的数据。

string

结束日期。

必需

page_size

integer

可选

单个API调用中返回的记录数。

next_page_token

string

可选

使用next page标记对大型结果集进行分页。只要可用结果集超过当前页面大小时，就会返回下一页令牌。此令牌的有效期为15分钟。

group_id

string

可选

组ID。要获取组ID，请使用 ** 列出组 ** api。

** 注意: ** API响应仅包含主机是查询的group ID的成员的会议。

返回响应

🟢200** HTTP状态代码: ** '200' 会议回来了。仅适用于已启用仪表板功能的付费帐户。

application/json

Body

分页对象。

next_page_token

string

可选

下一页标记用于通过大型结果集进行分页。每当可用结果集超过当前页面大小时，将返回下一页令牌。此令牌的有效期为15分钟。

示例值:

Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3

total_records

integer

可选

跨页可用的所有记录数。

示例值:

from

string <date>

可选

此报告的开始日期，格式为 'yyyy-mm-dd-'。

示例值:

2022-01-01

string <date>

可选

此报告的结束日期，格式为 'yyyy-mm-dd-'。

示例值:

2022-01-30

page_count

integer

可选

为发出的请求返回的页数。

示例值:

webinars

array[object (网络研讨会指标) {25}]

可选

网络研讨会对象数组。

has_automated_captions

boolean

可选

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

示例值:

true

audio_quality

enum<string>

可选

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

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

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

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

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

枚举值:

goodfairpoorbad

示例值:

good

has_voip

boolean

可选

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

示例值:

true

custom_keys

array [object {2}]

可选

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

<= 10 items

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

page_size

integer

可选

单个API调用中返回的记录数。

<= 300

默认值:

示例值:

示例

{
    "next_page_token": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
    "total_records": 1,
    "from": "2022-01-01",
    "to": "2022-01-30",
    "page_count": 1,
    "webinars": [
        {
            "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"
        }
    ],
    "page_size": 30
}

请求参数

示例代码

返回响应