Generated banner for Zoom General
Generated logo for Zoom General

Zoom General

OpenAIOfficialCreated by ZoomDistributed by OpenAI

  • Skill
  • Tool integration
  • Automation and integrations
  • MIT
  • Medium risk

From the author

Use when comparing products.
— the description by Zoom

AutoGineer summary

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

Zoom General serves as a strategic starting point for developers and architects to navigate the Zoom ecosystem. It provides a structured workflow to classify integration requirements, identify the correct Zoom product surface (such as APIs, SDKs, or webhooks), and determine the necessary authentication model. By guiding users through a decision-making process, it ensures that developers select the right tool for their specific use case before routing to more specialized skills.

What it does

  • Classifies integration jobs based on desired outcomes like embedding meetings or automating resources.
  • Maps requirements to specific Zoom surfaces including REST APIs, WebSockets, and various SDKs.
  • Provides guidance on selecting the correct authentication and scope model for an integration.
  • Facilitates routing to specialized skills once the product context is established.
  • Offers comparative context for tasks that span multiple Zoom product boundaries.

When to use it

  • When you are in the early stages of planning a Zoom integration and need to choose the right app type.
  • When you need to compare different Zoom surfaces to determine which fits your technical requirements.
  • When a task involves multiple Zoom products and requires a high-level architectural approach.
  • When you need to confirm the correct authentication flow for a specific integration scenario.

Advantages

  • Prevents premature selection of tools by enforcing a structured classification process.
  • Clarifies the distinction between user-level OAuth, account-level OAuth, and SDK signatures.
  • Reduces complexity by routing users to narrow, specialized skills after initial planning.
  • Provides a clear decision matrix for choosing between General Apps, Server-to-Server OAuth, and Webhook Only apps.

Usage examples

“I want to build an app that automates meeting reports. Which Zoom app type should I use?”
The agent will guide you to classify the job as backend automation, leading to the recommendation of Server-to-Server OAuth for its lack of user interaction requirements.
“Should I use the Meeting SDK or the Video SDK for my project?”
The agent will help you compare the two based on your specific embedding needs and surface requirements, ensuring you choose the correct SDK for your use case.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/openai/zoom-general/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip zoom-general.zip -d .agents/skills

Documentation by Zoom

Zoom General

Use this skill for cross-product platform context after the user’s goal is understood. For first-step routing, prefer start, plan-zoom-product, or plan-zoom-integration.

Workflow

  1. Classify the job by outcome: embed meetings, custom video, automate resources, consume events, process media, use meeting intelligence, or publish a Marketplace app.

  2. Choose the Zoom surface that owns the behavior: REST API, webhooks, WebSockets, Meeting SDK, Video SDK, Zoom Apps SDK, Phone, Contact Center, Virtual Agent, Scribe, Rivet, or Cobrowse.

  3. Confirm auth and scope model before implementation; Zoom surfaces differ on user-level OAuth, account-level OAuth, and SDK signatures.

  4. Route to the narrow skill once the surface is chosen rather than keeping broad guidance in context.

  5. Use the preserved guide only when a task crosses product boundaries or needs detailed comparison tables.

References

Files

use-cases/ai-companion-integration.md

AI Companion Integration

Integrate with Zoom AI Companion for meeting summaries, transcripts, and AI-powered features.

Overview

Zoom AI Companion provides AI-powered features including:

  • Meeting summaries (auto-generated)

  • Meeting transcripts

  • Real-time transcription

  • Smart recording highlights

  • Conversation archives

What's Available via API

FeatureAPI AccessMethod
Meeting Summaries✅ YesREST API
Meeting Transcripts✅ YesREST API (Cloud Recording)
Real-Time Transcripts✅ YesRTMS SDK
AI Companion Panel⚠️ LimitedArchive only
Conversation Archives✅ YesREST API
AI Controls in Meeting✅ YesMeeting SDK

Skills Needed

Use CaseSkills
Get meeting summaries after meetingzoom-rest-api
Get meeting transcripts in deterministic backend pipelinezoom-rest-api + zoom-webhooks
Real-time transcript streamingrtms
Control AI features in embedded meetingszoom-meeting-sdk

