Conference Rooms

Get conference room

Retrieves one Fabric Conference Room by resource ID so you can inspect how the addressable room is configured. Use List conference rooms to discover IDs, or Get video conference for a managed hosted conference.

Permissions

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

Learn more about API scopes.

get/api/fabric/resources/conference_rooms/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/resources/conference_rooms/{id}
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a Conference Room.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

project_idstring uuid required

Universal Unique Identifier.

display_namestring required

Display name of the Conference Room Fabric Resource

type'video_room' required

Type of the Fabric Resource

created_atstring date-time required

Date and time when the resource was created.

updated_atstring date-time required

Date and time when the resource was updated.

Example response

{
  "display_name": "Reception",
  "type": "video_room",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "conference_room": {
    "name": "coffee_cafe",
    "description": "This room is for coffee, no shop talk",
    "display_name": "Reception",
    "max_members": 30,
    "quality": "1080p",
    "fps": 30,
    "join_from": "2024-05-06T12:20:00Z",
    "join_until": "2024-05-06T12:20:00Z",
    "remove_at": "2024-05-06T12:20:00Z",
    "record_on_start": true,
    "tone_on_entry_and_exit": true,
    "room_join_video_off": true,
    "user_join_video_off": true,
    "enable_room_previews": true,
    "sync_audio_video": true,
    "meta": {
      "foo": "bar"
    }
  }
}

Changes

No operation changes found yet. Some revisions have not been checked.