join_room

Join a Relay room. If the call is an unanswered inbound call, the method first tries to answer it. If the room doesn’t exist, it creates a new room. A room created this way is set to be deleted after its room sessions end; an existing room keeps its own settings.

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_-. The room name, after variable expansion, can be at most 100 characters.

You can create a room via out REST API here

Variables

Set by the method:

join_room_result: (out) joined | failed
join_room_failed_reason: (out) A short diagnostic string describing why joining failed, for example locked or not found. Set only when the join fails and a reason is available, so it isn’t set on every failure. It isn’t cleared on success, so a value from an earlier failed join can remain; check join_room_result first.

Examples

Joining a room

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