> This page is for SWML.

> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# join_room

> Join a Relay Room Session.

Join a Relay room. If the room doesn't exist, it creates a new room.

**`join_room`** `object` — required

An object that accepts the following properties.

---

## **Properties**

**`join_room.name`** `string` — required

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

You can create a room via out REST API [here](/docs/apis/rest/video/rooms/create-room)

---

## **Variables**

Set by the method:

* **join\_room\_result:** (out) `joined` | `failed`

## **Examples**

### Joining a room

#### YAML

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

#### JSON

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