Get webinar participants

GET

/metrics/webinars/{webinarId}/participants

Dashboards

Retrieve details on 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.

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

200 - response

{
  "next_page_token": "string",
  "page_count": "integer",
  "page_size": "integer",
  "participants": [
    {
      "connection_type": "string",
      "data_center": "string",
      "device": "string",
      "domain": "string",
      "harddisk_id": "string",
      "id": "string [uuid]",
      "ip_address": "string",
      "join_time": "string [date-time]",
      "leave_reason": "string",
      "leave_time": "string [date-time]",
      "location": "string",
      "mac_addr": "string",
      "microphone": "string",
      "network_type": "string",
      "pc_name": "string",
      "recording": "boolean",
      "share_application": "boolean",
      "share_desktop": "boolean",
      "share_whiteboard": "boolean",
      "speaker": "string",
      "user_id": "string",
      "user_name": "string",
      "version": "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 exceeds the current page size. The expiration period for this token is 15 minutes.

include_fields

enum<string>

可选

Provide 'registrant_id' as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a webinar registrant.

枚举值:

registrant_id

返回响应

🟢200**HTTP Status Code:** `200`<br> Webinar participants returned.

application/json

Body

Pagination object.

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.

participants

array [object {29}]

可选

Array of user objects.

audio_quality

enum<string>

可选

Audio quality of the participant.

枚举值:

goodfairpoorbad

connection_type

string

可选

Participant connection type.

customer_key

string

可选

Another identifier for the participant. Can be a number or characters, maximum length of 15 characters.

<= 15 字符

data_center

string

可选

Participant data center.

device

string

可选

The type of device using which the participant joined the webinar. The possible values for this field are:

Phone: Participant joined via PSTN.

H.323/SIP: Participant joined via an H.323 or SIP device.

Windows: Participant joined via VoIP using a Windows device.

Mac: Participant joined via VoIP using a Mac device.

iOS: Participant joined via VoIP using an iOS device.

Android: Participant joined via VoIP using an Android device.

domain

string

可选

Participant domain.

string

可选

Email address of the participant.

harddisk_id

string

可选

Participant hard disk ID.

string <uuid>

可选

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.

ip_address

string

可选

Participant IP address.

join_time

string <date-time>

可选

Participant join time.

leave_reason

string

可选

Possible reasons for why a participant left the Webinar.

leave_time

string <date-time>

可选

Participant leave time.

location

string

可选

Participant location.

mac_addr

string

可选

Participant MAC address.

microphone

string

可选

Participant microphone.

network_type

string

可选

Participant network type.

pc_name

string

可选

Participant PC name.

recording

boolean

可选

Participant record?

registrant_id

string

可选

Unique identifier of the registrant. This field is only returned if you entered "registrant_id" as the value of include_fields query parameter.

screen_share_quality

enum<string>

可选

Screen share quality of the participant.

枚举值:

goodfairpoorbad

share_application

boolean

可选

Did the participant share an application?

share_desktop

boolean

可选

Did the participant share their desktop?

share_whiteboard

boolean

可选

Did the participant share their whiteboard?

speaker

string

可选

Participant speaker.

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.

version

string

可选

Participant version.

video_quality

enum<string>

可选

Video quality of the participant.

枚举值:

goodfairpoorbad

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

🟠404**HTTP Status Code:** `404`<br> **Error Code:** `3001`<br> This webinar's detail info is not available or ID is not valid.

Get webinar details

List webinar participant QoS