join_room

View as MarkdownOpen in Claude

Join a RELAY room using SWML. Rooms enable multi-party communication and collaboration between participants.

Parameters

name
strRequired

Name of the room to join.

Returns

FunctionResult — self, for chaining.

Example

1from signalwire import AgentBase
2from signalwire import FunctionResult
3
4agent = AgentBase(name="my-agent", route="/agent")
5agent.set_prompt_text("You are a helpful assistant.")
6
7@agent.tool(name="join_support_room", description="Join the support room")
8def join_support_room(args, raw_data):
9 return (
10 FunctionResult("Connecting to the support room.")
11 .join_room(name="support-room-1")
12 )
13
14agent.serve()