Setting the file. One moment.
Subchapter 106.1
references/api-official.mdMarkdown2 KBView on GitHub
const cobrowse = new ZoomCobrowse(config);| Option | Type | Description |
|---|---|---|
sdkKey | string | Your SDK Key |
token | string | JWT token |
features.annotations | boolean | Enable annotations |
masking.selectors | array | CSS selectors to mask |
byop.enabled | boolean | Use custom PINs |
byop.pin | string | Custom PIN value |
Start a cobrowse session.
const session = await cobrowse.startSession();
// Returns: { pin: string, sessionId: string }End the current session.
await cobrowse.endSession();Pause screen sharing.
cobrowse.pause();Resume screen sharing.
cobrowse.resume();cobrowse.on('sessionStarted', (session) => {
// session.pin - PIN for agent to join
// session.sessionId - Unique session ID
});cobrowse.on('agentJoined', (agent) => {
// agent.name - Agent display name
// agent.userId - Agent user ID
});cobrowse.on('agentLeft', (agent) => {
// Agent disconnected
});cobrowse.on('sessionEnded', () => {
// Session terminated
});cobrowse.on('error', (error) => {
// error.code - Error code
// error.message - Error description
});