join_room

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

str | NoneDefaults to None

URL to receive room status webhooks.

Returns

dict — Server response confirming the join.

Example

from signalwire.relay import RelayClient
client = RelayClient(
    project="your-project-id",
    token="your-api-token",
    contexts=["default"],
)
@client.on_call
async def handle_call(call):
    await call.answer()
    # Join a room
    await call.join_room("meeting-room-1")
    # The call is now in the room until leave_room() or hangup
client.run()