Logo
Zoom Public API Documentation

videosdk-sessions-{session Id}

Number of APIs: 3


1. 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



2. 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.



3. 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



ENDPOINTS