Routing Modes

  • Use zoom-rest-api when you need deterministic backend jobs, strict retry behavior, and explicit endpoint control.

  • Use rtms when the workflow needs live transcript streaming.


Get Meeting Summary (REST API)

Endpoint
GET /v2/meetings/{meetingUUID}/meeting_summary
Prerequisites
  1. Meeting Summary feature enabled in account settings

  2. Server-to-Server OAuth app with admin scopes

  3. Meeting must have ended with summary generated

Example
// Get meeting summary
async function getMeetingSummary(meetingUUID) {
  // Double-encode UUID if it contains / or //
  const encodedUUID = meetingUUID.startsWith('/')
    ? encodeURIComponent(encodeURIComponent(meetingUUID))
    : encodeURIComponent(meetingUUID);

  const response = await fetch(
    `https://api.zoom.us/v2/meetings/${encodedUUID}/meeting_summary`,
    {
      headers: { 'Authorization': `Bearer ${accessToken}` }
    }
  );

  return response.json();
}

// Response example
{
  "meeting_uuid": "abc123...",
  "meeting_id": 12345678901,
  "meeting_topic": "Weekly Team Sync",
  "meeting_start_time": "2024-01-15T10:00:00Z",
  "meeting_end_time": "2024-01-15T10:45:00Z",
  "summary_start_time": "2024-01-15T10:00:00Z",
  "summary_end_time": "2024-01-15T10:45:00Z",
  "summary_content": {
    "summary": "The team discussed Q1 roadmap priorities...",
    "next_steps": [
      "John to finalize design specs by Friday",
      "Sarah to schedule customer interviews"
    ],
    "keywords": ["roadmap", "Q1", "design", "customers"]
  }
}
Important Notes
  • Admin role required: Standard users may not have access

  • Make app admin-managed: Resolves permission issues

  • UUID encoding: Double-encode UUIDs starting with /


Get Meeting Transcript (REST API)

Transcripts are accessed via the Cloud Recording API.

Endpoint
GET /v2/meetings/{meetingId}/recordings
Example
async function getMeetingTranscript(meetingId) {
  const response = await fetch(
    `https://api.zoom.us/v2/meetings/${meetingId}/recordings`,
    {
      headers: { 'Authorization': `Bearer ${accessToken}` }
    }
  );

  const data = await response.json();

  // Find transcript files
  const transcriptFiles = data.recording_files.filter(
    file => file.file_type === 'TRANSCRIPT' ||
            file.file_type === 'CC' ||
            file.file_type === 'SUMMARY'
  );

  // Download transcript
  for (const file of transcriptFiles) {
    const transcriptResponse = await fetch(file.download_url, {
      headers: { 'Authorization': `Bearer ${accessToken}` }
    });

    if (file.file_extension === 'VTT') {
      const vttContent = await transcriptResponse.text();
      console.log('VTT Transcript:', vttContent);
    } else if (file.file_extension === 'JSON') {
      const jsonContent = await transcriptResponse.json();
      console.log('JSON Transcript:', jsonContent);
    }
  }

  return transcriptFiles;
}
Transcript File Types
File TypeExtensionDescription
TRANSCRIPTVTT, JSONFull meeting transcript
CCVTTClosed captions
SUMMARYJSONAI-generated summary

Webhooks for AI Content

Listen for when AI content is ready:

// Webhook handler
app.post('/webhook', (req, res) => {
  const { event, payload } = req.body;

  switch (event) {
    case 'recording.transcript_completed':
      // Transcript is ready
      console.log('Transcript ready for meeting:', payload.object.uuid);
      fetchAndStoreTranscript(payload.object.uuid);
      break;

    case 'recording.completed':
      // Recording processing complete (may include summary)
      console.log('Recording ready:', payload.object.uuid);
      break;

    case 'meeting.ended':
      // Meeting ended - summary will be generated soon
      console.log('Meeting ended:', payload.object.uuid);
      break;
  }

  res.sendStatus(200);
});

Real-Time Transcripts (RTMS)

For live transcript streaming during meetings, use RTMS SDK.

Prerequisites
  • RTMS access approval from Zoom

  • Server infrastructure for WebSocket connections

Example
import { RTMSClient } from "@zoom/rtms";

