列出网络研讨会

列出由或代表网络研讨会主持人安排的所有网络研讨会。对于用户级应用，传递 ['me' 值](https://developers.zoom.us/docs/api/rest/using-zoom-api/# the-me-关键字) 而不是 'userId' 参数。

Zoom拥有网络研讨会计划的用户可以创建和管理网络研讨会。网络研讨会让主持人向多达10，000名与会者广播Zoom会议。

** 注意 ** 此API仅返回用户的 [未过期的网络研讨会](https://support.zoom.us/hc/en-us/articles/201362373-Meeting-ID # h_c73f9b08-c1c0-4a1a-b538-e01ebb98e844)。

** 先决条件 **

一个专业或更高的计划与网络研讨会附加。

** 范围: ** 'webinar:master'

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

请求参数

Path 参数

userId

string

必需

用户的用户ID或电子邮件地址。对于用户级应用，传递 “我” 值。

accountId

string

帐户的唯一标识符。

必需

Query 参数

type

string

可选

网络研讨会的类型。

'scheduled'-所有有效的以前 (未过期) 网络研讨会，实时网络研讨会和即将举行的预定网络研讨会。

'upcoming'-所有即将举行的网络研讨会，包括现场网络研讨会。

page_size

integer

可选

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

page_number

integer

可选

** 已弃用 ** 在将来的版本中，我们将不再支持此字段。相反，使用 'next_page_token' 进行分页。

返回响应

🟢200** HTTP状态代码: ** '200' 返回的网络研讨会对象列表。

application/json

Body

网络研讨会列表。

page_number

integer

已废弃

** 已弃用 ** 在将来的版本中，我们将不再支持此字段。相反，使用 'next_page_token' 进行分页。

默认值:

示例值:

next_page_token

string

可选

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

示例值:

w7587w4eiyfsudgf

total_records

integer

可选

跨页可用的所有记录的总数。

示例值:

page_count

integer

可选

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

示例值:

webinars

array [object {12}]

可选

网络研讨会对象列表。

duration

integer

可选

网络研讨会的持续时间，以分钟为单位。

示例值:

start_time

string <date-time>

可选

网络研讨会的开始时间。

示例值:

2021-07-13T21:00:00Z

join_url

string

可选

加入网络研讨会的URL。

示例值:

https://example.com/j/11111

timezone

string

可选

网络研讨会的 [时区](https://developers.zoom.us/docs/api/rest/其他-参考/缩写-列表/# 时区)。

示例值:

America/Los_Angeles

is_simulive

boolean

可选

网络研讨会是否是 “simulive'”。

示例值:

true

created_at

string <date-time>

可选

网络研讨会的创建时间。

示例值:

2021-07-01T22:00:00Z

topic

string

网络研讨会的主题。

可选

示例值:

My Webinar

integer <int64>

网络研讨会ID。

可选

示例值:

1234567890

type

enum<integer>

可选

网络研讨会类型。

'5'-网络研讨会。

'6'-没有固定时间的定期网络研讨会。

'9'-固定时间的定期网络研讨会。

枚举值:

569

默认值:

示例值:

agenda

string

可选

网络研讨会说明。当您列出用户的所有网络研讨会时，议程长度被截断为250个字符。要查看完整的议程，检索单个网络研讨会的详细信息，请使用 [** 获取网络研讨会 **](/docs/api-reference/zoom-api/methos # operation/webinar) API。

示例值:

Learn more about Zoom APIs

uuid

string

可选

网络研讨会的通用唯一标识符 (UUID)。每个网络研讨会实例都会生成一个网络研讨会UUID。

示例值:

4444AAAiAAAAAiAiAiiAii==

host_id

string

主机的ID。

可选

示例值:

x1yCzABCDEfg23HiJKl4mN

page_size

integer

可选

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

<= 300

默认值:

示例值:

示例

{
    "page_number": 1,
    "next_page_token": "w7587w4eiyfsudgf",
    "total_records": 20,
    "page_count": 1,
    "webinars": [
        {
            "duration": 60,
            "start_time": "2021-07-13T21:00:00Z",
            "join_url": "https://example.com/j/11111",
            "timezone": "America/Los_Angeles",
            "is_simulive": true,
            "created_at": "2021-07-01T22:00:00Z",
            "topic": "My Webinar",
            "id": 1234567890,
            "type": 5,
            "agenda": "Learn more about Zoom APIs",
            "uuid": "4444AAAiAAAAAiAiAiiAii==",
            "host_id": "x1yCzABCDEfg23HiJKl4mN"
        }
    ],
    "page_size": 30
}

🟠404** HTTP状态代码: ** '404' <br> 未找到 ** 错误代码: ** '1001' <br> 用户 {userId} 不存在或不属于此帐户。<br>

请求参数

示例代码

返回响应