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

YAMLJSON

version: 1.0.0
sections:
  main:
    - join_room:
        name: my_room