const client = new RTMSClient({
  clientId: process.env.ZOOM_CLIENT_ID,
  clientSecret: process.env.ZOOM_CLIENT_SECRET,
  secretToken: process.env.ZOOM_SECRET_TOKEN
});

// Connect to meeting
await client.joinMeeting({
  meetingUuid: meetingUUID,
  streamId: streamId,
  serverUrl: "wss://rtms.zoom.us"
});

// Listen for transcript events
client.on('transcript', (data) => {
  console.log(`[${data.speakerName}]: ${data.text}`);

  // Process real-time transcript
  // - Send to AI for sentiment analysis
  // - Display live captions
  // - Log for compliance
});

See rtms skill for full RTMS documentation.


Meeting SDK - AI Companion Controls

Control AI Companion features in embedded meetings.

Web SDK
// Check if AI Companion is available
const aiCompanionStatus = ZoomMtg.getAICompanionStatus();

// AI Companion features are controlled by meeting settings
// The SDK respects account/meeting-level AI Companion settings
Native SDKs (Android/iOS/Desktop)

Use InMeetingAICompanionController:

// Android example
InMeetingAICompanionController aiController =
    ZoomSDK.getInstance().getInMeetingService().getInMeetingAICompanionController();

// Check AI Companion status
boolean isEnabled = aiController.isAICompanionEnabled();

// Get available features
AICompanionFeature[] features = aiController.getAvailableFeatures();
// Features: QUERY, SMART_SUMMARY, SMART_RECORDING
// iOS example
let aiController = MobileRTC.shared().getMeetingService()?.getInMeetingAICompanionController()

if let isEnabled = aiController?.isAICompanionEnabled() {
    print("AI Companion enabled: \(isEnabled)")
}
Feature Constants
FeatureDescription
QUERYAsk AI Companion questions
SMART_SUMMARYMeeting summary generation
SMART_RECORDINGSmart recording highlights

Conversation Archives API

Archive AI Companion panel conversations (new September 2025).

// Get conversation archives
async function getConversationArchives(userId) {
  const response = await fetch(
    `https://api.zoom.us/v2/users/${userId}/conversation_archive`,
    {
      headers: { 'Authorization': `Bearer ${accessToken}` }
    }
  );

  return response.json();
}

Common Integration Patterns

Pattern 1: Post-Meeting Summary Pipeline
// 1. Listen for meeting end
webhooks.on('meeting.ended', async (meeting) => {
  // 2. Wait for transcript to be ready (or use webhook)
  await delay(60000); // Processing time varies

  // 3. Fetch summary
  const summary = await getMeetingSummary(meeting.uuid);

  // 4. Store or distribute
  await saveSummaryToDatabase(summary);
  await sendSummaryToParticipants(meeting.participants, summary);
});
Pattern 2: Real-Time AI Processing
// Using RTMS for live processing
rtmsClient.on('transcript', async (data) => {
  // Send to your AI service for analysis
  const sentiment = await analyzesentiment(data.text);
  const actionItems = await extractActionItems(data.text);

  // Update live dashboard
  updateDashboard({ sentiment, actionItems });
});
Pattern 3: Compliance Archival
// Archive all AI-generated content
async function archiveMeetingAIContent(meetingId) {
  const [summary, transcript, archives] = await Promise.all([
    getMeetingSummary(meetingId),
    getMeetingTranscript(meetingId),
    getConversationArchives(meetingId)
  ]);

  await complianceStore.save({
    meetingId,
    summary,
    transcript,
    aiConversations: archives,
    archivedAt: new Date()
  });
}

Required Scopes

ScopeDescription
meeting:read:adminRead meeting data including summaries
recording:read:adminAccess recordings and transcripts
user:read:adminRead user data for archives

Limitations

LimitationNotes
AI Companion PanelMost panel features NOT available via API
Admin accessSome endpoints require admin role
Processing timeSummaries/transcripts not instant after meeting
RTMS approvalReal-time access requires Zoom approval
Bot restrictionsMeeting SDK does NOT support bots (use RTMS)

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

What our scanner noticed· Medium risk

  • Possible data-exfiltration endpoints
  • Instructions that use the network

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/general · 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 zoom-general.zip