For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
ReferenceGuides
ReferenceGuides
  • Core
    • Introduction to SWML
    • Expressions
    • Template functions
    • Variables
    • Errors
  • Calling
    • Overview
    • ai
    • amazon_bedrock
    • answer
    • cond
    • connect
    • denoise
    • detect_machine
    • enter_queue
    • execute
    • goto
    • hangup
    • join_conference
    • join_room
    • label
    • live_transcribe
    • live_translate
    • pay
    • play
    • prompt
    • receive_fax
    • record
    • record_call
    • request
    • return
    • send_digits
    • send_fax
    • send_sms
    • set
    • sip_refer
    • sleep
    • stop_denoise
    • stop_record_call
    • stop_tap
    • switch
    • tap
    • transfer
    • unset
    • user_event
  • Messaging
    • Overview
    • execute
    • goto
    • label
    • receive
    • reply
    • request
    • return
    • switch
    • transfer
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Properties
  • Variables
  • Examples
  • Joining a room
Calling

join_room

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

label

Next
Built with

Join a RELAY room. If the room doesn’t exist, it creates a new room.

join_room
objectRequired

An object that accepts the following properties.

Properties

join_room.name
stringRequired

Name of the room to join. Allowed characters: A-Z | a-z | 0-9_-

You can create a room via out REST API here

Variables

Set by the method:

  • join_room_result: (out) joined | failed

Examples

Joining a room

1version: 1.0.0
2sections:
3  main:
4    - join_room:
5        name: my_room