{"openapi":"3.0.0","info":{"title":"Quality of Service Subscription Webhooks","description":"[Zoom Quality of Service Subscription (QSS)](https://explore.zoom.us/en/qss/) is an add-on product that enables Developers to receive details about the network traffic in near real-time for users, hosts, and participants in their meetings, webinars, and phone calls. This data can be used to proactively troubleshoot and identify issues as quickly as possible. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) to add this feature.\\n\\n **Requirements**\\n\\n In addition to having the QSS product on your account, at least one user on the account must have Developer permissions enabled to be able to create an application that can subscribe to QSS events. This user should create a Zoom app to receive notifications.\\n\\n **Enabling QSS event notifications**\\n\\n On the Feature page for the Marketplace app, enable **Event Subscription** and add the **Event notification endpoint URL** to send the webhooks. Click **Add events** and select **QSS**. Select the QSS events that you’d like to receive.\\n\\n Note that you must subscribe to the QSS summary event to receive data from the QoS summary APIs.","version":"1.0.0"},"paths":{"webinar.participant_data":{"post":{"tags":["real-time"],"summary":"webinar.participant_data","description":"\nThe **Webinar Participant Data** event triggers when participants in a webinar make setting changes.\n\n## Prerequisites\n\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for more information.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Webinar Participant Data** subscription enabled under the **QSS** event.","operationId":"Webinar.participant_dataWebhook","requestBody":{"description":"Webhook payload for the `webinar.participant_data` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.participant_dataEvent"},"examples":{"default":{"summary":"Example webinar.participant_data event","value":{"event":"webinar.participant_data","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","participant":{"participant_id":"123456789036","participant_user_id":"rstuvwxyza789-cde","email":"user@example.com","data":[{"device":"WIN","location":"New York","network_type":"Wired","microphone":"Plantronics BT600","speaker":"Plantronics BT600","camera":"FaceTime HD Camera","data_center":"SC","connection_type":"P2P","pc_name":"My PC","domain":"my-workspace","mac_addr":"00:00:5E:00:53:00","harddisk_id":"Disk01","version":"4.4.55383.0716","signaling_ip_address":"192.0.2.1","signaling_internal_ip_address":"127.0.0.1","signaling_internal_ip_port":"5060","audio_internal_ip_address":"127.0.0.1","audio_internal_ip_port":"5060","video_internal_ip_address":"127.0.0.1","video_internal_ip_port":"5060","as_internal_ip_address":"127.0.0.1","as_internal_ip_port":"5060","destination_ip_domain":"example.com","destination_ip_port":"5000","zoom_thin_client_plugin_version":"6.5.11.26770","rc_reason":"Client crash"}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"phone.call_qos_summary":{"post":{"tags":["real-time"],"summary":"phone.call_qos_summary","description":"\nThe **Phone call's quality of service (QoS) Summary** event triggers when the call ends. Zoom collects the call's quality of service data and sends it in this event.\n\n## Prerequisites\n\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://www.zoom.com/en/contact/contact-sales/) for more information.\n* Enable **Event Subscriptions** for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Phone call's quality of service (QoS) Summary** subscription enabled under the **QSS** event.\n","operationId":"Phone.call_qos_summaryWebhook","requestBody":{"description":"Webhook payload for the `phone.call_qos_summary` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Phone.call_qos_summaryEvent"},"examples":{"default":{"summary":"Example phone.call_qos_summary event","value":{"event":"phone.call_qos_summary","event_ts":1626759486127,"payload":{"account_id":"2TP-coFVSnmyvYZogk8gAg","object":{"call_id":"6971668082545971778","call_start_time":"2021-06-09T05:42:34Z","call_end_time":"2021-06-09T05:43:02Z","call_qos":[{"type":"caller","user_id":"KLN56y2cSzu0pWxUSec4RQ","user_email":"hello.test@gmail.com","qos":[{"date_time":"2021-04-26T05:26:00Z","type":"sending","details":{"bitrate":"6","avg_loss":"0.0","max_loss":"0.0","jitter":"8","network_delay":"23","mos":"4.5","network":"LAN"}},{"date_time":"2021-04-26T05:26:00Z","type":"receiving","details":{"bitrate":"6","avg_loss":"0.0","max_loss":"0.0","jitter":"8","network_delay":"23","mos":"4.5"}}]}]}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_qos":{"post":{"tags":["real-time"],"summary":"meeting.participant_qos","description":"\nWhen participants are in a meeting, the **Meeting Participant QoS** event collects performance data every 6 seconds, aggregates approximately 10 data points into one record every minute, and sends it.\n\n## Prerequisites\n\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for more information.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Participant QoS** subscription enabled under the **QSS** event.","operationId":"Meeting.participant_qosWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_qos` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_qosEvent"},"examples":{"default":{"summary":"Example meeting.participant_qos event","value":{"event":"meeting.participant_qos","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","participant":{"user_id":"1234567890","participant_user_id":"rstuvwxyza789-cde","email":"user@example.com","qos":[{"date_time":"2021-07-13T21:44:51Z","type":"audio_input","details":{"bitrate":"63 kbps","latency":"134 ms","jitter":"6 ms","avg_loss":"0.0%","max_loss":"0.0%","quality":"good","quality_score":"3.65","min_rssi":"-56","avg_rssi":"-50","max_rssi":"-44","rssi_unit":"dBm"}}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.participant_data_summary":{"post":{"tags":["real-time"],"summary":"webinar.participant_data_summary","description":"\nThe **Webinar Participant Data Summary** event triggers when a participant leaves a webinar.\n\n## Prerequisites\n\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for more information.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Webinar Participant Data Summary** subscription enabled under the **QSS** event.","operationId":"Webinar.participant_data_summaryWebhook","requestBody":{"description":"Webhook payload for the `webinar.participant_data_summary` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.participant_data_summaryEvent"},"examples":{"default":{"summary":"Example webinar.participant_data_summary event","value":{"event":"webinar.participant_data_summary","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","participant":{"participant_id":"123456789036","participant_user_id":"rstuvwxyza789-cde","email":"user@example.com","data":[{"device":"WIN","location":"New York","network_type":"Wired","microphone":"Plantronics BT600","speaker":"Plantronics BT600","camera":"FaceTime HD Camera","data_center":"SC","connection_type":"P2P","pc_name":"My PC","domain":"my-workspace","mac_addr":"00:00:5E:00:53:00","harddisk_id":"Disk01","version":"4.4.55383.0716","signaling_ip_address":"192.0.2.1","signaling_internal_ip_address":"127.0.0.1","signaling_internal_ip_port":"5060","audio_internal_ip_address":"127.0.0.1","audio_internal_ip_port":"5060","video_internal_ip_address":"127.0.0.1","video_internal_ip_port":"5060","as_internal_ip_address":"127.0.0.1","as_internal_ip_port":"5060","destination_ip_domain":"example.com","destination_ip_port":"5000","zoom_thin_client_plugin_version":"6.5.11.26770","rc_reason":"Client crash"}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.participant_qos":{"post":{"tags":["real-time"],"summary":"webinar.participant_qos","description":"\nWhen participants are in a webinar, the **Webinar Participant QoS** event collects performance metrics every 6 seconds. Zoom aggregates roughly 10 data into a single record every minute, then sends it to your endpoint.\n\n## Prerequisites\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for details.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build), including:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Webinar Participant QoS** event enabled under the **QSS** event category.\n","operationId":"Webinar.participant_qosWebhook","requestBody":{"description":"Webhook payload for the `webinar.participant_qos` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.participant_qosEvent"},"examples":{"default":{"summary":"Example webinar.participant_qos event","value":{"event":"webinar.participant_qos","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","participant":{"user_id":"1234567890","participant_user_id":"rstuvwxyza789-cde","email":"user@example.com","qos":[{"date_time":"2021-07-13T21:44:51Z","type":"audio_input","details":{"bitrate":"63 kbps","latency":"134 ms","jitter":"6 ms","avg_loss":"0.0%","max_loss":"0.0%","quality":"good","quality_score":"3.65"}}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_qos_summary":{"post":{"tags":["real-time"],"summary":"session.user_qos_summary","description":"\nThe **Session User QoS Summary** event triggers when a user leaves a session. The collected QoS metrics for that user are then sent via this event.\n\n## Prerequisites\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for details.\n* **Event Subscriptions** must be enabled for your Video SDK [Marketplace app](https://marketplace.zoom.us/user/build), including:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Session User QoS Summary** event enabled under the **QSS** event category.\n","operationId":"Session.user_qos_summaryWebhook","requestBody":{"description":"Webhook payload for the `session.user_qos_summary` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_qos_summaryEvent"},"examples":{"default":{"summary":"Example session.user_qos_summary event","value":{"event":"session.user_qos_summary","event_ts":1673353332744,"payload":{"account_id":"AAAAAABBBB","object":{"session_id":"gkBE2XmnRJq42wHoMox/5g==","session_name":"XdafAKX5RXDACJZXv4xR-w","user":{"id":"16778240","name":"example","user_key":"vkgfmFwpQqOftr90XLkeBA","is_original_host":true,"qos":[{"type":"cpu_usage","details":{"zoom_min_cpu_usage":"0%","zoom_avg_cpu_usage":"0%","zoom_max_cpu_usage":"0%","system_max_cpu_usage":"0%"}}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"webinar.participant_qos_summary":{"post":{"tags":["real-time"],"summary":"webinar.participant_qos_summary","description":"\nThe **Webinar Participant QoS Summary** event triggers each time a participant leaves a webinar. The collected QoS metrics for that participant are then sent via this event.\n\n## Prerequisites\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for details.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build), including:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Webinar Participant QoS Summary** event enabled under the **QSS** event category.\n","operationId":"Webinar.participant_qos_summaryWebhook","requestBody":{"description":"Webhook payload for the `webinar.participant_qos_summary` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webinar.participant_qos_summaryEvent"},"examples":{"default":{"summary":"Example webinar.participant_qos_summary event","value":{"event":"webinar.participant_qos_summary","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":"123456ABCDEF","participant":{"participant_id":"string","user_name":"JillChill","id":"iFxeBPYun6SAiWUzBcEkX","email":"user@example.com","qos":[{"type":"audio_output","details":{"min_bitrate":"6 kbps","avg_bitrate":"9 kbps","max_bitrate":"27 kbps","min_latency":"0 ms","avg_latency":"0 ms","max_latency":"0 ms","min_jitter":"0 ms","avg_jitter":"0 ms","max_jitter":"1 ms","min_loss":"0.0%","avg_loss":"0.0%","max_loss":"0.0%"}},{"type":"video_output","details":{"min_bitrate":"200 kbps","avg_bitrate":"391 kbps","max_bitrate":"898 kbps","min_latency":"0 ms","avg_latency":"0 ms","max_latency":"0 ms","min_jitter":"0 ms","avg_jitter":"0 ms","max_jitter":"1 ms","min_loss":"0.0%","avg_loss":"0.0%","max_loss":"0.0%","resolution":"","min_frame_rate":"0 fps","avg_frame_rate":"0 fps","max_frame_rate":"0 fps"}},{"type":"cpu_usage","details":{"zoom_min_cpu_usage":"1%","zoom_avg_cpu_usage":"2%","zoom_max_cpu_usage":"5%","system_max_cpu_usage":"23%"}}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_data":{"post":{"tags":["real-time"],"summary":"meeting.participant_data","description":"\nThe **Meeting Participant Data** event triggers when participants in a meeting make setting changes. For example, when a participant enables their camera, there will be an event notification triggered during the meeting. When you subscribe to this event, you will receive multiple events in one meeting for each participant.\n\n## Prerequisites\n\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for more information.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Participant Data** subscription enabled under the **QSS** event.","operationId":"Meeting.participant_dataWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_data` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_dataEvent"},"examples":{"default":{"summary":"Example meeting.participant_data event","value":{"event":"meeting.participant_data","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","participant":{"participant_id":"1234567890","participant_user_id":"rstuvwxyza789-cde","email":"user@example.com","data":[{"device":"WIN","location":"New York","network_type":"Wired","microphone":"Plantronics BT600","speaker":"Plantronics BT600","camera":"FaceTime HD Camera","data_center":"SC","connection_type":"P2P","pc_name":"My PC","domain":"my-workspace","mac_addr":"00:00:5E:00:53:00","harddisk_id":"Disk01","version":"4.4.55383.0716","signaling_ip_address":"192.0.2.1","signaling_internal_ip_address":"127.0.0.1","signaling_internal_ip_port":"5060","audio_internal_ip_address":"127.0.0.1","audio_internal_ip_port":"5060","video_internal_ip_address":"127.0.0.1","video_internal_ip_port":"5060","as_internal_ip_address":"127.0.0.1","as_internal_ip_port":"5060","destination_ip_domain":"example.com","destination_ip_port":"5000","zoom_thin_client_plugin_version":"6.5.11.26770","rc_reason":"Client crash"}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"phone.call_qos":{"post":{"tags":["real-time"],"summary":"phone.call_qos","description":"\nWhen the call is on-going, the **Phone call's quality of service (QoS)** event collects performance data every 6 seconds, aggregates approximately 10 data points into one record every minute, and sends it.\n\n## Prerequisites\n\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for more information.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Phone call's quality of service (QoS)** subscription enabled under the **QSS** event.","operationId":"Phone.call_qosWebhook","requestBody":{"description":"Webhook payload for the `phone.call_qos` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Phone.call_qosEvent"},"examples":{"default":{"summary":"Example phone.call_qos event","value":{"event":"phone.call_qos","event_ts":1626759486127,"payload":{"account_id":"2TP-coFVSnmyvYZogk8gAg","object":{"call_id":"6971668082545971778","call_start_time":"2021-06-09T05:42:34Z","call_end_time":"2021-06-09T05:43:02Z","call_qos":{"type":"caller","id":"KLN56y2cSzu0pWxUSec4RQ","user_email":"hello.test@gmail.com","qos":{"date_time":"2021-04-26T05:26:00Z","type":"sending","details":{"bitrate":"6","avg_loss":"0.0","max_loss":"0.0","jitter":"8","network_delay":"23","mos":"4.5","network":"LAN"}}}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_data":{"post":{"tags":["real-time"],"summary":"session.user_data","description":"\nThe **Session user Data** event triggers when users in a session make setting changes.\n\n## Prerequisites\n\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for more information.\n* Enable **Event Subscriptions** for your Video SDK [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Session user Data** subscription enabled under the **QSS** event.","operationId":"Session.user_dataWebhook","requestBody":{"description":"Webhook payload for the `session.user_data` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_dataEvent"},"examples":{"default":{"summary":"Example session.user_data event","value":{"event":"session.user_data","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","user":{"id":"25508864","name":"example","user_key":"ASD74dfDI854","is_original_host":true,"data":[{"device":"WIN","location":"New York","network_type":"Wired","microphone":"Plantronics BT600","speaker":"Plantronics BT600","camera":"FaceTime HD Camera","data_center":"SC","connection_type":"P2P","pc_name":"My PC","domain":"my-workspace","mac_addr":"00:00:5E:00:53:00","harddisk_id":"Disk01","version":"4.4.55383.0716","signaling_ip_address":"192.0.2.1","signaling_internal_ip_address":"127.0.0.1","signaling_internal_ip_port":"5060","audio_internal_ip_address":"127.0.0.1","audio_internal_ip_port":"5060","video_internal_ip_address":"127.0.0.1","video_internal_ip_port":"5060","as_internal_ip_address":"127.0.0.1","as_internal_ip_port":"5060","destination_ip_domain":"example.com","destination_ip_port":"5000","rc_reason":"Client crash"}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_data_summary":{"post":{"tags":["real-time"],"summary":"meeting.participant_data_summary","description":"\nZoom triggers the **Meeting Participant Data Summary** event when a participant leaves a meeting.\n\n## Prerequisites\n\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for more information.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Participant Data Summary** subscription enabled under the **QSS** event.","operationId":"Meeting.participant_data_summaryWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_data_summary` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_data_summaryEvent"},"examples":{"default":{"summary":"Example meeting.participant_data_summary event","value":{"event":"meeting.participant_data_summary","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","id":"1234567890","participant":{"participant_id":"1234567890","participant_user_id":"rstuvwxyza789-cde","email":"user@example.com","data":[{"device":"Windows","location":"New York","network_type":"Wired","microphone":"Plantronics BT600","speaker":"Plantronics BT600","camera":"FaceTime HD Camera","data_center":"SC","connection_type":"P2P","pc_name":"My PC","domain":"my-workspace","mac_addr":"00:00:5E:00:53:00","harddisk_id":"Disk01","version":"4.4.55383.0716","signaling_ip_address":"192.0.2.1","signaling_internal_ip_address":"127.0.0.1","signaling_internal_ip_port":"5060","audio_internal_ip_address":"127.0.0.1","audio_internal_ip_port":"5060","video_internal_ip_address":"127.0.0.1","video_internal_ip_port":"5060","as_internal_ip_address":"127.0.0.1","as_internal_ip_port":"5060","destination_ip_domain":"example.com","destination_ip_port":"5000","device_detail":"GoogleChromeSAB 130","client":"Web video sdk 1.12.10","zoom_thin_client_plugin_version":"6.5.11.26770","rc_reason":"Client crash"}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_data_summary":{"post":{"tags":["real-time"],"summary":"session.user_data_summary","description":"\nThe **Session User Data Summary** event triggers when a user leaves a session.\n\n## Prerequisites\n\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for more information.\n* Enable **Event Subscriptions** for your Video SDK [Marketplace app](https://marketplace.zoom.us/user/build) with:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Session User Data Summary** subscription enabled under the **QSS** event.","operationId":"Session.user_data_summaryWebhook","requestBody":{"description":"Webhook payload for the `session.user_data_summary` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_data_summaryEvent"},"examples":{"default":{"summary":"Example session.user_data_summary event","value":{"event":"session.user_data_summary","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","user":{"id":"25508864","name":"example","user_key":"ASD74dfDI854","is_original_host":true,"data":[{"device":"Windows","location":"New York","network_type":"Wired","microphone":"Plantronics BT600","speaker":"Plantronics BT600","camera":"FaceTime HD Camera","data_center":"SC","connection_type":"P2P","pc_name":"My PC","domain":"my-workspace","mac_addr":"00:00:5E:00:53:00","harddisk_id":"Disk01","version":"4.4.55383.0716","signaling_ip_address":"192.0.2.1","signaling_internal_ip_address":"127.0.0.1","signaling_internal_ip_port":"5060","audio_internal_ip_address":"127.0.0.1","audio_internal_ip_port":"5060","video_internal_ip_address":"127.0.0.1","video_internal_ip_port":"5060","as_internal_ip_address":"127.0.0.1","as_internal_ip_port":"5060","destination_ip_domain":"example.com","destination_ip_port":"5000","device_detail":"GoogleChromeSAB 130","client":"Web video sdk 1.12.10","rc_reason":"Client crash"}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"meeting.participant_qos_summary":{"post":{"tags":["real-time"],"summary":"meeting.participant_qos_summary","description":"\nThe **Meeting Participant QoS Summary** event triggers when a participant leaves a meeting. The meeting participants' QoS data is then collected and sent via this event.\n\n## Prerequisites\n\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for more information.\n* **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Meeting Participant QoS Summary** subscription enabled under the **QSS** event.\n\n","operationId":"Meeting.participant_qos_summaryWebhook","requestBody":{"description":"Webhook payload for the `meeting.participant_qos_summary` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.participant_qos_summaryEvent"},"examples":{"default":{"summary":"Example meeting.participant_qos_summary event","value":{"event":"meeting.participant_qos_summary","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"uuid":"4444AAAiAAAAAiAiAiiAii==","participant":{"participant_id":"string","user_name":"JillChill","id":"iFxeBPYun6SAiWUzBcEkX","email":"user@example.com","qos":[{"type":"audio_output","details":{"min_bitrate":"6 kbps","avg_bitrate":"9 kbps","max_bitrate":"27 kbps","min_latency":"0 ms","avg_latency":"0 ms","max_latency":"0 ms","min_jitter":"0 ms","avg_jitter":"0 ms","max_jitter":"1 ms","min_loss":"0.0%","avg_loss":"0.0%","max_loss":"0.0%"}},{"type":"video_output","details":{"min_bitrate":"200 kbps","avg_bitrate":"391 kbps","max_bitrate":"898 kbps","min_latency":"0 ms","avg_latency":"0 ms","max_latency":"0 ms","min_jitter":"0 ms","avg_jitter":"0 ms","max_jitter":"1 ms","min_loss":"0.0%","avg_loss":"0.0%","max_loss":"0.0%","resolution":"","min_frame_rate":"0 fps","avg_frame_rate":"0 fps","max_frame_rate":"0 fps"}},{"type":"cpu_usage","details":{"zoom_min_cpu_usage":"1%","zoom_avg_cpu_usage":"2%","zoom_max_cpu_usage":"5%","system_max_cpu_usage":"23%"}}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}},"session.user_qos":{"post":{"tags":["real-time"],"summary":"session.user_qos","description":"\nWhen users are in a session, the **Session User QoS** event collects performance metrics every 6 seconds. Zoom aggregates roughly 10 data points into a single record every minute and sends that record to your configured endpoint.\n\n## Prerequisites\n* A **Quality of Service Subscription** plan. [Contact Zoom Sales](https://explore.zoom.us/en/contactsales/) for details.\n* **Event Subscriptions** must be enabled for your Video SDK [Marketplace app](https://marketplace.zoom.us/user/build), including:\n  * A valid **Event Notification Endpoint URL**.\n  * The **Session User QoS** subscription enabled under the **QSS** event category.","operationId":"Session.user_qosWebhook","requestBody":{"description":"Webhook payload for the `session.user_qos` event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session.user_qosEvent"},"examples":{"default":{"summary":"Example session.user_qos event","value":{"event":"session.user_qos","event_ts":1626230691572,"payload":{"account_id":"AAAAAABBBB","object":{"session_id":"4567UVWxYZABCdEfGhiJkl==","session_name":"My Session","session_key":"ABC36jaBI145","user":{"id":"1234567890","name":"example","user_key":"ASD74dfDI854","is_original_host":true,"qos":[{"date_time":"2021-07-13T21:44:51Z","type":"audio_input","details":{"bitrate":"63 kbps","latency":"134 ms","jitter":"6 ms","avg_loss":"0.0%","max_loss":"0.0%"}}]}}}}}}}},"required":true},"responses":{"200":{"description":"Successfully received the webhook event."}},"deprecated":false}}},"components":{"schemas":{"Webinar.participant_dataEvent":{"required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"Name of the event."},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long(int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Account ID of the Zoom Room that is experiencing issues."},"object":{"required":["participant","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"Meeting UUID."},"participant":{"required":["data","participant_id"],"type":"object","properties":{"participant_id":{"type":"string","description":"Participant ID."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). Returns an empty value for external users."},"email":{"type":"string","description":"The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. 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](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.","format":"email"},"data":{"type":"array","description":"Array of participant data.","items":{"type":"object","properties":{"device":{"type":"string","description":"The type of device used by the participant to join the webinar. The possible values for this field are:\n* `Phone`: Participant joined via PSTN.\n* `H.323/SIP`: Participant joined via an H.323 or SIP device.\n* `Windows`: Participant joined via VoIP using a Windows device.\n* `Mac`: Participant joined via VoIP using a Mac device.\n* `iOS`: Participant joined via VoIP using an iOS device.\n* `Android`: Participant joined via VoIP using an Android device."},"location":{"type":"string","description":"Participant location."},"network_type":{"type":"string","description":"Participant network type."},"microphone":{"type":"string","description":"Participant microphone."},"speaker":{"type":"string","description":"Participant speaker."},"camera":{"type":"string","description":"The type of camera used by the participant during the meeting."},"data_center":{"type":"string","description":"The data center where the participant's meeting data is stored."},"connection_type":{"type":"string","description":"Participant connection type."},"pc_name":{"type":"string","description":"The name of the participant's PC."},"domain":{"type":"string","description":"The participant's PC domain."},"mac_addr":{"type":"string","description":"The participant's MAC address."},"harddisk_id":{"type":"string","description":"The participant's hard disk ID."},"version":{"type":"string","description":"The participant's Zoom Client version."},"signaling_ip_address":{"type":"string","description":"The participant's signaling IP address for information other than audio, video, or screen sharing."},"signaling_internal_ip_address":{"type":"string","description":"Signaling internal IP address."},"signaling_internal_ip_port":{"type":"string","description":"Signaling internal IP port."},"audio_internal_ip_address":{"type":"string","description":"Audio internal IP address."},"audio_internal_ip_port":{"type":"string","description":"Audio internal IP port."},"video_internal_ip_address":{"type":"string","description":"Video internal IP address."},"video_internal_ip_port":{"type":"string","description":"Video internal IP port."},"as_internal_ip_address":{"type":"string","description":"Sharing internal IP address."},"as_internal_ip_port":{"type":"string","description":"Sharing internal IP port."},"destination_ip_domain":{"type":"string","description":"Destination internal IP domain."},"destination_ip_port":{"type":"string","description":"Destination internal IP port."},"zoom_thin_client_plugin_version":{"type":"string","description":"The VDI thin client version."},"rc_reason":{"type":"string","description":"The call reconnection reason: Client crash."}},"additionalProperties":false,"description":"Participant items."}}},"additionalProperties":false,"description":"Participant object."}},"additionalProperties":false,"description":"Meeting object."}},"additionalProperties":false}},"additionalProperties":false},"Phone.call_qos_summaryEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"Name of the event.","enum":["phone.call_qos_summary"]},"event_ts":{"type":"integer","description":"Timestamp when the event occurred, in milliseconds since epoch. The value of this field is returned in long (int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The owner's account ID."},"object":{"required":["call_end_time","call_id","call_qos","call_start_time"],"type":"object","properties":{"call_id":{"type":"string","description":"The call ID."},"call_start_time":{"type":"string","description":"The date and time when the call started.","format":"date-time"},"call_end_time":{"type":"string","description":"The date and time when the call ended.","format":"date-time"},"call_qos":{"type":"array","description":"The call quality of service (QoS).","items":{"required":["qos","type","user_id"],"type":"object","properties":{"type":{"type":"string","description":"The type: caller or callee."},"user_id":{"type":"string","description":"The caller or callee's user ID."},"user_email":{"type":"string","description":"The caller or callee's email."},"qos":{"type":"array","description":"The quality of service (QoS) data.","items":{"required":["date_time","details","type"],"type":"object","properties":{"date_time":{"type":"string","description":"The date and time when the QoS data was received.","format":"date-time"},"type":{"type":"string","description":"The QoS data type: sending or receiving."},"details":{"required":["avg_loss","bitrate","jitter","max_loss","mos","network_delay"],"type":"object","properties":{"bitrate":{"type":"string","description":"The number of bits per second, in Kbps, that can be transmitted along a digital network."},"avg_loss":{"type":"string","description":"The average percentage of packets that fail to arrive at their destination."},"max_loss":{"type":"string","description":"The maximum percentage of packets that fail to arrive at their destination."},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds."},"network_delay":{"type":"string","description":"The amount of time, in milliseconds, that it takes for a Voice Over IP (VoIP) packet to travel from one point to another."},"mos":{"type":"string","description":"The Mean Opinion Score (MOS). This measures voice quality on a scale of 1 to 5. A score above or equal to 3.5 means good quality, while below 3.5 means poor quality."},"network":{"type":"string","description":"The type of networks such as LAN, WiFi, VPN etc"}},"description":"QoS details."}}}}}}}}}}}}},"Meeting.participant_qosEvent":{"required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"object":{"required":["participant","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"participant":{"required":["qos","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting."},"participant_user_id":{"type":"string","description":"The participant's universally unique identifier (UUID). Returns an empty value for external users."},"email":{"type":"string","description":"The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. 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](/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"qos":{"type":"array","description":"Information about the participant's quality of service (QoS).","items":{"required":["date_time","details","type"],"type":"object","properties":{"date_time":{"type":"string","description":"The timestamp when the QoS data was generated.","format":"date-time"},"type":{"type":"string","description":"The QoS type. See `type` in [List meeting participants QoS Summary](https://developers.zoom.us/docs/api/rest/reference/qss/methods/#operation/dashboardMeetingParticipantsQOSSummary) for a description.","enum":["audio_input","audio_output","video_input","video_output","as_input","as_output","cpu_usage","audio_device_from_crc","audio_device_to_crc","video_device_from_crc","video_device_to_crc","as_device_from_crc","as_device_to_crc","audio_device_from_rwg","audio_device_to_rwg","video_device_from_rwg","video_device_to_rwg","as_device_from_rwg","as_device_to_rwg","audio_quality","video_quality","as_quality","wifi_rssi","notification"]},"details":{"type":"object","properties":{"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in Kbps."},"latency":{"type":"string","description":"The time it takes a packet to travel from one point to another, in milliseconds."},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds."},"avg_loss":{"type":"string","description":"The average amount of packet loss. For example, the percentage of packets that failed to arrive at their destination."},"max_loss":{"type":"string","description":"The maximum amount of packet loss. For example, the maximum percentage of packets that failed to arrive at their destination."},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display."},"frame_rate":{"type":"string","description":"The rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS)."},"zoom_min_cpu_usage":{"type":"string","description":"Zoom's minimum CPU usage."},"zoom_avg_cpu_usage":{"type":"string","description":"Zoom's average CPU usage."},"zoom_max_cpu_usage":{"type":"string","description":"Zoom's maximum CPU usage."},"system_max_cpu_usage":{"type":"string","description":"The system's maximum CPU usage."},"system_min_cpu_pressure_level":{"type":"string","description":"The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_avg_cpu_pressure_level":{"type":"string","description":"The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_max_cpu_pressure_level":{"type":"string","description":"The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"quality":{"type":"string","description":"The meeting quality level.","enum":["bad","fair","good","poor"]},"quality_score":{"type":"string","description":"The meeting quality score."},"max_rssi":{"type":"string","description":"Maximum value of the wireless network's received signal strength indicator (RSSI).","example":"-35"},"avg_rssi":{"type":"string","description":"Average value of the wireless network's received signal strength indicator (RSSI).","example":"-69"},"min_rssi":{"type":"string","description":"Minimum value of the wireless network's received signal strength indicator (RSSI).","example":"-75"},"rssi_unit":{"type":"string","description":"Unit of the wireless network's received signal strength indicator (RSSI).","example":"dBm"},"network_notification":{"type":"string","description":"The client-triggered network instability notification.","enum":["network bandwidth low","internet connection unstable"]}},"additionalProperties":false,"description":"The QoS details object."}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.participant_data_summaryEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"Name of the event.","enum":["webinar.participant_data_summary"]},"event_ts":{"type":"integer","description":"Timestamp (in milliseconds since epoch) at which the event occurred. The value of this field is returned in long (int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The account ID."},"object":{"required":["participant","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The webinar ID."},"participant":{"required":["data","participant_id"],"type":"object","properties":{"participant_id":{"type":"string","description":"The participant ID."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). Returns an empty value for external users."},"email":{"type":"string","description":"The participant's email address. This field only returns a value if the participant joined the meeting by logging into Zoom. 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](https://developers.zoom.us/docs/api/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"data":{"type":"array","items":{"required":["as_internal_ip_address","as_internal_ip_port","audio_internal_ip_address","audio_internal_ip_port","camera","connection_type","data_center","destination_ip_domain","destination_ip_port","device","domain","harddisk_id","location","mac_addr","microphone","network_type","pc_name","signaling_internal_ip_address","signaling_internal_ip_port","signaling_ip_address","speaker","version","video_internal_ip_address","video_internal_ip_port"],"type":"object","properties":{"device":{"type":"string","enum":["Windows","Mac","Phone"]},"location":{"type":"string","description":"The participant's location, formatted as \"city (country code)\", such as \"Sunnyvale (US)\"."},"network_type":{"type":"string","enum":["Wired","Wifi","PPP","3G","Others"]},"microphone":{"type":"string","description":"The microphone, such as \"External Microphone (External Microphone)\"."},"speaker":{"type":"string","description":"The headphones, such as \"External Headphones (External Headphones)\"."},"camera":{"type":"string","description":"The camera, such as \"Integrated Camera\"."},"data_center":{"type":"string","description":"The data center, such as \"SC (Sub)\"."},"connection_type":{"type":"string","description":"The connection type, such as \"UDP\"."},"pc_name":{"type":"string"},"domain":{"type":"string"},"mac_addr":{"type":"string","description":"The MAC address, only available for the Windows client."},"harddisk_id":{"type":"string","description":"The hard disk ID."},"version":{"type":"string"},"signaling_ip_address":{"type":"string","description":"The signaling IP address for information other than audio, video, or screen sharing."},"signaling_internal_ip_address":{"type":"string","description":"The signaling internal IP address."},"signaling_internal_ip_port":{"type":"string","description":"The signaling internal IP port."},"audio_internal_ip_address":{"type":"string","description":"The audio internal IP address."},"audio_internal_ip_port":{"type":"string","description":"The audio internal IP port."},"video_internal_ip_address":{"type":"string","description":"The video internal IP address."},"video_internal_ip_port":{"type":"string","description":"The video internal IP port."},"as_internal_ip_address":{"type":"string","description":"The sharing internal IP address."},"as_internal_ip_port":{"type":"string","description":"The sharing internal IP port."},"destination_ip_domain":{"type":"string","description":"The destination internal IP domain."},"destination_ip_port":{"type":"string","description":"The destination internal IP port."},"zoom_thin_client_plugin_version":{"type":"string","description":"The VDI thin client version."},"rc_reason":{"type":"string","description":"The reason for call reconnection, such as \"Client crash\"."}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"Webinar.participant_qosEvent":{"required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"Timestamp in milliseconds since epoch when the event occurred. The value is returned in long (int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Account ID associated with the event."},"object":{"required":["participant","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID)."},"participant":{"required":["qos","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"The participant's unique identifier."},"participant_user_id":{"type":"string","description":"The participant's universally unique identifier (UUID). Returns an empty value for external users."},"email":{"type":"string","description":"The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. 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](/docs/api/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"qos":{"type":"array","description":"An array of Quality of Service (QoS) data.","items":{"required":["date_time","details","type"],"type":"object","properties":{"date_time":{"type":"string","description":"The timestamp for when the participant left."},"type":{"type":"string","description":"Quality of Service (QoS) type.","enum":["audio_input","audio_output","video_input","video_output","as_input","as_output","cpu_usage","audio_device_from_crc","audio_device_to_crc","video_device_from_crc","video_device_to_crc","as_device_from_crc","as_device_to_crc","audio_device_from_rwg","audio_device_to_rwg","video_device_from_rwg","video_device_to_rwg","as_device_from_rwg","as_device_to_rwg","audio_quality","video_quality","as_quality","wifi_rssi","notification"]},"details":{"type":"object","properties":{"bitrate":{"type":"string","description":"The number of bits per second that can be transmitted along a digital network, in Kbps."},"latency":{"type":"string","description":"The amount of time it takes for a packet to travel from one point to another, in milliseconds."},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds."},"avg_loss":{"type":"string","description":"The average amount of packet loss, displayed as the percentage of packets that failed to arrive at their destination."},"max_loss":{"type":"string","description":"The maximum amount of packet loss, displayed as the maximum percentage of packets that failed to arrive at their destination."},"resolution":{"type":"string","description":"The number of pixels in each dimension that can be displayed by your video camera."},"frame_rate":{"type":"string","description":"The rate at which your video camera can produce unique images, or frames. Zoom supports a frame rate of up to 30 frames per second (FPS)."},"zoom_min_cpu_usage":{"type":"string","description":"Zoom's minimum CPU usage."},"zoom_avg_cpu_usage":{"type":"string","description":"Zoom's average CPU usage."},"zoom_max_cpu_usage":{"type":"string","description":"Zoom's maximum CPU usage."},"system_max_cpu_usage":{"type":"string","description":"System's maximum CPU usage."},"system_min_cpu_pressure_level":{"type":"string","description":"The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_avg_cpu_pressure_level":{"type":"string","description":"The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_max_cpu_pressure_level":{"type":"string","description":"The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"quality":{},"quality_score":{"type":"string","description":"The quality score value."},"max_rssi":{"type":"string","description":"Maximum value of the wireless network's received signal strength indicator (RSSI).","example":"-35"},"avg_rssi":{"type":"string","description":"Average value of the wireless network's received signal strength indicator (RSSI).","example":"-69"},"min_rssi":{"type":"string","description":"Minimum value of the wireless network's received signal strength indicator (RSSI).","example":"-75"},"rssi_unit":{"type":"string","description":"Unit of the wireless network's received signal strength indicator (RSSI).","example":"dBm"},"network_notification":{"type":"string","description":"Client-triggered network instability notification.","enum":["network bandwidth low","internet connection unstable"]}},"additionalProperties":false,"description":"Quality of Service (QoS) details object."}},"additionalProperties":false,"description":"Quality of Service (QoS) items."}}},"additionalProperties":false,"description":"Participant object."}},"additionalProperties":false,"description":"Meeting object."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_qos_summaryEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"type":"object","properties":{"session_id":{"type":"string","description":"The unique session identifier. Each session instance has its own session ID."},"session_name":{"type":"string","description":"The session's name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user":{"required":["id","is_original_host","name","qos"],"type":"object","properties":{"id":{"type":"string","description":"The user's unique ID assigned upon joining the session, valid only for that session."},"name":{"type":"string","description":"The user's username."},"user_key":{"type":"string","description":"An additional identifier for the user. Can be numeric or alphanumeric."},"is_original_host":{"type":"boolean","description":"Whether the current user is the original host of this session."},"qos":{"type":"array","description":"Information about the user's quality of service (QoS).","items":{"required":["details","type"],"type":"object","properties":{"type":{"type":"string","description":"The QoS type.","enum":["audio_input","audio_output","video_input","video_output","as_input","as_output","cpu_usage","audio_device_from_crc","audio_device_to_crc","video_device_from_crc","video_device_to_crc","as_device_from_crc","as_device_to_crc","audio_device_from_rwg","audio_device_to_rwg","video_device_from_rwg","video_device_to_rwg","as_device_from_rwg","as_device_to_rwg","audio_quality","video_quality","as_quality","wifi_rssi"]},"details":{"type":"object","properties":{"min_bitrate":{"type":"string","description":"The minimum bits per second transmitted along a digital network, in Kbps."},"avg_bitrate":{"type":"string","description":"The average bits per second transmitted along a digital network, in Kbps."},"max_bitrate":{"type":"string","description":"The maximum bits per second transmitted along a digital network, in Kbps."},"min_latency":{"type":"string","description":"The minimum time it took a packet to travel from one point to another, in milliseconds."},"avg_latency":{"type":"string","description":"The average time it took a packet to travel from one point to another, in milliseconds."},"max_latency":{"type":"string","description":"The maximum time it took a packet to travel from one point to another, in milliseconds."},"min_jitter":{"type":"string","description":"The minimum variation in the delay of received packets, in milliseconds."},"avg_jitter":{"type":"string","description":"The average variation in the delay of received packets, in milliseconds."},"max_jitter":{"type":"string","description":"The maximum variation in the delay of received packets, in milliseconds."},"min_loss":{"type":"string","description":"The minimum amount of packet loss as a percentage of packets that failed to arrive at their destination."},"avg_loss":{"type":"string","description":"The average amount of packet loss as a percentage of packets that failed to arrive at their destination."},"max_loss":{"type":"string","description":"The maximum amount of packet loss as a percentage of packets that failed to arrive at their destination."},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display."},"min_frame_rate":{"type":"string","description":"The minimum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS)."},"avg_frame_rate":{"type":"string","description":"The average rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS)."},"max_frame_rate":{"type":"string","description":"The maximum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS)."},"zoom_min_cpu_usage":{"type":"string","description":"Zoom's minimum CPU usage."},"zoom_avg_cpu_usage":{"type":"string","description":"Zoom's average CPU usage."},"zoom_max_cpu_usage":{"type":"string","description":"Zoom's maximum CPU usage."},"system_max_cpu_usage":{"type":"string","description":"The system's maximum CPU usage."},"system_min_cpu_pressure_level":{"type":"string","description":"The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_avg_cpu_pressure_level":{"type":"string","description":"The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_max_cpu_pressure_level":{"type":"string","description":"The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"quality":{"type":"string","description":"The meeting quality assessment.","enum":["bad","fair","good","poor"]},"quality_score":{"type":"string","description":"The session quality score."},"max_rssi":{"type":"integer","description":"Maximum value of the wireless network's received signal strength indicator (RSSI).","example":"-35"},"avg_rssi":{"type":"integer","description":"Average value of the wireless network's received signal strength indicator (RSSI).","example":"-69"},"min_rssi":{"type":"integer","description":"Minimum value of the wireless network's received signal strength indicator (RSSI).","example":"-75"},"rssi_unit":{"type":"string","description":"Unit of the wireless network's received signal strength indicator (RSSI).","example":"dBm"}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the user."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Webinar.participant_qos_summaryEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name.","enum":["webinar.participant_qos_summary"]},"event_ts":{"type":"integer","description":"The timestamp in milliseconds since epoch when the event occurred, in long (int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string"},"object":{"type":"object","properties":{"uuid":{"type":"string","description":"The webinar's universally unique identifier (UUID)."},"id":{"type":"string","description":"The webinar number."},"participant":{"required":["email","id","participant_id","qos","user_name"],"type":"object","properties":{"participant_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique identifier (UUID): \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api/users/#tag/users/get/users/{userId}) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty (\"\") value."},"email":{"pattern":"(^\\s*$|^[A-Za-z0-9!#$%&''*+/=?^_`{|}~-]+(\\.[A-Za-z0-9!#$%&''*+/=?^_`{|}~-]+)*@[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)*(\\.[A-Za-z]{2,})$)","type":"string","description":"The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. 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](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details.","format":"email"},"qos":{"type":"array","items":{"required":["details","type"],"type":"object","properties":{"type":{"type":"string","enum":["audio_input","audio_output","video_input","video_output","as_input","as_output","cpu_usage","audio_device_from_crc","audio_device_to_crc","video_device_from_crc","video_device_to_crc","as_device_from_crc","as_device_to_crc","audio_device_from_rwg","audio_device_to_rwg","video_device_from_rwg","video_device_to_rwg","as_device_from_rwg","as_device_to_rwg","audio_quality","video_quality","as_quality","wifi_rssi"]},"details":{"type":"object","properties":{"min_bitrate":{"type":"string","description":"The minimum bits per second transmitted along a digital network, in Kbps."},"avg_bitrate":{"type":"string","description":"The average bits per second transmitted along a digital network, in Kbps."},"max_bitrate":{"type":"string","description":"The maximum bits per second transmitted along a digital network, in Kbps."},"min_latency":{"type":"string","description":"The minimum time it took a packet to travel from one point to another, in milliseconds."},"avg_latency":{"type":"string","description":"The average time it took a packet to travel from one point to another, in milliseconds."},"max_latency":{"type":"string","description":"The maximum time it took a packet to travel from one point to another, in milliseconds."},"min_jitter":{"type":"string","description":"The minimum variation in the delay of received packets, in milliseconds."},"avg_jitter":{"type":"string","description":"The average variation in the delay of received packets, in milliseconds."},"max_jitter":{"type":"string","description":"The maximum variation in the delay of received packets, in milliseconds."},"min_loss":{"type":"string","description":"The minimum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination."},"avg_loss":{"type":"string","description":"The average amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination."},"max_loss":{"type":"string","description":"The maximum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination."},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display."},"min_frame_rate":{"type":"string","description":"The minimum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS)."},"avg_frame_rate":{"type":"string","description":"The average rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS)."},"max_frame_rate":{"type":"string","description":"The maximum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS)."},"zoom_min_cpu_usage":{"type":"string","description":"Zoom's minimum CPU usage."},"zoom_avg_cpu_usage":{"type":"string","description":"Zoom's average CPU usage."},"zoom_max_cpu_usage":{"type":"string","description":"Zoom's maximum CPU usage."},"system_max_cpu_usage":{"type":"string","description":"The system's maximum CPU usage."},"system_min_cpu_pressure_level":{"type":"string","description":"The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_avg_cpu_pressure_level":{"type":"string","description":"The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_max_cpu_pressure_level":{"type":"string","description":"The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"quality":{"type":"string","description":"The meeting quality object.","enum":["bad","fair","good","poor"]},"quality_score":{"type":"string","description":"The meeting quality score."},"max_rssi":{"type":"integer","description":"The maximum value of the wireless network's received signal strength indicator (RSSI).","example":"-75"},"avg_rssi":{"type":"integer","description":"The average value of the wireless network's received signal strength indicator (RSSI).","example":"-69"},"min_rssi":{"type":"integer","description":"The minimum value of the wireless network's received signal strength indicator (RSSI).","example":"-35"},"rssi_unit":{"type":"string","description":"The unit of measurement for the wireless network's received signal strength indicator (RSSI).","example":"dBm"}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_dataEvent":{"required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"A timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"object":{"required":["participant","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"participant":{"required":["data","participant_id"],"type":"object","properties":{"participant_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). Returns an empty value for external users."},"email":{"type":"string","description":"The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. 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](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.","format":"email"},"data":{"type":"array","description":"The participant's data information.","items":{"type":"object","properties":{"device":{"type":"string","description":"The type of device the participant used to join the meeting: \n* `Phone` — The participant joined via PSTN. \n* `H.323/SIP` — The participant joined via an H.323 or SIP device. \n* `Windows` — The participant joined via VoIP using a Windows device. \n* `Mac` — The participant joined via VoIP using a Mac device. \n* `iOS` — The participant joined via VoIP using an iOS device. \n* `Android` — The participant joined via VoIP using an Android device.","enum":["Phone","H.323/SIP","Windows","Mac","iOS","Android"]},"location":{"type":"string","description":"The participant's location."},"Location":{"type":"string","description":"Deprecated, use `location`.","deprecated":true},"network_type":{"type":"string","description":"The participant's network type: \n\n* `Wired` \n* `Wifi` \n* `PPP` — Point-to-Point. \n* `Cellular` — 3G, 4G, and 5G cellular. \n* `Others` — An unknown device.","enum":["Wired","Wifi","PPP","Cellular","Others"]},"microphone":{"type":"string","description":"The type of microphone that the participant used during the meeting."},"speaker":{"type":"string","description":"The type of speaker that the participant used during the meeting."},"camera":{"type":"string","description":"The type of camera that the participant used during the meeting."},"data_center":{"type":"string","description":"The data center where participant's meeting data is stored."},"connection_type":{"type":"string","description":"The participant's connection type."},"pc_name":{"type":"string","description":"The participant's PC name."},"domain":{"type":"string","description":"The participant's PC domain."},"mac_addr":{"type":"string","description":"The participant's MAC address."},"harddisk_id":{"type":"string","description":"The participant's hard disk ID."},"version":{"type":"string","description":"The participant's Zoom client version."},"signaling_ip_address":{"type":"string","description":"The participant's signaling IP address for information other than audio, video, or share screen."},"signaling_internal_ip_address":{"type":"string","description":"The participant's signaling internal IP address."},"signaling_internal_ip_port":{"type":"string","description":"The participant's signaling internal IP port."},"audio_internal_ip_address":{"type":"string","description":"The participant's audio internal IP address."},"audio_internal_ip_port":{"type":"string","description":"The participant's audio internal IP port."},"video_internal_ip_address":{"type":"string","description":"The participant's video internal IP address."},"video_internal_ip_port":{"type":"string","description":"The participant's video internal IP port."},"as_internal_ip_address":{"type":"string","description":"The participant's sharing internal IP address."},"as_internal_ip_port":{"type":"string","description":"The participant's sharing internal IP port."},"destination_ip_domain":{"type":"string","description":"The participant's destination internal IP domain."},"destination_ip_port":{"type":"string","description":"The participant's destination internal IP port."},"zoom_thin_client_plugin_version":{"type":"string","description":"The VDI thin client version."},"rc_reason":{"type":"string","description":"The call reconnection reason: Client crash."}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Phone.call_qosEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"Name of the event.","enum":["phone.call_qos"]},"event_ts":{"type":"integer","description":"Timestamp when the event occurred, in milliseconds since epoch. The value of this field is returned in long (int64) format.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Account ID of the owner."},"object":{"required":["call_id","call_qos","call_start_time"],"type":"object","properties":{"call_id":{"type":"string","description":"The call ID."},"call_start_time":{"type":"string","description":"The date and time when the call started.","format":"date-time"},"call_end_time":{"type":"string","description":"The date and time when the call ended. Only shows up if the call ended.","format":"date-time"},"call_qos":{"required":["id","qos","type"],"type":"object","properties":{"type":{"type":"string","description":"The type: caller or callee."},"id":{"type":"string","description":"The caller or callee's ID."},"user_email":{"type":"string","description":"The caller or callee's email address."},"qos":{"required":["date_time","details","type"],"type":"object","properties":{"date_time":{"type":"string","description":"The date and time when the QoS data was received.","format":"date-time"},"type":{"type":"string","description":"The QoS type: sending or receiving."},"details":{"required":["avg_loss","bitrate","jitter","max_loss","mos","network_delay"],"type":"object","properties":{"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in Kbsp."},"avg_loss":{"type":"string","description":"The average amount of packet loss. For example, the percentage of packets that failed to arrive at their destination."},"max_loss":{"type":"string","description":"The maximum amount of packet loss. For example, the maximum percentage of packets that failed to arrive at their destination."},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds."},"network_delay":{"type":"string","description":"The amount of time, in milliseconds, that it takes for a Voice Over IP (VoIP) packet to travel from one point to another."},"mos":{"type":"string","description":"The Mean Opinion Score (MOS). This measures voice quality on a scale of 1 to 5. A score above or equal to 3.5 means good quality, while below 3.5 means poor quality."},"network":{"type":"string","description":"The type of networks such as LAN, WiFi, VPN etc"}},"description":"The quality of service (QoS) details."}},"description":"The quality of service (QoS) data."}},"description":"The call quality of service (QoS)."}},"description":"The object type."}}}}},"Session.user_dataEvent":{"required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp when the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["session_id","session_name","user"],"type":"object","properties":{"session_id":{"type":"string","description":"A unique session identifier. Each instance of the session will have its own `session_id`."},"session_name":{"type":"string","description":"The session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user":{"required":["data","id","is_original_host"],"type":"object","properties":{"id":{"type":"string","description":"The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."},"name":{"type":"string","description":"The user's username."},"user_key":{"type":"string","description":"Another identifier for the user. The value can be numeric or alphanumeric."},"is_original_host":{"type":"boolean","description":"Whether the current user is the original host of this session."},"data":{"type":"array","description":"The user's session data.","items":{"type":"object","properties":{"device":{"type":"string","description":"The type of device the user used to join the session. \n* `Phone` - The user joined via PSTN. \n* `H.323/SIP` - The user joined via an H.323 or SIP device. \n* `Windows` - The user joined via VoIP using a Windows device. \n* `Mac` - The user joined via VoIP using a macOS device. \n* `iOS` - The user joined via VoIP using an iOS device. \n* `Android` - The user joined via VoIP using an Android device.","enum":["Phone","H.323/SIP","Windows","Mac","iOS","Android"]},"location":{"type":"string","description":"The user's location."},"network_type":{"type":"string","description":"The user's network type. \n\n* `Wired` \n* `Wifi` \n* `PPP` - Point-to-Point. \n* `Cellular` - 3G, 4G, and 5G cellular. \n* `Others` - An unknown device.","enum":["Wired","Wifi","PPP","Cellular","Others"]},"microphone":{"type":"string","description":"The type of microphone that the user used during the session."},"speaker":{"type":"string","description":"The type of speaker that the user used during the session."},"camera":{"type":"string","description":"The type of camera that the user used during the session."},"data_center":{"type":"string","description":"The data center where the user's session data is stored."},"connection_type":{"type":"string","description":"The user's connection type."},"pc_name":{"type":"string","description":"The user's PC name."},"domain":{"type":"string","description":"The user's PC domain."},"mac_addr":{"type":"string","description":"The user's MAC address."},"harddisk_id":{"type":"string","description":"The user's hard disk ID."},"version":{"type":"string","description":"The user's Zoom client version."},"signaling_ip_address":{"type":"string","description":"The user's signaling IP address for information other than audio, video, or screen sharing."},"signaling_internal_ip_address":{"type":"string","description":"The user's signaling internal IP address."},"signaling_internal_ip_port":{"type":"string","description":"The user's signaling internal IP port."},"audio_internal_ip_address":{"type":"string","description":"The user's audio internal IP address."},"audio_internal_ip_port":{"type":"string","description":"The user's audio internal IP port."},"video_internal_ip_address":{"type":"string","description":"The user's video internal IP address."},"video_internal_ip_port":{"type":"string","description":"The user's video internal IP port."},"as_internal_ip_address":{"type":"string","description":"The user's sharing internal IP address."},"as_internal_ip_port":{"type":"string","description":"The user's sharing internal IP port."},"destination_ip_domain":{"type":"string","description":"The user's destination internal IP domain."},"destination_ip_port":{"type":"string","description":"The user's destination internal IP port."},"rc_reason":{"type":"string","description":"The call reconnection reason, such as a client crash."}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the session user."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_data_summaryEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"object":{"required":["participant","uuid"],"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a meeting UUID."},"id":{"type":"string","description":"The meeting ID."},"participant":{"required":["data","participant_id"],"type":"object","properties":{"participant_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the duration of the meeting."},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). Returns an empty value for external users."},"email":{"type":"string","description":"The participant's email address. This response only returns a value if the participant joined the meeting by logging into Zoom. 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](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.","format":"email"},"data":{"type":"array","description":"The participant's data details.","items":{"required":["as_internal_ip_address","as_internal_ip_port","audio_internal_ip_address","audio_internal_ip_port","camera","connection_type","data_center","destination_ip_domain","destination_ip_port","device","domain","harddisk_id","location","mac_addr","microphone","network_type","pc_name","signaling_internal_ip_address","signaling_internal_ip_port","signaling_ip_address","speaker","version","video_internal_ip_address","video_internal_ip_port"],"type":"object","properties":{"device":{"type":"string","description":"The type of device the participant used to join the meeting: \n* `Phone` — The participant joined via PSTN. \n* `H.323/SIP` — The participant joined via an H.323 or SIP device. \n* `Windows` — The participant joined via VoIP using a Windows device. \n* `Mac` — The participant joined via VoIP using a Mac device. \n* `iOS` — The participant joined via VoIP using an iOS device. \n* `Android` — The participant joined via VoIP using an Android device.","enum":["Phone","H.323/SIP","Windows","Mac","iOS","Android"]},"location":{"type":"string","description":"The participant's location."},"network_type":{"type":"string","description":"The participant's network type: \n\n* `Wired` \n* `Wifi` \n* `PPP` — Point-to-Point. \n* `Cellular` — 3G, 4G, and 5G cellular. \n* `Others` — An unknown device.","enum":["Wired","Wifi","PPP","Cellular","Others"]},"microphone":{"type":"string","description":"The type of microphone that the participant used during the meeting."},"speaker":{"type":"string","description":"The type of speaker that the participant used during the meeting."},"camera":{"type":"string","description":"The type of camera that the participant used during the meeting."},"data_center":{"type":"string","description":"The data center where the participant's meeting data is stored."},"connection_type":{"type":"string","description":"The participant's connection type."},"pc_name":{"type":"string","description":"The participant's PC name."},"domain":{"type":"string","description":"The participant's PC domain."},"mac_addr":{"type":"string","description":"The participant's MAC address."},"harddisk_id":{"type":"string","description":"The participant's hard disk ID."},"version":{"type":"string","description":"The participant's Zoom client version."},"signaling_ip_address":{"type":"string","description":"The participant's signaling IP address for information other than audio, video, or screen sharing."},"signaling_internal_ip_address":{"type":"string","description":"The participant's signaling internal IP address."},"signaling_internal_ip_port":{"type":"string","description":"The participant's signaling internal IP port."},"audio_internal_ip_address":{"type":"string","description":"The participant's audio internal IP address."},"audio_internal_ip_port":{"type":"string","description":"The participant's audio internal IP port."},"video_internal_ip_address":{"type":"string","description":"The participant's video internal IP address."},"video_internal_ip_port":{"type":"string","description":"The participant's video internal IP port."},"as_internal_ip_address":{"type":"string","description":"The participant's sharing internal IP address."},"as_internal_ip_port":{"type":"string","description":"The participant's sharing internal IP port."},"destination_ip_domain":{"type":"string","description":"The participant's destination internal IP domain."},"destination_ip_port":{"type":"string","description":"The participant's destination internal IP port."},"device_detail":{"type":"string","description":"The participant's detailed device information."},"client":{"type":"string","description":"The participant's SDK client version."},"zoom_thin_client_plugin_version":{"type":"string","description":"The VDI thin client version."},"rc_reason":{"type":"string","description":"The call reconnection reason, for example, `Client crash`."}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_data_summaryEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["session_id","session_name","user"],"type":"object","properties":{"session_id":{"type":"string","description":"A unique session identifier. Each instance of the session will have its own `session_id`."},"session_name":{"type":"string","description":"Session name."},"session_key":{"type":"string","description":"The Video SDK custom session ID."},"user":{"required":["data","id","is_original_host"],"type":"object","properties":{"id":{"type":"string","description":"The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."},"name":{"type":"string","description":"The user's username."},"user_key":{"type":"string","description":"Another identifier for the user. Can be numeric or alphanumeric."},"is_original_host":{"type":"boolean","description":"Whether the current user is the original host of this session."},"data":{"type":"array","description":"The user's session data.","items":{"required":["as_internal_ip_address","as_internal_ip_port","audio_internal_ip_address","audio_internal_ip_port","camera","connection_type","data_center","destination_ip_domain","destination_ip_port","device","domain","harddisk_id","location","mac_addr","microphone","network_type","pc_name","signaling_internal_ip_address","signaling_internal_ip_port","signaling_ip_address","speaker","version","video_internal_ip_address","video_internal_ip_port"],"type":"object","properties":{"device":{"type":"string","description":"The type of device the user used to join the session. \n* `Phone` - The user joined via PSTN. \n* `H.323/SIP` - The user joined via an H.323 or SIP device. \n* `Windows` - The user joined via VoIP using a Windows device. \n* `Mac` - The user joined via VoIP using a macOS device. \n* `iOS` - The user joined via VoIP using an iOS device. \n* `Android` - The user joined via VoIP using an Android device.","enum":["Phone","H.323/SIP","Windows","Mac","iOS","Android"]},"location":{"type":"string","description":"The user's location."},"network_type":{"type":"string","description":"The user's network type. \n\n* `Wired` \n* `Wifi` \n* `PPP` - Point-to-Point. \n* `Cellular` - 3G, 4G, and 5G cellular. \n* `Others` - An unknown network type.","enum":["Wired","Wifi","PPP","Cellular","Others"]},"microphone":{"type":"string","description":"The type of microphone that the user used during the session."},"speaker":{"type":"string","description":"The type of speaker that the user used during the session."},"camera":{"type":"string","description":"The type of camera that the user used during the session."},"data_center":{"type":"string","description":"The data center where the user's session data is stored."},"connection_type":{"type":"string","description":"The user's connection type."},"pc_name":{"type":"string","description":"The user's PC name."},"domain":{"type":"string","description":"The user's PC domain."},"mac_addr":{"type":"string","description":"The user's MAC address."},"harddisk_id":{"type":"string","description":"The user's hard disk ID."},"version":{"type":"string","description":"The user's Zoom client version."},"signaling_ip_address":{"type":"string","description":"The user's signaling IP address for information other than audio, video, or screen sharing."},"signaling_internal_ip_address":{"type":"string","description":"The user's signaling internal IP address."},"signaling_internal_ip_port":{"type":"string","description":"The user's signaling internal IP port."},"audio_internal_ip_address":{"type":"string","description":"The user's audio internal IP address."},"audio_internal_ip_port":{"type":"string","description":"The user's audio internal IP port."},"video_internal_ip_address":{"type":"string","description":"The user's video internal IP address."},"video_internal_ip_port":{"type":"string","description":"The user's video internal IP port."},"as_internal_ip_address":{"type":"string","description":"The user's sharing internal IP address."},"as_internal_ip_port":{"type":"string","description":"The user's sharing internal IP port."},"destination_ip_domain":{"type":"string","description":"The user's destination internal IP domain."},"destination_ip_port":{"type":"string","description":"The user's destination internal IP port."},"device_detail":{"type":"string","description":"The user's detailed device information."},"client":{"type":"string","description":"The user's SDK client version."},"rc_reason":{"type":"string","description":"The reason for call reconnection, such as a client crash."}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the session user."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false},"Meeting.participant_qos_summaryEvent":{"required":["event","event_ts","payload"],"type":"object","properties":{"event":{"type":"string","description":"The name of the event."},"event_ts":{"type":"integer","description":"The timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The meeting host's account ID."},"object":{"type":"object","properties":{"uuid":{"type":"string","description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a unique meeting UUID."},"id":{"type":"string","description":"The meeting ID."},"participant":{"required":["email","id","participant_id","qos","user_name"],"type":"object","properties":{"participant_id":{"type":"string","description":"The participant's meeting user ID. This value is assigned to a participant upon joining a meeting and is only valid for the meeting duration."},"user_name":{"type":"string","description":"The participant's display name."},"id":{"type":"string","description":"The participant's universally unique ID (UUID): \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api/rest/reference/zoom-api/methods/#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty (`\"\"`) value."},"email":{"pattern":"(^\\s*$|^[A-Za-z0-9!#$%&''*+/=?^_`{|}~-]+(\\.[A-Za-z0-9!#$%&''*+/=?^_`{|}~-]+)*@[A-Za-z0-9-]+(\\.[A-Za-z0-9-]+)*(\\.[A-Za-z]{2,})$)","type":"string","description":"The participant's email address. Only returned if the participant joined the meeting by logging into Zoom.","format":"email"},"qos":{"type":"array","description":"Information about the participant's quality of service (QoS).","items":{"required":["details","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of quality of service (QoS) metrics, from the point of view of the client. See [List meeting participants QoS Summary](https://developers.zoom.us/docs/api/rest/reference/qss/methods/#operation/dashboardMeetingParticipantsQOSSummary) for descriptions.","enum":["audio_input","audio_output","video_input","video_output","as_input","as_output","cpu_usage","audio_device_from_crc","audio_device_to_crc","video_device_from_crc","video_device_to_crc","as_device_from_crc","as_device_to_crc","audio_device_from_rwg","audio_device_to_rwg","video_device_from_rwg","video_device_to_rwg","as_device_from_rwg","as_device_to_rwg","audio_quality","video_quality","as_quality","wifi_rssi"]},"details":{"type":"object","properties":{"min_bitrate":{"type":"string","description":"The minimum bits per second transmitted along a digital network, in Kbps."},"avg_bitrate":{"type":"string","description":"The average bits per second transmitted along a digital network, in Kbps."},"max_bitrate":{"type":"string","description":"The maximum bits per second transmitted along a digital network, in Kbps."},"min_latency":{"type":"string","description":"The minimum time it took a packet to travel from one point to another, in milliseconds."},"avg_latency":{"type":"string","description":"The average time it took a packet to travel from one point to another, in milliseconds."},"max_latency":{"type":"string","description":"The maximum time it took a packet to travel from one point to another, in milliseconds."},"min_jitter":{"type":"string","description":"The minimum variation in the delay of received packets, in milliseconds."},"avg_jitter":{"type":"string","description":"The average variation in the delay of received packets, in milliseconds."},"max_jitter":{"type":"string","description":"The maximum variation in the delay of received packets, in milliseconds."},"min_loss":{"type":"string","description":"The minimum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination."},"avg_loss":{"type":"string","description":"The average amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination."},"max_loss":{"type":"string","description":"The maximum amount of packet loss, expressed as the percentage of packets that failed to arrive at their destination."},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display."},"min_frame_rate":{"type":"string","description":"The minimum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS)."},"avg_frame_rate":{"type":"string","description":"The average rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS)."},"max_frame_rate":{"type":"string","description":"The maximum rate at which the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 frames per second (FPS)."},"zoom_min_cpu_usage":{"type":"string","description":"Zoom's minimum CPU usage."},"zoom_avg_cpu_usage":{"type":"string","description":"Zoom's average CPU usage."},"zoom_max_cpu_usage":{"type":"string","description":"Zoom's maximum CPU usage."},"system_max_cpu_usage":{"type":"string","description":"The system's maximum CPU usage."},"system_min_cpu_pressure_level":{"type":"string","description":"The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_avg_cpu_pressure_level":{"type":"string","description":"The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_max_cpu_pressure_level":{"type":"string","description":"The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"quality":{"type":"string","description":"Meeting Quality Object","enum":["bad","fair","good","poor"]},"quality_score":{"type":"string","description":"The meeting quality score."},"max_rssi":{"type":"integer","description":"The maximum value of the wireless network's received signal strength indicator (RSSI).","example":"-35"},"avg_rssi":{"type":"integer","description":"The average value of the wireless network's received signal strength indicator (RSSI).","example":"-69"},"min_rssi":{"type":"integer","description":"The minimum value of the wireless network's received signal strength indicator (RSSI).","example":"-75"},"rssi_unit":{"type":"string","description":"The unit of the wireless network's received signal strength indicator (RSSI).","example":"dBm"}},"additionalProperties":false}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the meeting participant."}},"additionalProperties":false,"description":"Information about the meeting."}},"additionalProperties":false}},"additionalProperties":false},"Session.user_qosEvent":{"required":["event","event_ts","payload"],"properties":{"event":{"type":"string","description":"The event's name."},"event_ts":{"type":"integer","description":"The timestamp at which the event occurred.","format":"int64"},"payload":{"required":["account_id","object"],"type":"object","properties":{"account_id":{"type":"string","description":"The Video SDK account ID."},"object":{"required":["session_id","session_name","user"],"type":"object","properties":{"session_id":{"type":"string","description":"The unique session identifier. Each instance of the session will have its own session_id."},"session_name":{"type":"string","description":"The session name."},"session_key":{"type":"string","description":"The Video SDK custom session identifier."},"user":{"required":["id","is_original_host","name","qos"],"type":"object","properties":{"id":{"type":"string","description":"The user's unique ID. This value is assigned to the user upon joining a session and is only valid for that session."},"name":{"type":"string","description":"The user's username."},"user_key":{"type":"string","description":"An additional identifier for the user. Can be numeric or alphanumeric."},"is_original_host":{"type":"boolean","description":"Whether the current user is the original host of this session."},"qos":{"type":"array","description":"Information about the user's quality of service (QoS).","items":{"required":["date_time","details","type"],"type":"object","properties":{"date_time":{"type":"string","description":"The timestamp when the QoS data was recorded."},"type":{"type":"string","description":"The QoS type.\n- `audio_input` — The QoS metrics for audio sent by a user.\n- `audio_output` — The QoS metrics for audio received by a user.\n- `video_input` — The QoS metrics for video input sent by a user.\n- `video_output` — The QoS metrics for video output received by a user.\n- `as_input` — The QoS metrics for screen sharing sent by a user.\n- `as_output` — The QoS metrics for screen sharing output received by a user.\n- `cpu_usage` — The QoS metrics for CPU usage.\n- `audio_device_from_crc` — The QoS metrics for audio sent by a user who joined the session via a Cloud Room Connector (CRC).\n- `audio_device_to_crc` — The QoS metrics for audio received by a user who joined the session via CRC.\n- `video_device_from_crc` — The QoS metrics for video input sent by a user who joined the session via CRC.\n- `video_device_to_crc` — The QoS metrics for video output received by a user who joined the session via CRC.\n- `as_device_from_crc` — The QoS metrics for screen sharing sent by a user who joined the session via CRC.\n- `as_device_to_crc` — The QoS metrics for screen sharing output received by a user who joined the session via CRC.\n- `audio_device_from_rwg` — The QoS metrics for audio sent by a participant who joined the meeting via the web client.\n- `audio_device_to_rwg` — The QoS metrics for audio received by a participant who joined the meeting via the web client.\n- `video_device_from_rwg` — The QoS metrics for video sent by a participant who joined the meeting via the web client.\n- `video_device_to_rwg` — The QoS metrics for video received by a participant who joined the meeting via the web client.\n- `as_device_from_rwg` — The QoS metrics for screen sharing sent by a participant who joined the meeting via the web client.\n- `as_device_to_rwg` — The QoS metrics for screen sharing received by a participant who joined the meeting via the web client.\n- `audio_quality` — `good`: The audio is almost flawless and the quality is excellent. `fair`: The audio occasionally has distortion, noise, or other problems, but the content is basically continuous and users can communicate normally. `poor`: The audio often has distortion, noise, or other problems, but the content is basically continuous and users can communicate normally. `bad`: The sound quality is extremely poor and the audio content is almost inaudible.\n- `video_quality` — `good`: The video is almost flawless and the quality is excellent. `fair`: The video definition is high and occasionally gets stuck or has 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.\n- `as_quality` — `good`: The screen sharing is almost flawless and the quality is excellent. `fair`: The screen sharing definition is high and occasionally gets stuck or has other problems, but the frequency is very low and the quality is good. `poor`: The screen sharing definition is not high, but not many problems exist. The quality is mediocre. `bad`: The picture is very blurred and often gets stuck.\n- `wifi_rssi` — The QoS metrics for the wireless network's RSSI sent by a participant who joined the meeting through a wireless network.\n- `notification` — The notification type.","enum":["audio_input","audio_output","video_input","video_output","as_input","as_output","cpu_usage","audio_device_from_crc","audio_device_to_crc","video_device_from_crc","video_device_to_crc","as_device_from_crc","as_device_to_crc","audio_device_from_rwg","audio_device_to_rwg","video_device_from_rwg","video_device_to_rwg","as_device_from_rwg","as_device_to_rwg","audio_quality","video_quality","as_quality","wifi_rssi","notification"]},"details":{"type":"object","properties":{"bitrate":{"type":"string","description":"The transmission rate in kilobits per second (Kbps) along the digital network."},"latency":{"type":"string","description":"The time it takes for a packet to travel from one point to another, measured in milliseconds."},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds."},"avg_loss":{"type":"string","description":"The average packet loss percentage."},"max_loss":{"type":"string","description":"The maximum packet loss percentage."},"resolution":{"type":"string","description":"The video resolution in pixels that the camera can display."},"frame_rate":{"type":"string","description":"The rate at which the camera produces unique frames. Zoom supports up to 30 frames per second (FPS)."},"zoom_min_cpu_usage":{"type":"string","description":"Zoom's minimum CPU usage."},"zoom_avg_cpu_usage":{"type":"string","description":"Zoom's average CPU usage."},"zoom_max_cpu_usage":{"type":"string","description":"Zoom's maximum CPU usage."},"system_max_cpu_usage":{"type":"string","description":"The system's maximum CPU usage."},"system_min_cpu_pressure_level":{"type":"string","description":"The system's minimum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_avg_cpu_pressure_level":{"type":"string","description":"The system's average CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"system_max_cpu_pressure_level":{"type":"string","description":"The system's maximum CPU pressure level during the preceding second, based on the [Compute Pressure API](https://developer.mozilla.org/en-US/docs/Web/API/Compute_Pressure_API#pressure_states). These levels are rough estimates of CPU usage: `normal` (~20%), `fair` (~50%), `serious` (~80%), and `critical` (~100%).","enum":["normal","fair","serious","critical"]},"quality":{"type":"string","description":"The meeting quality level.","enum":["bad","fair","good","poor"]},"quality_score":{"type":"string","description":"The session quality score."},"max_rssi":{"type":"string","description":"Maximum value of the wireless network's received signal strength indicator (RSSI).","example":"-35"},"avg_rssi":{"type":"string","description":"Average value of the wireless network's received signal strength indicator (RSSI).","example":"-69"},"min_rssi":{"type":"string","description":"Minimum value of the wireless network's received signal strength indicator (RSSI).","example":"-75"},"rssi_unit":{"type":"string","description":"Unit of the wireless network's received signal strength indicator (RSSI).","example":"dBm"},"network_notification":{"type":"string","description":"Client-triggered network instability notification.","enum":["network bandwidth low","internet connection unstable"]}},"additionalProperties":false,"description":"The QoS details object."}},"additionalProperties":false}}},"additionalProperties":false,"description":"Information about the user."}},"additionalProperties":false,"description":"Information about the session."}},"additionalProperties":false}},"additionalProperties":false}}},"tags":[{"name":"real-time"}],"servers":[{"url":"https://{your-endpoint-url}"}]}