Get room

GET

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

GET

/api/video/rooms/:id

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

{
  "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
  "name": "my_room",
  "display_name": "My Room's Name",
  "description": "This room will be used for full company all hands meetings",
  "max_members": 20,
  "quality": "720p",
  "fps": 20,
  "join_from": "2022-01-01T00:00:00Z",
  "join_until": "2022-12-31T23:59:59Z",
  "remove_at": "2022-12-31T23:59:59Z",
  "remove_after_seconds_elapsed": 120,
  "layout": "grid-responsive",
  "record_on_start": false,
  "tone_on_entry_and_exit": true,
  "room_join_video_off": false,
  "user_join_video_off": false,
  "enable_room_previews": false,
  "sync_audio_video": true,
  "meta": {},
  "prioritize_handraise": false,
  "created_at": "2022-01-01T10:00:00Z",
  "updated_at": "2022-01-01T11:00:00Z",
  "active_session": {
    "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
    "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
    "name": "my_example_room",
    "display_name": "My Room's Name",
    "join_from": "2022-01-01T00:00:00Z",
    "join_until": "2022-12-31T23:59:59Z",
    "remove_at": "2022-12-31T23:59:59Z",
    "remove_after_seconds_elapsed": 120,
    "layout": "grid-responsive",
    "max_members": 20,
    "fps": 20,
    "quality": "720p",
    "start_time": "2022-01-01T10:00:00Z",
    "end_time": "2022-01-01T11:00:00Z",
    "duration": 120,
    "status": "completed",
    "record_on_start": true,
    "enable_room_previews": true,
    "preview_url": "https://example.signalwire.com/api/video/room_sessions/c22d24f6-5a47-4597-9a23-c7d01e696b92/preview",
    "audio_video_sync": true
  }
}

Retrieves one Video Room by ID so you can inspect its configuration and current activity. Use Get room by name when your application holds the room’s unique name 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 by ID so you can inspect its configuration and current activity. Use [Get room by name](/docs/apis/rest/video/rooms/get-room-by-name) when your application holds the room's unique name 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

idstringRequiredformat: "uuid"

Unique ID 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