Skip to content

Latest commit

 

History

History
46 lines (43 loc) · 10.3 KB

DashboardMeetingParticipants200ResponseAllOfParticipantsInner.md

File metadata and controls

46 lines (43 loc) · 10.3 KB

# DashboardMeetingParticipants200ResponseAllOfParticipantsInner

Properties

Name Type Description Notes
audio_quality string The participant's audio quality score. The API only returns this value when the Meeting quality scores and network alerts on Dashboard setting is enabled in the Zoom Web Portal and the Show meeting quality score and network alerts on Dashboard option is selected in Account Settings: * `good` — The audio is almost flawless and the quality is excellent. * `fair` — The audio occasionally has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. * `poor` — The audio often has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. * `bad` — The sound quality is extremely poor and the audio content is almost inaudible. [optional]
camera string The type of camera that the participant used during the meeting. Note: This response returns an empty string (`““`) value for any users who are not a part of the host's account (external users). [optional]
connection_type string The participant's connection type. [optional]
customer_key string The participant's SDK identifier. This value can be alphanumeric, up to a maximum length of 15 characters. [optional]
data_center string The data center where participant's meeting data is stored. [optional]
device string The type of device the participant used to join the meeting: * `Phone` — The participant joined via PSTN. * `H.323/SIP` — The participant joined via an H.323 or SIP device. * `Windows` — The participant joined via VoIP using a Windows device. * `Mac` — The participant joined via VoIP using a Mac device. * `iOS` — The participant joined via VoIP using an iOS device. * `Android` — The participant joined via VoIP using an Android device. Note: This response returns an empty string (`““`) value for any users who are not a part of the host's account (external users). [optional]
domain string The participant's PC domain. Note: This response returns an empty string (`““`) value for any users who are not a part of the host's account (external users). [optional]
email string The participant's email address. If the participant is not part of the host's account, this returns an empty string value, with some exceptions. See Email address display rules for details. [optional]
from_sip_uri string The meeting participant's SIP From header URI. The API only returns this response when the participant joins a meeting via SIP. [optional]
full_data_center string The data center where participant's meeting data is stored. This field includes a semicolon-separated list of HTTP Tunnel (HT), Cloud Room Connector (CRC), and Real-Time Web Gateway (RWG) location information. [optional]
harddisk_id string The participant's hard disk ID. Note: This response returns an empty string (`““`) value for any users who are not a part of the host's account (external users). [optional]
id string The participant's universally unique ID. This value is the same as the participant's user ID if the participant joins the meeting by logging into Zoom. If the participant joins the meeting without logging into Zoom, this returns an empty value. [optional]
in_room_participants int The number of participants that joined via Zoom Room. [optional]
ip_address string The participant's IP address. [optional]
join_time \DateTime The time at which participant joined the meeting. [optional]
leave_reason string The reason why the participant left the meeting, where `$name` is the participant's username: * `$name left the meeting.` * `$name got disconnected from the meeting.` * `Host ended the meeting.` * `Host closed the meeting.` * `Host started a new meeting.` * `Network connection error.` * `Host did not join.` * `Exceeded free meeting minutes limit.` * `Removed by host.` * `Unknown reason.` * `Leave waiting room.` * `Removed by host from waiting room.` [optional]
leave_time \DateTime The time at which a participant left the meeting. For live meetings, this field will only return if a participant has left the ongoing meeting. [optional]
location string The participant's location. [optional]
mac_addr string The participant's MAC address. Note: This response returns an empty string (`““`) value for any users who are not a part of the host's account (external users). [optional]
microphone string The type of microphone that the participant used during the meeting. Note: This response returns an empty string (`““`) value for any users who are not a part of the host's account (external users). [optional]
network_type string The participant's network type: * `Wired` * `Wifi` * `PPP` — Point-to-Point. * `Cellular` — 3G, 4G, and 5G cellular. * `Others` — An unknown device. [optional]
participant_user_id string The participant's universally unique ID (UUID): * If the participant joins the meeting by logging into Zoom, this value is the `id` value in the Get a user API response. * If the participant joins the meeting without logging into Zoom, this returns an empty string value. [optional]
pc_name string The participant's PC name. [optional]
recording bool Whether the recording feature was used during the meeting. [optional]
registrant_id string The participant's unique registrant ID. This field only returns if you pass the `registrant_id` value for the `include_fields` query parameter. This field does not return if the `type` query parameter is the `live` value. [optional]
role string The participant's role: * `host` — Host. * `attendee` — Attendee. [optional]
screen_share_quality string The participant's screen share quality score. The API only returns this value when the Meeting quality scores and network alerts on Dashboard setting is enabled in the Zoom Web Portal and the Show meeting quality score and network alerts on Dashboard option is selected in Account Settings: * `good` — The video is almost flawless and the quality is excellent. * `fair` — The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. * `poor` — The video definition is not high, but not many problems exist. The video quality is mediocre. * `bad` — The picture is very blurred and often gets stuck. [optional]
share_application bool Whether the participant chose to share an iPhone/iPad app during the screenshare. [optional]
share_desktop bool Whether the participant chose to share their desktop during the screenshare. [optional]
share_whiteboard bool Whether the participant chose to share their whiteboard during the screenshare. [optional]
sip_uri string The meeting participant's SIP (Session Initiation Protocol) Contact header URI. The API only returns this response when the participant joins a meeting via SIP. [optional]
speaker string The type of speaker that the participant used during the meeting. Note: This response returns an empty string (`““`) value for any users who are not a part of the host's account (external users). [optional]
status string The participant's status: * `in_meeting` — In a meeting. * `in_waiting_room` — In a waiting room. [optional]
user_id string The participant's ID. This value assigned to a participant upon joining a meeting and is only valid for the meeting's duration. [optional]
user_name string The participant's display name. [optional]
version string The participant's Zoom client version. [optional]
video_quality string The participant's video quality score. The API only returns this value when the Meeting quality scores and network alerts on Dashboard setting is enabled in the Zoom Web Portal and the Show meeting quality score and network alerts on Dashboard option is selected in Account Settings: * `good` — The video is almost flawless and the quality is excellent. * `fair` — The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. * `poor` — The video definition is not high, but not many problems exist. The video quality is mediocre. * `bad` — The picture is very blurred and often gets stuck. [optional]
bo_mtg_id string The breakout room ID. Each breakout room is assigned a unique ID. [optional]

[Back to Model list] [Back to API list] [Back to README]