API Model for Zoom Service
Explore the Zoom meeting API model to understand key data entities, RESTful HTTP methods, and request-response formats. Learn how to manage sessions, set up media controllers, and handle real-time video streams using WebSocket upgrades in a scalable, efficient conferencing service. This lesson helps you design and optimize video conferencing APIs with practical Zoom scenarios and error handling considerations.
In this lesson, we will discuss the basic data entities, message formats, and API endpoints of the Zoom meeting service. This course has already addressed the technical aspects of some functional requirements, but other aspects are specific to this design. Therefore, we go into great detail on their request and response formats here. Let's first discuss the base URL of the Zoom API.
BaseURL
The Zoom meeting API is RESTful, and we can access it using different HTTP methods. The base URL for all these requests is as follows:
The full URL varies depending on the operation and the endpoint accessed. These operations and their associated endpoints are as follows:
The Zoom Meetings API is feature-rich, and we have broken it down into four categories. Each main category describes how we can perform basic operations on different resources using the aforementioned endpoints. Given below is a brief description of each category:
Overview of Endpoints
Category | Base Path | Description |
Managing meetings | /meetings |
|
Managing streams | /streams/mc/start/{startURL} /streams/mr/start/{startURL} ?{configId} |
|
Managing participants | /users/{meetingId} |
|
Managing recordings | /recordings/{meetingId} |
|
Note: The
mcandmrpaths in the table above are specific to media controllers (MC) and media routers (MR), respectively. They are responsible for creating media sessions and transferring media between different clients.
As we ...