Meeting SDK usage policy
The Meeting SDK is designed for human use cases and does not support bots or AI notetakers. To build an AI notetaker application or access realtime media, use Zoom RTMS (Real-time media streams).
Requirements for external meeting access
To join meetings outside of your developer account, your app must:
- Be reviewed by Zoom.
- Authenticate with either a ZAK or On Behalf Of (OBF) token to attribute to a user in a meeting.
You can:
- Publish the approved app on the Zoom App Marketplace.
- Set your app to unlisted.
- Contact the Integrated Software Vendor (ISV) sales team for other options.
Prerequisites
See the Changelog for the latest supported Zoom Meeting SDK version. See Minimum SDK version for the minimum supported version.
- Use Visual Studio 2019 or newer. In this documentation, we use Visual Studio 2019 as our default IDE.
- When installing Visual Studio, install Desktop development with C++ workloads and the platform SDKs that you're building for.
- A JWT token to authenticate the app
- For individual users, a Zoom Access Key (ZAK) - send a GET request to the https://api.zoom.us/v2/users/{userId}/token with
type="zak"and pass it to the SDK with JoinMeetingParam4WithoutLogin 's userZAK or StartMeetingParamsWithoutLogin 's userZAK . - For apps that need to join the meeting as individual users, an OnBehalf Of (OBF) token - send a GET request to https://api.zoom.us/v2/users/{userId}/token with
type="onbehalf"and pass it to the SDK with JoinMeetingParam4WithoutLogin 's onBehalfToken . - To run the demo app, you'll need a meeting ID and passcode.
Note The Meeting SDK for Windows supports the same version as the Zoom client. See Zoom system requirements: Windows, macOS, Linux for details.
Note
Universal Windows Platform (UWP) is not supported.
Download the Meeting SDK for Windows
The Meeting SDK for Windows is available in C#, with or without a C# wrapper.
The C# wrapper is provided as a reference, and is not actively supported by Zoom.
If you don't already have at least one registered app, follow these steps to create an app and download the SDK files.
- Sign in to your developer account on the Zoom App Marketplace.
- Go to Zoom App Marketplace and select Sign in at the top right corner.
- Select the Developers link in the lower left corner, under the left hand navigation. If you don't see the link, verify that you have the correct permissions.
- On the Created apps page, select the blue plus sign in the upper left corner next to the word Developer.
- Select Build App > General app, and then select Create.
- Go to Features and select Embed.
- On the Embed page, enable Meeting SDK.
- Under the Meeting SDK section, configure the settings as appropriate for your app.
- To download the SDK files, select the platform Windows. This page displays available SDK versions for the selected platform, along with links to their corresponding release notes.
- Finally, select the Download button.
If you already have at least one registered app, follow these steps to download the SDK files using your existing app.
- Sign in to your developer account on the Zoom App Marketplace.
- Go to Zoom App Marketplace and select Sign in at the top right corner.
- Select the Developers link in the lower left corner, under the left hand navigation. This takes you to the Created Apps page. If you don't see the link, verify that you have the correct permissions.
- On the Created Apps page, select your SDK app to open its configuration pages.
- Go to Features and select Embed.
- On the Embed page, go to the Meeting SDK section.
- To download the SDK files, select the platform Windows. This page displays available SDK versions for the selected platform, along with links to their corresponding release notes.
- Finally, select the Download button.
Verify files
Your downloaded ZIP file should have these files and folders inside the zoom-sdk-windows-master folder.
├─ CHANGELOG.md
├─ README.md
├─── x64 (or x86)
├───── bin
├───── h (wrapperless version only)
├───── lib (wrapperless version only)
├───── zoom_sdk_c_sharp_wrap (c# wrapper version only)
├───── [demo] or [zoom_sdk_demo] <- Examples are inside
└─ version.txt
The wrapper DLL is located at zoom-c-sharp-wrapper-master\bin\zoom_sdk_dotnet_wrap.dll.
If you have different file structures or have missing files, download the SDK package from the App Marketplace again.
Get the version number
The downloaded Meeting SDK folder contains a file called version.txt. The number inside that text file is the version number of the downloaded SDK. Always include the version number when you post a question to get support from our premiere developer support or on our community forum .
Load the project
In Visual Studio, open the demo/sdk_demo_v2/sdk_demo_v2.sln file.
Use the included sdk_util.cpp high-level application to understand how to call the stack functions and register callbacks. The Zoom SDK runs as a DLL in the context of the calling application process.
In Visual Studio, open the zoom_sdk_demo/zoom_sdk_demo.csproj file.
Note: Starting from 4.6.15798.0403, all DLL files(.dll) and EXE files(.exe) cannot be re-signed. DO NOT re-sign or assign new digital signatures to those files as this could lead to fatal errors.