For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
        • POSTCreate room
        • DELDelete room
        • GETGet room
        • GETGet room by name
        • GETList rooms
        • PUTUpdate room
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
CallingVideoRooms

Get room by name

|View as Markdown|Open in Claude|
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}

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.

Learn more about API scopes.

Was this page helpful?
Previous

List rooms

Next
Built with

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

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.
Allowed values:
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_sessionobject
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

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)