Running Contexts · Zoom Apps SDK · anthropics/knowledge-work-plugins · Skills Docs

Running Contexts · Zoom Apps SDK · anthropics/knowledge-work-plugins · Skills Docs

const configResponse = await zoomSdk.config({
  capabilities: ['getMeetingContext', 'getUserContext', ...],
  version: '0.16'
});

console.log(configResponse.runningContext);
// 'inMeeting' | 'inMainClient' | 'inWebinar' | 'inImmersive' | ...

Context	Surface	Meeting APIs	User APIs	Layers APIs	Notes
`inMeeting`	Meeting sidebar	Yes	Yes	Yes	Most common context
`inMainClient`	Main client panel	No	Yes	No	Home tab, no meeting running
`inWebinar`	Webinar sidebar	Yes	Yes	Yes	Host/panelist initially
`inImmersive`	Layers full-screen	Limited	Yes	Yes	After runRenderingContext
`inCamera`	Camera mode	Limited	Yes	Camera only	Virtual camera overlay
`inCollaborate`	Collaborate mode	Yes	Yes	No	Shared state context
`inPhone`	Zoom Phone	No	Yes	No	Phone call app surface
`inChat`	Team Chat	No	Yes	No	Chat sidebar

if (configResponse.runningContext === 'inMeeting') {
  const meeting = await zoomSdk.getMeetingContext();
  console.log('Meeting ID:', meeting.meetingID);
  console.log('Topic:', meeting.meetingTopic);

  const user = await zoomSdk.getUserContext();
  console.log('Name:', user.screenName);
  console.log('Role:', user.role); // 'host' | 'coHost' | 'attendee'
}

if (configResponse.runningContext === 'inMainClient') {
  // NO meeting APIs available - getMeetingContext() will fail
  const user = await zoomSdk.getUserContext();
  console.log('Name:', user.screenName);

  // Can still use connect() to sync with meeting instance later
}

if (configResponse.runningContext === 'inWebinar') {
  const user = await zoomSdk.getUserContext();
  // role: 'host' | 'panelist' | 'attendee'
  if (user.role === 'attendee') {
    // Limited functionality for attendees
  }
}

// Both instances call connect()
await zoomSdk.connect();

// Listen for connection
zoomSdk.addEventListener('onConnect', (event) => {
  console.log('Connected to other instance');
});

// Send data to other instance
await zoomSdk.postMessage({ type: 'settings', data: mySettings });

// Receive data from other instance
zoomSdk.addEventListener('onMessage', (event) => {
  const { type, data } = JSON.parse(event.payload);
  if (type === 'settings') {
    applySettings(data);
  }
});

Main Client Instance              Meeting Instance
─────────────────────             ─────────────────
User configures settings    -->   connect() + listen
Store in state              -->   onConnect fires
                                  postMessage('getSettings')
onMessage('getSettings')    -->
postMessage(settings)       -->   onMessage(settings)
                                  Apply settings to meeting

import zoomSdk from '@zoom/appssdk';

async function init() {
  const config = await zoomSdk.config({
    capabilities: [
      'getMeetingContext', 'getUserContext', 'getRunningContext',
      'connect', 'postMessage', 'onConnect', 'onMessage',
      'shareApp', 'runRenderingContext'
    ],
    version: '0.16'
  });

  switch (config.runningContext) {
    case 'inMeeting':
    case 'inWebinar':
      initMeetingUI();
      break;
    case 'inMainClient':
      initDashboardUI();
      break;
    case 'inImmersive':
    case 'inCamera':
      initLayersUI();
      break;
    default:
      initFallbackUI();
  }
}

const { supportedApis } = await zoomSdk.getSupportedJsApis();

if (supportedApis.includes('authorize')) {
  // In-Client OAuth is available
  showAuthButton();
}

if (supportedApis.includes('runRenderingContext')) {
  // Layers API is available
  showLayersButton();
}