List meeting participants

GET

/metrics/meetings/{meetingId}/participants

Get a list of participants from live or past meetings.

If you do not provide the type query parameter, the default value will be set to live and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for type.
You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.

Scopes: dashboard_meetings:read:admin
Rate Limit Label: Heavy
Prerequisites: Business or a higher plan.

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

200 - response

{
    "next_page_token": "",
    "page_count": 1,
    "page_size": 30,
    "participants": [
        {
            "camera": "FaceTime HD Camera",
            "connection_type": "P2P",
            "data_center": "SC",
            "device": "WIN",
            "domain": "Dojo-workspace",
            "harddisk_id": "sed proident in",
            "id": "d52f19c548b88490b5d16fcbd38",
            "ip_address": "127.0.0.1",
            "join_time": "2019-09-07T13:15:02.837Z",
            "leave_reason": "Dojo left the meeting.<br>Reason: Host ended the meeting.",
            "leave_time": "2019-09-07T13:15:09.837Z",
            "location": "New York",
            "mac_addr": " 00:0a:95:9d:68:16",
            "microphone": "Plantronics BT600",
            "network_type": "Wired",
            "pc_name": "dojo's pc",
            "recording": false,
            "share_application": false,
            "share_desktop": true,
            "share_whiteboard": true,
            "speaker": "Plantronics BT600",
            "status": "in_waiting_room",
            "user_id": "32dsfsd4g5gd",
            "user_name": "dojo",
            "version": "4.4.55383.0716"
        },
        {
            "connection_type": "UDP",
            "data_center": "SC",
            "device": "Android",
            "domain": "Rea-workspace",
            "harddisk_id": "",
            "id": "z8aaaaaaCfp8uQ",
            "ip_address": "120.000.000",
            "join_time": "2019-08-02T15:31:48Z",
            "leave_reason": "Rea left the meeting.<br>Reason: Host closed the meeting.",
            "leave_time": "2019-08-02T16:04:12Z",
            "location": "San Jose (US)",
            "mac_addr": "",
            "network_type": "Wifi",
            "pc_name": "Rea's PC",
            "recording": false,
            "share_application": false,
            "share_desktop": false,
            "share_whiteboard": false,
            "user_id": "1670000000",
            "user_name": "Rea",
            "version": "4.4.55383.0716"
        }
    ],
    "total_records": 2
}

请求参数

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 参数

type

enum<string>

可选

The meeting types:
past - Past meetings.
pastOne - Past one user meetings.
live - Live meetings.

枚举值:

pastpastOnelive

默认值:

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 meeting registrant. This is not supported for live meeting types.

枚举值:

registrant_id

返回响应

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

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

可选

Array of participant session objects. If a participant left a meeting and rejoined the same meeting, their information will appear multiple times (as many times as they joined the meeting).

audio_quality

enum<string>

可选

Audio quality of the participant.

枚举值:

goodfairpoorbad

camera

string

可选

The type of camera used by participant during the meeting.

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

可选

Data Center where participant's meeting data is stored.

device

string

可选

The type of device using which the participant joined the meeting. 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's PC domain.

string <email>

可选

Email address of the participant.

harddisk_id

string

可选

Participant's 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.

in_room_participants

integer

可选

The number of participants who joined via Zoom Room.

ip_address

string

可选

Participant's IP address.

join_time

string <date-time>

可选

The time at which participant joined the meeting.

leave_reason

string

可选

Possible reasons for why participant left the meeting.

leave_time

string <date-time>

可选

The time at which a participant left the meeting. For live meetings, this field will only be returned if a participant has left the ongoing meeting.

location

string

可选

Participant's location.

mac_addr

string

可选

Participant's MAC address.

microphone

string

可选

The type of Microphone that participant used during the meeting.

network_type

enum<string>

可选

Participant's network type.

枚举值:

WiredWifiPPPCellular (3G and 4G)Others

pc_name

string

可选

Name of Participant's PC.

recording

boolean

可选

Indicates whether or not recording was used during the meeting.

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. This is not supported for live meeting types.

screen_share_quality

enum<string>

可选

Screen share quality of the participant.

枚举值:

goodfairpoorbad

share_application

boolean

可选

Indicates whether or not a user selected to share an iPhone/iPad app during the screenshare.

share_desktop

boolean

可选

Indicates whether or not a user selected to share their desktop during the screenshare.

share_whiteboard

boolean

可选

Indicates whether or not a user selected to share their whiteboard during the screenshare.

speaker

string

可选

The type of speaker participant used during the meeting.

status

enum<string>

可选

Indicates whether the participant is in the waiting room or in the meeting.

The value of this field can be in_meeting or in_waiting_room.

枚举值:

in_meetingin_waiting_room

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's Zoom Client version.

video_quality

enum<string>

可选

Video quality of the participant.

枚举值:

goodfairpoorbad

🔵300**Error Code:** `300` Can not access webinar info. {meetingId} or the next page token is either invalid or expired.

🟠404**HTTP Status Code:** `404` **Error Code:** `3001` Meeting ID is invalid or has not ended.

修改于 2024-04-24 09:06:48

Get meeting details

List meeting participants QoS