join_room

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

from signalwire import AgentBase
from signalwire import FunctionResult
agent = AgentBase(name="my-agent", route="/agent")
agent.set_prompt_text("You are a helpful assistant.")
@agent.tool(name="join_support_room", description="Join the support room")
def join_support_room(args, raw_data):
    return (
        FunctionResult("Connecting to the support room.")
        .join_room(name="support-room-1")
    )
agent.serve()