joinRoom

Join a video/audio room. Rooms provide multi-party communication with additional features beyond conferences, including video support.

Use leaveRoom() to leave the room.

Parameters

name

stringRequired

Room name to join.

statusUrl

string | undefined

URL to receive room status webhooks.

Returns

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

Example

import { RelayClient } from '@signalwire/sdk';
const client = new RelayClient({
  project: process.env.SIGNALWIRE_PROJECT_ID!,
  token: process.env.SIGNALWIRE_API_TOKEN!,
  contexts: ['default']
});
client.onCall(async (call) => {
  await call.answer();
  // Join a room
  await call.joinRoom('meeting-room-1');
  // The call is now in the room until leaveRoom() or hangup
});
await client.run();