List webinars - Zoom API

List all the live or past webinars from a specified period of time.

Scopes: dashboard_webinars:read:admin
Rate Limit Label: Resource-intensive
Prerequisites:

Business, Education or API Plan with Webinar add-on.

{ "from": "string [date]", "next_page_token": "string", "page_count": "integer", "page_size": "integer", "to": "string [date]", "total_records": "integer", "webinars": [ { "duration": "string", "email": "string", "end_time": "string [date-time]", "has_3rd_party_audio": "boolean", "has_pstn": "boolean", "has_recording": "boolean", "has_screen_share": "boolean", "has_sip": "boolean", "has_video": "boolean", "has_voip": "boolean", "host": "string", "id": "integer", "participants": "integer", "start_time": "string [date-time]", "topic": "string", "user_type": "string", "uuid": "string [uuid]" } ] }

请求参数

Query 参数

type

enum<string>

可选

The webinar type.

枚举值:

pastlive

默认值:

live

from

string <date>

必需

Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

string <date>

End date.

必需

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

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.

返回响应

🟢200**HTTP Status Code:** `200`<br> Meetings returned.<br> Only available for paid accounts that have enabled the Dashboard feature.

application/json

Body

Pagination object.

from

string <date>

可选

Start date for this report in 'yyyy-mm-dd' format.

string <date>

可选

End date for this report in 'yyyy-mm-dd' format.

next_page_token

string

可选

page_count

integer

可选

The number of pages returned for the request made.

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

total_records

integer

可选

The number of all records available across pages.

webinars

array[object (Webinar Metrics) {19}]

可选

Array of webinar objects.

custom_keys

array [object {2}]

可选

Custom keys and values assigned to the Webinar.

<= 10 items

dept

string

可选

Department of the host.

duration

string

可选

Webinar duration, formatted as hh:mm:ss, for example: 10:00 for ten minutes.

string

可选

User email.

end_time

string <date-time>

可选

Webinar end time.

has_3rd_party_audio

boolean

可选

Indicates whether or not TSP was used for the Webinar.

has_pstn

boolean

可选

Indicates whether or not PSTN was used for the Webinar.

has_recording

boolean

可选

Indicates whether or not recording was used for the Webinar.

has_screen_share

boolean

可选

Indicates whether or not screen sharing was used for the Webinar.

has_sip

boolean

可选

Indicates whether or not SIP was used for the Webinar.

has_video

boolean

可选

Indicates whether or not video was used for the Webinar.

has_voip

boolean

可选

Indicates whether or not VoIP was used for the Webinar.

host

string

可选

User display name.

integer <int64>

可选

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

participants

integer

可选

Webinar participant count.

start_time

string <date-time>

可选

Webinar start time.

topic

string

可选

Webinar topic.

user_type

string

可选

User type.

uuid

string <uuid>

可选

Webinar UUID.

🔵300**Error Code:** `200`<br> The next page token is invalid or has expired.