Find a Room by Name
Find a room by name.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing
the word Basic followed by a space and a base64-encoded string of project_id:token.
The project ID will be used as the username and the API token as the password.
Example:
```
Authorization: Basic base64(project_id:token)
```
Path parameters
name
Unique name of the room.
Query parameters
include_active_session
Specifies whether or not to include information about the room’s active session (if any).
Response
The request has succeeded.
id
A unique identifier for the room.
name
A named unique identifier for the room.
display_name
Display name of the room.
description
Description of the room.
max_members
The maximum number of members in the room at a time.
quality
The room's resolution.
Allowed values:
fps
Frames per second parameter of room video quality.
join_from
Room does not accept new participants before this time.
join_until
Room stops accepting new participants at this time.
remove_at
Remove users from the room at this time.
remove_after_seconds_elapsed
Remove users after they are in the room for N seconds.
layout
The room's initial layout.
record_on_start
Specifies whether to start recording a Room Session when one is started for this Room.
tone_on_entry_and_exit
Whether a tone is played when participants enter or exit the room.
room_join_video_off
Whether the room's video is turned off when participants join.
user_join_video_off
Whether a user's video is turned off when they join the room.
enable_room_previews
Whether a video with a preview of the content of the room is to be generated.
sync_audio_video
Enable/disable jitter buffer audio-video sync.
meta
User-defined metadata for the room.
prioritize_handraise
Whether hand raises are prioritized in the room layout.
created_at
Timestamp when the room was created.
updated_at
Timestamp when the room was last updated.
active_session
Active session information for the room.
