leaveConference

View as MarkdownOpen in Claude

Leave an audio conference.

Parameters

conferenceId
stringRequired

The conference ID to leave.

Returns

Promise<Record<string, unknown>> — Server response confirming the leave.

Example

1import { RelayClient } from '@signalwire/sdk';
2
3const client = new RelayClient({
4 project: process.env.SIGNALWIRE_PROJECT_ID!,
5 token: process.env.SIGNALWIRE_TOKEN!,
6 contexts: ['default']
7});
8
9client.onCall(async (call) => {
10 await call.answer();
11
12 // Join a conference
13 const result = await call.joinConference('team-standup', { beep: 'onEnter' });
14
15 // Later, leave the conference
16 await call.leaveConference(result.conference_id as string);
17});
18
19await client.run();