List webinars

GET

/users/{userId}/webinars

Zoom users with a Webinar Plan have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to list all the webinars that are scheduled by or on-behalf a user (Webinar host).

Scopes: webinar:read:admin webinar:read

Rate Limit Label: Medium
Prerequisites:

Pro or higher plan with a Webinar Add-on.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/users//webinars'

响应示例

200 - response

{
  "page_count": "1",
  "page_number": "1",
  "page_size": "30",
  "total_records": "1",
  "webinars": [
    {
      "uuid": "dsghfkhaewfds",
      "id": 0001000,
      "host_id": "24654130000000",
      "topic": "My Webinar",
      "agenda": "Learn more about Zoom APIs",
      "type": "5",
      "duration": "60",
      "start_time": "2019-09-24T22:00:00Z",
      "timezone": "America/Los_Angeles",
      "created_at": "2019-08-30T22:00:00Z",
      "join_url": "https://zoom.us/0001000/awesomewebinar"
    }
  ]
}

请求参数

Path 参数

userId

string

必需

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

Query 参数

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

page_number

integer

可选

Deprecated - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field.

The page number of the current page in the returned records.

默认值:

返回响应

🟢200**HTTP Status Code:** `200`<br> List of webinar objects returned.

application/json

Body

List of webinars.

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

page_count

integer

可选

The number of pages returned for the request made.

page_number

integer

可选

Deprecated: This field has been deprecated. Please use the "next_page_token" field for pagination instead of this field.

The page number of the current results.

默认值:

page_size

integer

可选

The number of records returned with a single API call.

<= 300

默认值:

total_records

integer

可选

The total number of all the records available across pages.

webinars

array [object {11}]

可选

List of webinar objects.

agenda

string

可选

Webinar Description. The length of agenda gets truncated to 250 characters when you list all webinars for a user. To view the complete agenda, retrieve details for a single webinar here.

created_at

string <date-time>

可选

Time of webinar creation.

duration

integer

可选

Meeting duration.

host_id

string

可选

ID of the host of the webinar.

integer <int64>

可选

Webinar ID in "long" format(represented as int64 data type in JSON), also known as the webinar number.

join_url

string

可选

Join URL of the webinar (using which others can join the webinar).

start_time

string <date-time>

可选

Scheduled start time of the Webinar.

timezone

string

可选

Timezone ID for the Webinar.

topic

string

可选

Meeting topic.

type

string

可选

Webinar Types:
5 - Webinar.
6 - Recurring webinar with no fixed time.
9 - Recurring webinar with a fixed time.

uuid

string

可选

Unique identifier of a Webinar. Each webinar instance will generate its own UUID. Once a Webinar ends, the value of uuid for the same webinar will be different from when it was scheduled.

🟠404**HTTP Status Code:** `404` **Not Found**<br><br> **Error Code:** `1001`<br> User {userId} not exist or not belong to this account.

修改于 2024-04-24 09:06:48

List webinar templates

Create a webinar