join_room

Join a RELAY room.

Parameters

Name	Type	Description
name	string	Required name of the room to join.

Variables

Set by the method:

• join_room_result: (out) joined | failed

Examples

Joining a room

YAML

version: 1.0.0
sections:
  main:
    - join_room: my_room

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "join_room": "my_room"
      }
    ]
  }
}

Join a room and retry on failure

YAML

main:
  - label: join
    join_room:
      name: my_room
      result:
        case:
          joined:
          - hangup
        default:
        - goto:
            label: join
            max: 2
- hangup

JSON

"main": [
  { "label": "join",
    "join_room": {
      "name": "my_room",
      "result": {
        "case": {
          "joined": [ "hangup" ]
        },
        "default": [
          { "goto": { "label": "join", "max": 2 } }
        ]
      }
    }
  },
  "hangup"
]