Get meeting participant reports

Get participant report for a past meeting.

Scopes: report:read:admin

Rate Limit Label: Heavy
Prerequisites:

Pro or a higher plan.

{ "next_page_token": "", "page_count": "1", "page_size": "30", "participants": [ { "duration": "20:00", "id": "dskfjladjskfl", "join_time": "2019-02-01T12:34:12.660Z", "leave_time": "2019-03-01T12:34:12.660Z", "name": "Riya", "user_email": "riya@jdfghsdfgsd.fdjfhdf", "user_id": "sdfjkldsfdfgdfg" } ], "total_records": "1" }

请求参数

Path 参数

meetingId

string

必需

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

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

Query 参数

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 meeting registrant.

枚举值:

registrant_id

返回响应

🟢200**HTTP Status Code:** `200` Meeting participants report returned. This is only available for paid account.

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 {10}]

可选

Array of meeting participant objects.

customer_key

string

可选

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

<= 15 字符

duration

integer

可选

Participant duration.

failover

boolean

可选

Indicates if failover happened during the meeting.

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..

join_time

string <date-time>

可选

Participant join time.

leave_time

string <date-time>

可选

Participant leave time.

name

string

可选

Participant display name.

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.

user_email

string

可选

Participant email.

user_id

string

可选

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

🔵300**HTTP Status Code:** `300` Cannot access meeting information:{meetingId}. The next page token is either invalid or has expired.

🟠400**HTTP Status Code:** `400` Bad request **Error Code:** `1010` User does not belong to this account:{accountId}.

🟠404**HTTP Status Code:** `404` Meeting ID not found. **Error Code:** `3001` Meeting {MeetingId} not found or has expired.