Zoom Public API Documentation

Zoom Video SDK API

Number of APIs: 21

1. videosdk-sessions-{session Id}-recordings-{recording Id} - Delete session's recording file

DELETE {{baseUrl}}/videosdk/sessions/:sessionId/recordings/:recordingId?action=trash

Delete a specific recording file from a session.

Note: To use this API, you must enable the The host can delete cloud recordings setting.

Rate Limit Label: Light

2. videosdk-sessions-{session Id}-recordings-{recording Id} - Recover a single recording

PUT {{baseUrl}}/videosdk/sessions/:sessionId/recordings/:recordingId/status

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the session.

Rate Limit Label: Light

3. videosdk-sessions-{session Id}-recordings - List session's recordings

GET {{baseUrl}}/videosdk/sessions/:sessionId/recordings?include_fields=download_access_token&ttl=0

Get all the [recordings] from a session instance. The recording files can be downloaded via the download_url property listed in the response.

To access a password-protected cloud recording, add an access_token parameter to the download URL and provide JWT as the access_token value.

Rate Limit Label: Light

4. videosdk-sessions-{session Id}-recordings - Delete session's recordings

DELETE {{baseUrl}}/videosdk/sessions/:sessionId/recordings?action=trash

Delete all recording files of a session.

Rate Limit Label: Light
Prerequisites: * Cloud Recording should be enabled on the user's account.

5. videosdk-sessions-{session Id}-recordings - Recover session's recordings

PUT {{baseUrl}}/videosdk/sessions/:sessionId/recordings/status

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date.

Rate Limit Label: Light
Prerequisites:
* Video SDK account with Cloud Recording enabled.

6. videosdk-sessions-{session Id}-users - List session users

GET {{baseUrl}}/videosdk/sessions/:sessionId/users?type=live&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82

Use this API to return a list of users from live or past sessions. You can specify a monthly date range for this data using the from and to query parameters. The month should fall within the last six months.

If you do not provide the type query parameter, the API defaults to the live value and the API will only return metrics for users in a live session, if a session is currently in progress.
To view metrics on past session users, provide the past value for the type query parameter.

Rate Limit Label: Heavy

Prerequisites: * A Video SDK account.

7. videosdk-sessions-{session Id}-users - List session users QoS

GET {{baseUrl}}/videosdk/sessions/:sessionId/users/qos?type=live&page_size=10&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82

Use this API to return a list of session users from live or past sessions along with the QoS (quality of service) they received during the session. For example, connection quality for sending and receiving video, audio, and shared content. You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.

If you do not provide the type query parameter, the API defaults to the live value and the API will only return metrics for users in a live session, if a session is currently in progress.
To view metrics on past session users, provide the past value for the type query parameter.

Rate Limit Label: Heavy

Prerequisites: * A Video SDK Account

8. videosdk-sessions-{session Id}-users - Get session user QoS

GET {{baseUrl}}/videosdk/sessions/:sessionId/users/:userId/qos?type=live

Use this API to retrieve the quality of service (QoS) for users from live or past sessions. The data returned indicates the connection quality for sending and receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received. * This API will not return data if there is no data being sent or received at the time of request.

Rate Limit Label: Heavy

Note: When the sender sends its data, a timestamp is attached to the sender's data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum.

9. videosdk-sessions-{session Id}-users - Get sharing/recording details

GET {{baseUrl}}/videosdk/sessions/:sessionId/users/sharing?type=live&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82

Retrieve the sharing and recording details of participants from live or past sessions.
Rate Limit Label: Heavy
Prerequisites:
* A Video SDK Account.

10. videosdk-sessions-{session Id}-livestream - Update a session live stream

PATCH {{baseUrl}}/videosdk/sessions/:sessionId/livestream

Use this API to update a session's live stream information.

Rate Limit Label: Light

Prerequisites: * A Video SDK account

11. videosdk-sessions-{session Id}-livestream - Get session live stream details

