Zoom Public API Documentation

Zoom QSS API

Number of APIs: 3

Zoom Quality of Service Subscription (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 to add this feature.

Prerequisites:

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.

1. metrics-meetings-{meetingId}-participants-qos_summary - List meeting participants QoS Summary

GET {{baseUrl}}/metrics/meetings/:meetingId/participants/qos_summary?page_size=1&next_page_token=<string>

Return a list of meeting participants from past meetings and the summary their quality of service received during the meeting. The data returned indicates the connection quality for sending or receiving video, audio, and shared content.

Note:

This API may return empty values for participants' user_name and email responses when the account calling this API. * Does not have a signed HIPAA business associate agreement (BAA). * Is a legacy HIPAA BAA account. * Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions. See Email address display rules for details.

Prerequisites: * A Business or a higher plan. * Developers must subscribe to the QSS summary event to receive data from this API.

Rate Limit Label: HEAVY

2. metrics-webinars-{webinarId}-participants-qos_summary - List webinar participants QoS Summary

GET {{baseUrl}}/metrics/webinars/:webinarId/participants/qos_summary?page_size=1&next_page_token=<string>

Use this API to return a list of webinar participants from live or past webinars and the quality of service they received during the webinar. The data returned indicates the connection quality for sending/receiving video, audio, and shared content.

Note:

This API may return empty values for participants' user_name and email responses when the account calling this API: * Does not have a signed HIPAA business associate agreement (BAA). * Is a legacy HIPAA BAA account. * Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions. See Email address display rules for details.

Prerequisites: * A Business, Education, or API Plan with Webinar add-on. * Developers must subscribe to the QSS summary event to receive data from this API.

Scopes: dashboard_webinars:read:admin

Rate Limit Label: Heavy

3. videosdk-sessions-{sessionId}-users-qos_summary - List session users QoS Summary

GET {{baseUrl}}/videosdk/sessions/:sessionId/users/qos_summary?page_size=1&next_page_token=<string>

Use this API to return a list of users from past sessions and a summary of their quality of service received during the session. The data returned indicates the connection quality for sending and receiving video, audio, and shared content.

Note:

This API may return empty values for users' name responses when the account calling this API: * Does not have a signed HIPAA business associate agreement (BAA). * Is a legacy HIPAA BAA account. * Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions.

Prerequisites: * A Business or a higher plan. * Developers must subscribe to the QSS summary event to receive data from this API.

Scopes: dashboard_meetings:read:admin

Rate Limit Label: Heavy