Generated banner for Build Zoom Meeting SDK App
Generated logo for Build Zoom Meeting SDK App

Build Zoom Meeting SDK App

OpenAIOfficialCreated by ZoomDistributed by OpenAI

  • Skill
  • Tool integration
  • Software development
  • MIT
  • No issues found

From the author

Use when using Meeting SDK.
— the description by Zoom

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a structured workflow for developers integrating the Zoom Meeting SDK into their applications. It covers the lifecycle of a meeting integration, from initial product validation and platform selection to implementation and debugging. It emphasizes the distinction between the Meeting SDK, which is designed for human-led meetings, and other Zoom SDKs, while providing guidance on handling signatures, user identity, and meeting controls.

What it does

  • Guides developers through the integration of the Zoom Meeting SDK for web, mobile, and desktop platforms.
  • Provides a systematic workflow for joining and starting meetings.
  • Offers troubleshooting strategies for common issues like signature generation and permission errors.
  • Includes references for platform-specific implementations and AI Companion feature management.
  • Helps validate meeting parameters such as meeting numbers, passwords, and ZAK tokens.

When to use it

  • When you need to embed real Zoom meetings into your application.
  • When you are setting up a new Zoom Meeting SDK project for web, Android, iOS, or desktop.
  • When you encounter errors during the meeting join flow or signature validation.
  • When you need to manage AI Companion features within an embedded meeting context.

Advantages

  • Provides a clear, step-by-step path for successful SDK integration.
  • Centralizes access to platform-specific documentation and troubleshooting resources.
  • Helps distinguish between different Zoom SDK capabilities to ensure the right tool is used.
  • Includes a dedicated signature playbook to resolve common authentication failures.

Usage examples

“How do I start integrating the Zoom Meeting SDK for an Android app?”
The agent will guide you through verifying your environment, choosing the default UI for initial testing, and using the Android-specific reference pointers to resolve dependencies.
“I am getting an invalid signature error when trying to join a meeting.”
The agent will direct you to the signature playbook to verify your SDK signature generation logic and parameter matching.
“Can I use the Meeting SDK to build an automated AI notetaker bot?”
The agent will clarify that the Meeting SDK is for human use cases only and recommend using rtms for automated AI processing.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/openai/build-zoom-meeting-sdk-app/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip build-zoom-meeting-sdk-app.zip -d .agents/skills

Documentation by Zoom

Build Zoom Meeting SDK App

Use this skill when the user needs to join, start, or embed real Zoom meetings. If the user wants a fully custom non-meeting video experience, route to build-zoom-video-sdk-app.

Workflow

  1. Confirm product fit: Meeting SDK joins real Zoom meetings; Video SDK creates custom sessions; Zoom Apps SDK runs inside the Zoom client.

  2. Choose the target platform: web, Android, iOS, macOS, Windows, Electron, React Native, Unreal, or Linux bot.

  3. Validate the join or start path: meeting number, password, SDK signature, role, ZAK when hosting, waiting room behavior, and user identity.

  4. Implement the smallest join flow first, then add meeting controls, custom UI, raw data, recording, or bot behavior.

  5. Debug by isolating signature generation, SDK version, platform permissions, meeting settings, waiting room, raw data entitlement, and network constraints.

References

Files

references/bot-authentication.md

Bot Authentication - JWT, ZAK, and OBF Tokens

Understanding the different token types for Meeting SDK authentication, especially for bots joining meetings.

Overview

Meeting SDK authentication involves multiple token types that serve different purposes. This guide clarifies the confusion between JWT signatures, ZAK tokens, and OBF tokens.

Token Types Summary

TokenPurposeAlways Required?Deprecated?
JWT SignatureInitialize/authenticate Meeting SDKYesNo
ZAK TokenAuthenticate as a Zoom userNo (situational)No
OBF TokenJoin external meetings with user attributionNo (required Feb 2026)No

Common Confusion

JWT App Type vs JWT Signature

This is the #1 source of confusion.

TermWhat It IsStatus
JWT App TypeA Zoom app type for REST API authenticationDeprecated (migrated to Server-to-Server OAuth)
JWT SignatureA token generated using SDK credentials to authenticate Meeting SDKStill required and NOT deprecated

Key Point: The deprecation of JWT App Type does NOT affect Meeting SDK. You still need JWT signatures for SDK authentication.


1. JWT Signature (Always Required)

What Is It?

A JWT (JSON Web Token) signature authenticates your application to use the Meeting SDK. Generated server-side using your SDK Client ID and Client Secret.

