Build Zoom Meeting SDK App
AnthropicOfficialCreated by ZoomDistributed by Anthropic
- Skill
- Tool integration
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a comprehensive reference for developers embedding the Zoom Meeting SDK into their applications. It covers platform-specific implementation details, authentication flows, UI customization options, and critical security practices like server-side signature generation. It serves as a central hub for navigating the SDK's various platform-specific guides, troubleshooting runbooks, and official sample repositories.
What it does
- Provides implementation patterns for embedding Zoom meetings in web, mobile, and desktop apps.
- Outlines the mandatory server-side process for generating secure SDK signatures.
- Distinguishes between Client View and Component View for web integrations.
- Offers guidance on handling platform-specific SDK behaviors and common UI conflicts.
- Links to specialized documentation for Android, iOS, macOS, Windows, and Linux environments.
- Includes troubleshooting resources for common join, auth, and waiting room issues.
When to use it
- When you need to embed a live Zoom meeting experience directly into your application UI.
- When implementing programmatic meeting joins or bot-based meeting interactions.
- When troubleshooting SDK authentication, signature errors, or meeting join failures.
- When you need to determine the correct SDK view type (Client vs. Component) for your web project.
- When setting up development environments for specific platforms like Unreal, Electron, or mobile.
Advantages
- Centralizes complex documentation for multiple platforms into a single reference point.
- Enforces security best practices by mandating server-side signature generation.
- Provides clear architectural guidance to avoid common pitfalls like CSS conflicts.
- Facilitates rapid troubleshooting with dedicated runbooks and triage guides.
- Maintains clear separation between official Zoom UI and custom integration requirements.
Usage examples
- “How do I securely generate a signature for the Zoom Meeting SDK in Node.js?”
- The agent provides a server-side code example using jsrsasign to sign a JWT with your SDK Secret, ensuring credentials remain hidden from the client.
- “I am getting a CSS conflict where my app UI breaks when the Zoom meeting loads. How do I fix this?”
- The agent suggests scoping your CSS and provides specific CSS overrides to ensure the Zoom UI renders correctly without affecting your application shell.
- “What is the difference between Client View and Component View in the Web SDK?”
- The agent explains that Client View provides the full-page Zoom experience, while Component View allows for embedding the meeting within a specific div for a more integrated look.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/anthropics/build-zoom-meeting-sdk-app/downloadUnzip 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
Background reference for embedded Zoom meetings across web, mobile, desktop, and Linux bot environments. Prefer build-zoom-meeting-app or build-zoom-bot first, then route here for platform detail.
Zoom Meeting SDK
Embed the full Zoom meeting experience into web, mobile, desktop, and headless integrations.
Hard Routing Guardrail (Read First)
If the user asks to embed/join meetings inside their app UI, route to Meeting SDK implementation.
Do not switch to REST-only meeting link flow unless the user explicitly asks for meeting resource management or browser
join_urllinks.Meeting SDK join path requires SDK signature + SDK join call; REST
join_urlis not a Meeting SDK join payload.
Prerequisites
Zoom app with Meeting SDK credentials
SDK Key and Secret from Marketplace
Platform-specific development environment (Web, Android, iOS, macOS, Unreal, Electron, Linux, or Windows)
Need help with OAuth or signatures? See the zoom-oauth skill for authentication flows.
Need pre-join diagnostics on web? Use probe-sdk before Meeting SDK init/join to gate low-readiness devices/networks.
Start troubleshooting fast: Use the 5-Minute Runbook before deep debugging.
Quick Start (Web - Client View via CDN)
<script src="https://source.zoom.us/3.1.6/lib/vendor/react.min.js"></script>
<script src="https://source.zoom.us/3.1.6/lib/vendor/react-dom.min.js"></script>
<script src="https://source.zoom.us/3.1.6/lib/vendor/redux.min.js"></script>
<script src="https://source.zoom.us/3.1.6/lib/vendor/redux-thunk.min.js"></script>
<script src="https://source.zoom.us/3.1.6/lib/vendor/lodash.min.js"></script>
<script src="https://source.zoom.us/3.1.6/zoom-meeting-3.1.6.min.js"></script>
<script>
// CDN provides ZoomMtg (Client View - full page)
// For ZoomMtgEmbedded (Component View), use npm instead
ZoomMtg.preLoadWasm();
ZoomMtg.prepareWebSDK();
ZoomMtg.init({
leaveUrl: window.location.href,
patchJsMedia: true,
disableCORP: !window.crossOriginIsolated,
success: function() {
ZoomMtg.join({
sdkKey: 'YOUR_SDK_KEY',
signature: 'YOUR_SIGNATURE', // Generate server-side!
meetingNumber: 'MEETING_NUMBER',
userName: 'User Name',
passWord: '', // Note: camelCase with capital W
success: function(res) { console.log('Joined'); },
error: function(err) { console.error(err); }
});
},
error: function(err) { console.error(err); }
});
</script>Critical Notes (Web)
1. CDN vs npm - Different APIs!
| Distribution | Global Object | View Type | API Style |
|---|---|---|---|
CDN (zoom-meeting-{ver}.min.js) | ZoomMtg | Client View (full-page) | Callbacks |
npm (@zoom/meetingsdk) | ZoomMtgEmbedded | Component View (embeddable) | Promises |
2. Backend Required for Production
Never expose SDK Secret in client code. Generate signatures server-side:
// server.js (Node.js example)
const KJUR = require('jsrsasign');
app.post('/api/signature', (req, res) => {
const { meetingNumber, role } = req.body;
const iat = Math.floor(Date.now() / 1000) - 30;
const exp = iat + 60 * 60 * 2;
const header = { alg: 'HS256', typ: 'JWT' };
const payload = {
sdkKey: process.env.ZOOM_SDK_KEY,
mn: String(meetingNumber).replace(/\D/g, ''),
role: parseInt(role, 10),
iat, exp, tokenExp: exp
};
const signature = KJUR.jws.JWS.sign('HS256',
JSON.stringify(header),
JSON.stringify(payload),
process.env.ZOOM_SDK_SECRET
);
res.json({ signature, sdkKey: process.env.ZOOM_SDK_KEY });
});3. CSS Conflicts - Avoid Global Resets
Global * { margin: 0; } breaks Zoom's UI. Scope your styles:
/* BAD */
* { margin: 0; padding: 0; }
/* GOOD */
.your-app, .your-app * { box-sizing: border-box; }4. Client View Toolbar Cropping Fix
If toolbar falls off screen, scale down the Zoom UI:
#zmmtg-root {
position: fixed !important;
top: 0 !important;
left: 0 !important;
right: 0 !important;
bottom: 0 !important;
width: 100vw !important;
height: 100vh !important;
/* Critical for SPAs (React/Next/etc): ensure Zoom UI isn't behind your app shell/overlays. */
z-index: 9999 !important;
transform: scale(0.95) !important;
transform-origin: top center !important;
}5. Hide Your App When Meeting Starts
Client View takes over full page. Hide your UI:
// In ZoomMtg.init success callback:
document.documentElement.classList.add('meeting-active');
document.body.classList.add('meeting-active');body.meeting-active .your-app { display: none !important; }
body.meeting-active { background: #000 !important; }UI Options (Web)
Meeting SDK provides Zoom's UI with customization options:
| View | Description |
|---|---|
| Component View | Extractable, customizable UI - embed meeting in a div |
| Client View | Full-page Zoom UI experience |
Note: Unlike Video SDK where you build the UI from scratch, Meeting SDK uses Zoom's UI as the base with customization on top.
Key Concepts
| Concept | Description |
|---|---|
| SDK Key/Secret | Credentials from Marketplace |
| Signature | JWT signed with SDK Secret |
| Component View | Extractable, customizable UI (Web) |
| Client View | Full-page Zoom UI (Web) |
Detailed References
Platform Guides
android/SKILL.md - Android SDK (default/custom UI, join/start/auth lifecycle, mobile integration)
android/references/android-reference-map.md - Android API surface map and drift watchpoints
ios/SKILL.md - iOS SDK (default/custom UI, join/start/auth lifecycle, mobile integration)
ios/references/ios-reference-map.md - iOS API surface map and drift watchpoints
macos/SKILL.md - macOS SDK (desktop default/custom UI, service controllers, host flows)
macos/references/macos-reference-map.md - macOS API surface map and drift watchpoints
unreal/SKILL.md - Unreal Engine wrapper (C++/Blueprint wrapper behavior and SDK mapping)
unreal/references/unreal-reference-map.md - Unreal wrapper reference map and version-lag notes
references/android.md - Android pointer doc for fast routing from broad Meeting SDK queries
references/ios.md - iOS pointer doc for fast routing from broad Meeting SDK queries
references/macos.md - macOS pointer doc for fast routing from broad Meeting SDK queries
references/unreal.md - Unreal pointer doc for fast routing from broad Meeting SDK queries
linux/SKILL.md - Linux SDK headless bot skill entrypoint
linux/linux.md - Linux SDK (C++ headless bots, raw media access)
linux/references/linux-reference.md - Linux dependencies, Docker, troubleshooting
react-native/SKILL.md - React Native SDK (iOS/Android wrapper, join/start flows, bridge setup)
react-native/SKILL.md - React Native complete navigation
electron/SKILL.md - Electron SDK (desktop wrapper, auth/join flows, module controllers, raw data)
electron/SKILL.md - Electron complete navigation
windows/SKILL.md - Windows SDK (C++ desktop applications, raw media access)
windows/references/windows-reference.md - Windows dependencies, Visual Studio setup, troubleshooting
web/references/web.md - Web SDK (Component + Client View)
web/references/web-tracking-id.md - Tracking ID configuration
Features
references/authorization.md - SDK JWT generation
references/bot-authentication.md - ZAK vs OBF vs JWT tokens for bots
references/breakout-rooms.md - Programmatic breakout room management
references/ai-companion.md - AI Companion controls in meetings
references/webinars.md - Webinar SDK features
references/forum-top-questions.md - Common forum question patterns (what to cover)
references/triage-intake.md - What to ask first (turn vague reports into answers)
references/signature-playbook.md - Signature/root-cause playbook
references/multiple-meetings.md - Joining multiple meetings / multiple instances
references/troubleshooting.md - Common issues and solutions
Sample Repositories
Official (by Zoom)
| Type | Repository | Stars |
|---|---|---|
| Linux Headless | meetingsdk-headless-linux-sample | 4 |
| Linux Raw Data | meetingsdk-linux-raw-recording-sample | 0 |
| Web | meetingsdk-web-sample | 643 |
| Web NPM | meetingsdk-web | 324 |
| React | meetingsdk-react-sample | 177 |
| Auth | meetingsdk-auth-endpoint-sample | 124 |
| Angular | meetingsdk-angular-sample | 60 |
| Vue.js | meetingsdk-vuejs-sample | 42 |
Full list: See general/references/community-repos.md
Resources
Official docs: https://developers.zoom.us/docs/meeting-sdk/
Developer forum: https://devforum.zoom.us/
Environment Variables
See references/environment-variables.md for standardized
.envkeys and where to find each value.
Files
- ATTRIBUTION.mdAdded by AutoGineer993 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md2.6 KiB
- SKILL.md11.0 KiB
- references/ai-companion.md6.4 KiB
- references/android.md754 B
- references/authorization.md2.3 KiB
- references/bot-authentication.md10.5 KiB
- references/breakout-rooms.md11.8 KiB
- references/environment-variables.md1.4 KiB
- references/forum-top-questions.md3.9 KiB
- references/ios.md919 B
- references/macos.md599 B
- references/multiple-meetings.md965 B
- references/signature-playbook.md1.4 KiB
- references/triage-intake.md1.9 KiB
- references/troubleshooting.md4.1 KiB
- references/unreal.md732 B
- references/webinars.md7.9 KiB
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
| Token | Purpose | Always Required? | Deprecated? |
|---|---|---|---|
| JWT Signature | Initialize/authenticate Meeting SDK | Yes | No |
| ZAK Token | Authenticate as a Zoom user | No (situational) | No |
| OBF Token | Join external meetings with user attribution | No (required Feb 2026) | No |
Common Confusion
JWT App Type vs JWT Signature
This is the #1 source of confusion.
| Term | What It Is | Status |
|---|---|---|
| JWT App Type | A Zoom app type for REST API authentication | Deprecated (migrated to Server-to-Server OAuth) |
| JWT Signature | A token generated using SDK credentials to authenticate Meeting SDK | Still 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 useRole Values
| Role | Value | Description |
|---|---|---|
| Participant | 0 | Join as attendee |
| Host | 1 | Join 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
| Scenario | ZAK Required? |
|---|---|
| Meeting has "Only Authenticated Users Can Join" enabled | Yes |
| Starting a meeting as the host (when host not present) | Yes (host's ZAK) |
| Changing bot's profile picture to match a user | Yes |
| Regular meeting join | No |
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:zakUsing 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
| Date | External Meeting Requirement |
|---|---|
| Before Feb 23, 2026 | ZAK or OBF (optional) |
| After Feb 23, 2026 | ZAK or OBF required |
Critical Difference: OBF vs ZAK
| Aspect | ZAK Token | OBF Token |
|---|---|---|
| User presence required | No | Yes - user MUST be in meeting |
| Bot disconnection | Stays if token owner leaves | Immediately disconnected if user leaves |
| Meeting scope | Any meeting | Specific meeting ID only |
| Attribution | Generic authentication | Tied 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:tokenUsing 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:
Zoom Meetings API:
GET /users/{userId}/meetingsCalendar 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 upCommon Mistakes
| Mistake | Reality | Fix |
|---|---|---|
| JWT signatures are deprecated | Only JWT App Type is deprecated | Continue using JWT signatures for SDK |
| ZAK must be from meeting participant | Any Zoom account's ZAK works | Use single service account |
| Using both ZAK and OBF together | They're mutually exclusive | Use only one |
| Generating OBF before user in meeting | OBF requires user presence | Implement retry logic |
| Development credentials for external meetings | Dev credentials only work for your account | Get production credentials (4-6 week review) |
Timeline
| Date | Change |
|---|---|
| Now | JWT signatures required; ZAK optional |
| Nov 2025 | SDK v6.6.10 with OBF-specific error codes |
| Feb 23, 2026 | OBF or ZAK required for external meetings |
OAuth Scopes Summary
| Token | Required Scope |
|---|---|
| ZAK Token | user:read:zak |
| OBF Token | user:read:token |
Resources
Meeting SDK Auth: https://developers.zoom.us/docs/meeting-sdk/auth/
OBF Token Announcement: https://developers.zoom.us/blog/transition-to-obf-token-meetingsdk-apps/
Linux SDK Sample: https://github.com/zoom/meetingsdk-headless-linux-sample
Developer Forum: https://devforum.zoom.us/
Requirements and compatibility
Written for: Claude Code, Claude apps
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
- Anthropic (Official)
- Distributed by
- Anthropic
- Source
- anthropics/knowledge-work-plugins · partner-built/zoom-plugin/skills/meeting-sdk · commit e050c2e
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from partner-built/zoom-plugin/LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Zoom or Anthropic.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download build-zoom-meeting-sdk-app.zip