List webinar participant QoS

Retrieve a list of participants from live or past webinars and the quality of service they received.
This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.
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 [int64]", "page_size": "integer", "participants": [ { "device": "string", "domain": "string", "harddisk_id": "string", "ip_address": "string", "join_time": "string [date-time]", "leave_time": "string [date-time]", "location": "string", "mac_addr": "string", "pc_name": "string", "user_id": "string [uuid]", "user_name": "string", "user_qos": [ { "as_input": { "avg_loss": "string", "bitrate": "string", "frame_rate": "string", "jitter": "string", "latency": "string", "max_loss": "string", "resolution": "string" }, "as_output": { "avg_loss": "string", "bitrate": "string", "frame_rate": "string", "jitter": "string", "latency": "string", "max_loss": "string", "resolution": "string" }, "audio_input": { "avg_loss": "string", "bitrate": "string", "jitter": "string", "latency": "string", "max_loss": "string" }, "audio_output": { "avg_loss": "string", "bitrate": "string", "jitter": "string", "latency": "string", "max_loss": "string" }, "cpu_usage": { "system_max_cpu_usage": "string", "zoom_avg_cpu_usage": "string", "zoom_max_cpu_usage": "string", "zoom_min_cpu_usage": "string" }, "date_time": "string [date-time]", "video_input": { "avg_loss": "string", "bitrate": "string", "frame_rate": "string", "jitter": "string", "latency": "string", "max_loss": "string", "resolution": "string" }, "video_output": { "avg_loss": "string", "bitrate": "string", "frame_rate": "string", "jitter": "string", "latency": "string", "max_loss": "string", "resolution": "string" } } ], "version": "string" } ], "total_records": "integer [int64]" }

请求参数

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 items returned per page.

<= 10

默认值:

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` Webinar participants returned. Only available for paid accounts that have enabled the Dashboard feature.

application/json

Body

Participant QOS list.

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.

page_count

integer <int64>

可选

The number of pages returned for the request made.

page_size

integer

可选

The number of items per page.

<= 10

默认值:

total_records

integer <int64>

可选

The number of all records available across pages.

participants

array[object (Participant QOS) {13}]

可选

Array of user objects.

device

string

可选

The type of device using which the participant joined the meeting.

domain

string

可选

Participant's PC domain.

harddisk_id

string

可选

Participant's hard disk ID.

ip_address

string

可选

Participant's IP address.

join_time

string <date-time>

可选

The time at which participant joined the meeting.

leave_time

string <date-time>

可选

The time at which participant left the meeting.

location

string

可选

Participant's location.

mac_addr

string

可选

Participant's MAC address.

pc_name

string

可选

Participant's PC name.

user_id

string <uuid>

可选

Participant ID.

user_name

string

可选

Participant display name.

user_qos

array [object {14}]

可选

Quality of service provided to the user.

version

string

可选

Participant's Zoom Client version.

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

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