When to Use

Always. Every Meeting SDK join requires a JWT signature.

How to Generate
// Server-side (Node.js)
const KJUR = require('jsrsasign');

function generateSignature(sdkKey, sdkSecret, meetingNumber, role) {
  const iat = Math.round(Date.now() / 1000) - 30;  // 30 seconds ago
  const exp = iat + 60 * 60 * 2;                    // 2 hours from iat

  const payload = {
    sdkKey: sdkKey,        // Your SDK Client ID
    mn: meetingNumber,     // Meeting number to join
    role: role,            // 0 = participant, 1 = host
    iat: iat,
    exp: exp,
    tokenExp: exp
  };

  const header = { alg: 'HS256', typ: 'JWT' };

  return KJUR.jws.JWS.sign('HS256',
    JSON.stringify(header),
    JSON.stringify(payload),
    sdkSecret              // Your SDK Client Secret
  );
}
Best Practice: Short-Lived Tokens
// Generate token just before joining
const iat = Math.floor(Date.now() / 1000) - 7200;  // 2 hours in past
const exp = Math.floor(Date.now() / 1000) + 10;    // 10 seconds from now

// Why this works:
// - exp is short-lived (security)
// - exp - iat >= 2 hours (Zoom requirement)
// - Token generated right before use
Role Values
RoleValueDescription
Participant0Join as attendee
Host1Join as host (requires being meeting owner or having host key)

2. ZAK Token (Zoom Access Key)

What Is It?

A short-lived credential that proves your bot/app is authenticated as a specific Zoom user. Generated via the Zoom REST API.

When to Use
ScenarioZAK Required?
Meeting has "Only Authenticated Users Can Join" enabledYes
Starting a meeting as the host (when host not present)Yes (host's ZAK)
Changing bot's profile picture to match a userYes
Regular meeting joinNo
How to Get ZAK Token

Step 1: Get OAuth Access Token

curl -X POST "https://zoom.us/oauth/token" \
  -H "Authorization: Basic {BASE64(client_id:client_secret)}" \
  -d "grant_type=authorization_code&code={auth_code}&redirect_uri={redirect_uri}"

Step 2: Generate ZAK Token

curl -X GET "https://api.zoom.us/v2/users/me/token?type=zak&ttl=7200" \
  -H "Authorization: Bearer {access_token}"

Response:

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}
Required OAuth Scope
user:read:zak
Using ZAK in SDK Join
// Web SDK
ZoomMtg.join({
  signature: signature,      // JWT signature (always required)
  sdkKey: clientId,
  meetingNumber: meetingNumber,
  passWord: password,
  userName: "Meeting Bot",
  zak: zakToken,             // ZAK token for authenticated join
  success: (success) => console.log('Joined'),
  error: (error) => console.error(error)
});
Key Properties
  • Short-lived: Configurable TTL (typically 1-2 hours)

  • Any ZAK works: Doesn't need to be from a meeting participant

  • No concurrency limit: One service account can generate unlimited tokens

  • Expiry checked at join: If already in meeting, bot stays connected even if ZAK expires

Common Mistake

Wrong: Thinking ZAK must be from a meeting participant.

Right: Any Zoom account's ZAK satisfies "Only Authenticated Users" requirement. Create one service account (e.g., [email protected]) for all your bots.


3. OBF Token (On-Behalf-Of Token)

What Is It?

A new credential that ties your bot to a specific user who is present in the meeting. Required for external meetings starting February 23, 2026.

Why Introduced?

Zoom introduced OBF tokens for accountability and transparency. It makes clear that an SDK app belongs to a specific person in the meeting.

When to Use
DateExternal Meeting Requirement
Before Feb 23, 2026ZAK or OBF (optional)
After Feb 23, 2026ZAK or OBF required
Critical Difference: OBF vs ZAK
AspectZAK TokenOBF Token
User presence requiredNoYes - user MUST be in meeting
Bot disconnectionStays if token owner leavesImmediately disconnected if user leaves
Meeting scopeAny meetingSpecific meeting ID only
AttributionGeneric authenticationTied to specific attending user
How to Get OBF Token

Step 1: Get OAuth Access Token (same as ZAK)

Step 2: Generate OBF Token

curl -X GET "https://api.zoom.us/v2/users/me/token?type=onbehalf&meeting_id={meeting_id}" \
  -H "Authorization: Bearer {access_token}"

