join_room | SignalWire

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

Use leave_room() to leave the room.

Parameters

name

strRequired

Room name to join.

status_url

Optional[str]

URL to receive room status webhooks.

Returns

dict — Server response confirming the join.

Example

1 from signalwire.relay import RelayClient
2 
3 client = RelayClient(
4     project="your-project-id",
5     token="your-api-token",
6     host="your-space.signalwire.com",
7     contexts=["default"],
8 )
9 
10 @client.on_call
11 async def handle_call(call):
12     await call.answer()
13 
14     # Join a room
15     await call.join_room("meeting-room-1")
16 
17     # The call is now in the room until leave_room() or hangup
18 
19 client.run()