List conference rooms

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/conference_rooms

GET

/api/fabric/resources/conference_rooms

curl https://{your_space_name}.signalwire.com/api/fabric/resources/conference_rooms \
     -u "<project_id>:<api_token>"

{
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&type=conference_room",
    "first": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&type=conference_room",
    "next": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=1&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad&type=conference_room",
    "prev": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad&type=conference_room"
  },
  "data": [
    {
      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
      "display_name": "Reception",
      "type": "video_room",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z",
      "conference_room": {
        "id": "1bd571e4-5ea4-4a70-a3c8-2bab5d20e754",
        "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",
        "remove_after_seconds_elapsed": 1,
        "layout": "grid-responsive",
        "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"
        },
        "prioritize_handraise": false
      }
    }
  ]
}

Returns the project’s Fabric Conference Room resources. Use it to discover programmable video rooms that can be reached through resource addresses and used in call routing. Use Video Conferences for managed conferences with hosted guest and moderator access, or Video Rooms for SDK-based room configurations.

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.

Returns the project's Fabric Conference Room resources. Use it to discover programmable video rooms that can be reached through resource addresses and used in call routing. Use [Video Conferences](/docs/apis/rest/video/video-conferences/list-video-conferences) for managed conferences with hosted guest and moderator access, or [Video Rooms](/docs/apis/rest/video/rooms/list-rooms) for SDK-based room configurations. #### 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](/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) ```

Response

The request has succeeded.

linksobject

Object containing pagination links

datalist of objects

An array of objects containing the Conference Room data

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error