Get sharing/recording details

Retrieve the sharing and recording details of participants from live or past webinars.

Scopes: dashboard_webinars:read:admin
Rate Limit Label: Heavy
Prerequisites:

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

{ "next_page_token": "string", "page_count": "integer", "page_size": "integer", "participants": [ { "details": [ { "content": "string", "end_time": "string", "start_time": "string" } ], "id": "string", "user_id": "string", "user_name": "string" } ], "total_records": "integer" }

请求参数

Path 参数

webinarId

string

必需

The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance.

If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

Query 参数

type

enum<string>

可选

The webinar type.

枚举值:

pastlive

默认值:

live

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 exceed the current page size. The expiration period for this token is 15 minutes.

返回响应

🟢200**HTTP Status Code:** `200` Webinar participants returned. Only available for paid accounts that have enabled the Dashboard feature.

application/json

Body

Pagination object.

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_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

total_records

integer

可选

The number of all records available across pages.

participants

array [object {4}]

可选

Array of participants.

details

array [object {3}]

可选

Array of sharing and recording details.

string

可选

Universally unique identifier of the Participant. It is the same as the User ID of the participant if the participant joins the meeting by logging into Zoom. If the participant joins the meeting without logging in, the value of this field will be blank.

user_id

string

可选

Participant ID. This is a unique ID assigned to the participant joining a meeting and is valid for that meeting only.

user_name

string

可选

Participant display name.

🔵300**Error Code:** `300` Can not access webinar info, {webinarId}.

🟠404**HTTP Status Code:** `404` **Error Code:** `3001` This webinar's detail info is not available or ID is not valid. This webinar has not ended yet.