Get started with the Meeting SDK for macOS

Prerequisites#

See the Changelog for the latest supported Zoom Meeting SDK version. See Minimum SDK version for the minimum supported version.

To use the Meeting SDK 7.0.0 and later, you'll need to meet these requirements.

• Xcode , version 26 or later required.
• For the Intel package, set the target of your app project with Always embed Swift standard libraries to YES.
• A macOS device running 10.15 or later.
• Valid SDK credentials.
• 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 zak  or StartMeetingParamsWithoutLogin 's zak .
• 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.

The Meeting SDK for macOS does not support running in a sandbox environment.

Download the Meeting SDK for macOS#

Verify files#

The download includes SDK libraries - in the SampleApp/ZoomSDK folder - and a sample app - in the ZoomSDKSample folder.

1. In Xcode, add the files in the Plugin folder to the app's plugins and foundation.

2. Select your project and go to the Build Phases tab. Open Link Binary With Libraries and check that only these SDK files are present.

   • libcrypto.dylib
   • libjson.dylib
   • libminizip.dylib
   • Libssl.dylib
   • libcares.dylib
   • libzoombase_crypto_shared.dylib
   • ZoomSDK.framework
   • Cocoa.framework

   If you see other files in this location, remove them. If you are missing any files, download the SDK from the App Marketplace  again.

3. After adding the SDK files, go back to the Build Phases tab. Ensure that ZoomSDK.framework and all of the .dylib files are included under Link Binary With Libraries. Add all files to the Copy Files step with a Destination set to Frameworks. The listed SDK files should already be present under Link Binary With Libraries.

   • If there are additional phases containing the SDK files, such as Copy Bundle Resources, remove those SDK files from those phases.

Confirm that the SDK was correctly added to your project by importing it in any file.

import ZoomSDK

Initialize the Meeting SDK for macOS#

Complete these two steps to be able to use the Meeting SDK for macOS: Initialization and Authorization.

SDK initialization is done synchronously with an instance of ZoomSDKInitParams.

let zoomSdk = ZoomSDK.shared()
let initParams = ZoomSDKInitParams()
initParams.enableLog = true // Optional for debugging
zoomSdk.initSDK(with: initParams)
zoomSdk.zoomDomain = "zoom.us"

After initializing the SDK, you need to successfully authorize the SDK instance with your developer credentials.

if let authService = zoomSdk.getAuthService() {
    authService.delegate = self

    let authContext = ZoomSDKAuthContext()
    authContext.jwtToken = "" // Input your JWT
    authService.sdkAuth(authContext)
}

To determine whether auth was successful, ensure your class conforms to the ZoomSDKAuthDelegate protocol to listen for a result of ZoomSDKAuthError_Success:

extension AppDelegate : ZoomSDKAuthDelegate {
    func onZoomSDKAuthReturn(_ returnValue: ZoomSDKAuthError) {
        if (returnValue == ZoomSDKAuthError_Success) {
            // SDK auth was successful
        }
    }

    func onZoomAuthIdentityExpired() {

    }
}