Get room by name

GET

https://{your_space_name}.signalwire.com/api/video/rooms/:name

GET

/api/video/rooms/:name

$ curl https://{your_space_name}.signalwire.com/api/video/rooms/name \
>      -u "<project_id>:<api_token>"

1 {
2   "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
3   "name": "my_room",
4   "display_name": "My Room's Name",
5   "description": "This room will be used for full company all hands meetings",
6   "max_members": 20,
7   "quality": "720p",
8   "fps": 20,
9   "join_from": "2022-01-01T00:00:00Z",
10   "join_until": "2022-12-31T23:59:59Z",
11   "remove_at": "2022-12-31T23:59:59Z",
12   "remove_after_seconds_elapsed": 120,
13   "layout": "grid-responsive",
14   "record_on_start": false,
15   "tone_on_entry_and_exit": true,
16   "room_join_video_off": false,
17   "user_join_video_off": false,
18   "enable_room_previews": false,
19   "sync_audio_video": true,
20   "meta": {},
21   "prioritize_handraise": false,
22   "created_at": "2022-01-01T10:00:00Z",
23   "updated_at": "2022-01-01T11:00:00Z",
24   "active_session": {
25     "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
26     "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
27     "name": "my_example_room",
28     "display_name": "My Room's Name",
29     "join_from": "2022-01-01T00:00:00Z",
30     "join_until": "2022-12-31T23:59:59Z",
31     "remove_at": "2022-12-31T23:59:59Z",
32     "remove_after_seconds_elapsed": 120,
33     "layout": "grid-responsive",
34     "max_members": 20,
35     "fps": 20,
36     "quality": "720p",
37     "start_time": "2022-01-01T10:00:00Z",
38     "end_time": "2022-01-01T11:00:00Z",
39     "duration": 120,
40     "status": "completed",
41     "record_on_start": true,
42     "enable_room_previews": true,
43     "preview_url": "https://example.signalwire.com/api/video/room_sessions/c22d24f6-5a47-4597-9a23-c7d01e696b92/preview",
44     "audio_video_sync": true
45   }
46 }

Retrieves one Video Room configuration by its unique name. Use this operation when your application identifies rooms by the same stable name supplied at creation; use Get room when you have the generated room ID instead.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.

Learn more about API scopes.

Retrieves one Video Room configuration by its unique name. Use this operation when your application identifies rooms by the same stable name supplied at creation; use [Get room](/docs/apis/rest/video/rooms/get-room) when you have the generated room ID instead. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

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)

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

namestringRequired

Unique name of the room.

Query parameters

include_active_sessionbooleanOptional

Specifies whether or not to include information about the room’s active session (if any).

Response

The request has succeeded.

idstringformat: "uuid"

A unique identifier for the room.

namestring

A named unique identifier for the room.

display_namestring or null

Display name of the room.

descriptionstring or null

Description of the room.

max_membersinteger

The maximum number of members in the room at a time.

qualityenum

The room's resolution.

fpsinteger

Frames per second parameter of room video quality.

join_fromdatetime or null

Room does not accept new participants before this time.

join_untildatetime or null

Room stops accepting new participants at this time.

remove_atdatetime or null

Remove users from the room at this time.

remove_after_seconds_elapsedinteger or null

Remove users after they are in the room for N seconds.

layoutenum

The room's initial layout.

record_on_startboolean

Specifies whether to start recording a Room Session when one is started for this Room.

tone_on_entry_and_exitboolean

Whether a tone is played when participants enter or exit the room.

room_join_video_offboolean

Whether the room's video is turned off when participants join.

user_join_video_offboolean

Whether a user's video is turned off when they join the room.

enable_room_previewsboolean or null

Whether a video with a preview of the content of the room is to be generated.

sync_audio_videoboolean or null

Enable/disable jitter buffer audio-video sync.

metaobject or null

User-defined metadata for the room.

prioritize_handraiseboolean

Whether hand raises are prioritized in the room layout.

created_atdatetime

Timestamp when the room was created.

updated_atdatetime

Timestamp when the room was last updated.

active_sessionobjectOptional

Active session information for the room.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error