GET {{baseUrl}}/videosdk/sessions/:sessionId/livestream

Use this API to return a session's live stream configuration details, such as the stream's URL, key, and page URL.

Rate Limit Label: Light

Prerequisites: * A Video SDK account

12. videosdk-sessions-{session Id}-livestream - Update session live stream status

PATCH {{baseUrl}}/videosdk/sessions/:sessionId/livestream/status

Use this API to update a session's live stream status.

Rate Limit Label: Light

Prerequisites: * A Video SDK account

13. videosdk-sessions-{session Id} - Get session details

GET {{baseUrl}}/videosdk/sessions/:sessionId?type=live

Use this API to return information about live or past sessions. You can specify a monthly date range for this data using the from and to query parameters. The month should fall within the last six months.

The overview response displays whether features such as audio, video, screensharing, and recording were used during the session.

Rate Limit Label: Heavy

Prerequisites: * A Video SDK account

14. videosdk-sessions-{session Id} - Use in-Session events controls

PATCH {{baseUrl}}/videosdk/sessions/:sessionId/events

Use this API to control in-Session events such as the recording controls to start a recording, stop a recording, pause a recording, and resume a recording, and invitation control to invite participants. The recording controls only work for Cloud Recordings and not for local recordings.

Prerequisite: * The session must be a live session. * Cloud Recording must be enabled for recording controls. * The user using this API must either be the host or alternative host of the session.

15. videosdk-sessions-{session Id} - Update session status

PUT {{baseUrl}}/videosdk/sessions/:sessionId/status

Use this API to update a session's status.

Rate Limit Label: Light

Prerequisites: * A Video SDK account

16. videosdk-sessions - List sessions

GET {{baseUrl}}/videosdk/sessions?type=live&from=2021-10-11&to=2021-10-11&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82

Use this API to display the total live or past sessions that occurred during a specified period of time. You can specify a monthly date range for this data using the from and to query parameters. The month should fall within the last six months.

The overview response displays whether features such as audio, video, screensharing, and recording were used during the session.

Rate Limit Label: Resource-intensive

Prerequisites: * A Video SDK account

17. videosdk-report - Get daily usage report

GET {{baseUrl}}/videosdk/report/daily?year=&month=

Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of sessions, users, and session minutes.
Prerequisites
* A Video SDK account.

Rate Limit Label: Heavy

18. videosdk-report - Get telephone report

GET {{baseUrl}}/videosdk/report/telephone?from=2021-10-11&to=2021-10-11&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82&type=&query_date_type=

The telephone report allows you to view who dialed into sessions via phone (Audio Conferencing or SIP Connected Audio), which number they dialed into, and other details. Use this API to get the telephone report for a specified period of time.

Prerequisites
* A Video SDK account.

Rate Limit Label: Heavy

19. videosdk-report - Get cloud recording usage report

GET {{baseUrl}}/videosdk/report/cloud_recording?from=2021-10-11&to=2021-10-11

Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports for up to 6 months prior to the current date. The date gap between from and to dates should be smaller or equal to 30 days.

Prerequisites
* A Video SDK account.

Rate Limit Label: Heavy

20. videosdk-report - Get operation logs report

GET {{baseUrl}}/videosdk/report/operationlogs?from=2021-10-11&to=2021-10-11&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82&category_type=

The Operations Logs report allows you to audit admin and user activity, such as changing account settings, and deleting recordings.
Use this API to retrieve operation logs report for a specified period of time.

Prerequisites
* A Video SDK account.

Rate Limit Label: Heavy

21. videosdk - List recordings of an account

GET {{baseUrl}}/videosdk/recordings?page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82&trash=false&trash_type=session_recordings&from=2021-10-11&to=2021-12-11

List [Video SDK Cloud Recordings] available on an Account.

To access a password protected cloud recording, add an access_token parameter to the download URL and provide JWT as the value of the access_token.

Rate Limit Label: Medium