Response:

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}
Required OAuth Scope
user:read:token
Using OBF in SDK Join
// Web SDK
ZoomMtg.join({
  signature: signature,      // JWT signature (always required)
  sdkKey: clientId,
  meetingNumber: meetingNumber,
  passWord: password,
  userName: "Meeting Bot",
  obfToken: obfToken,        // OBF token (NOT zak)
  success: (success) => console.log('Joined'),
  error: (error) => console.error(error)
});

Important: zak and obfToken are mutually exclusive. Use only one.

Handling Join Failures

If bot joins before authorizing user is in meeting:

// SDK v6.6.10+ returns specific error code
// MEETING_FAIL_AUTHORIZED_USER_NOT_INMEETING

async function joinWithRetry(joinOptions, maxRetries = 5) {
  for (let i = 0; i < maxRetries; i++) {
    try {
      await ZoomMtg.join(joinOptions);
      return; // Success
    } catch (error) {
      if (error.code === 'MEETING_FAIL_AUTHORIZED_USER_NOT_INMEETING') {
        console.log(`User not in meeting yet. Retry ${i + 1}/${maxRetries}`);
        await sleep(3000); // Wait 3 seconds
      } else {
        throw error; // Different error, don't retry
      }
    }
  }
  throw new Error('Max retries exceeded - user never joined meeting');
}
OBF Token Mapping

You must map users to their meetings:

  1. Zoom Meetings API: GET /users/{userId}/meetings

  2. Calendar integration: Parse meeting invites from Google Calendar/Outlook


Complete Bot Join Flow

Current (Pre-Feb 2026)
// 1. Generate JWT signature (always required)
const signature = await generateSignature(sdkKey, sdkSecret, meetingNumber, 0);

// 2. Optionally get ZAK for authenticated-only meetings
let zakToken = null;
if (meetingRequiresAuth) {
  zakToken = await getZAKToken(accessToken);
}

// 3. Join meeting
await ZoomMtg.join({
  signature: signature,
  sdkKey: sdkKey,
  meetingNumber: meetingNumber,
  passWord: password,
  userName: "Meeting Bot",
  zak: zakToken,  // Optional
});
Post-Feb 2026 (External Meetings)
// 1. Generate JWT signature (always required)
const signature = await generateSignature(sdkKey, sdkSecret, meetingNumber, 0);

// 2. For external meetings, get OBF token
const obfToken = await getOBFToken(accessToken, meetingNumber);

// 3. Wait for authorizing user to join (if using OBF)
// ... implement retry logic ...

// 4. Join meeting
await ZoomMtg.join({
  signature: signature,
  sdkKey: sdkKey,
  meetingNumber: meetingNumber,
  passWord: password,
  userName: "Meeting Bot",
  obfToken: obfToken,  // For external meetings
});

Linux Bot Implementation

For headless Linux bots, use the official sample:

# Clone sample repository
git clone [email protected]:zoom/meetingsdk-headless-linux-sample.git

# Configure (sample.config.toml)
[credentials]
client_id = "YOUR_CLIENT_ID"
client_secret = "YOUR_CLIENT_SECRET"

[meeting]
join_url = "https://zoom.us/j/123456789?pwd=xxx"
# OR
meeting_id = 123456789
password = "abc123"

# Optional tokens
zak_token = "..."   # For authenticated joins
obf_token = "..."   # For external meetings

# Run with Docker
docker compose up

Common Mistakes

MistakeRealityFix
JWT signatures are deprecatedOnly JWT App Type is deprecatedContinue using JWT signatures for SDK
ZAK must be from meeting participantAny Zoom account's ZAK worksUse single service account
Using both ZAK and OBF togetherThey're mutually exclusiveUse only one
Generating OBF before user in meetingOBF requires user presenceImplement retry logic
Development credentials for external meetingsDev credentials only work for your accountGet production credentials (4-6 week review)

Timeline

DateChange
NowJWT signatures required; ZAK optional
Nov 2025SDK v6.6.10 with OBF-specific error codes
Feb 23, 2026OBF or ZAK required for external meetings

OAuth Scopes Summary

TokenRequired Scope
ZAK Tokenuser:read:zak
OBF Tokenuser:read:token

Resources

Requirements and compatibility

Written for: OpenAI Codex

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Zoom
Publisher
OpenAI (Official)
Distributed by
OpenAI
Source
openai/plugins · plugins/zoom/skills/meeting-sdk · commit d420d13
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from plugins/zoom/LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Zoom or OpenAI.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download build-zoom-meeting-sdk-app.zip