List video conferences

GET

https://{your_space_name}.signalwire.com/api/video/conferences

GET

/api/video/conferences

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

{
  "links": {
    "self": "https://example.signalwire.com/api/video/rooms?page=2",
    "first": "https://example.signalwire.com/api/video/rooms?page=1",
    "next": "https://example.signalwire.com/api/video/rooms?page=3",
    "prev": "https://example.signalwire.com/api/video/rooms?page=1"
  },
  "data": [
    {
      "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
      "name": "my_conference",
      "display_name": "My Conference's Name",
      "description": "This conference will be used for full company all hands meetings",
      "join_from": "2022-01-01T00:00:00Z",
      "join_until": "2022-12-31T23:59:59Z",
      "quality": "720p",
      "layout": "grid-responsive",
      "size": "medium",
      "record_on_start": false,
      "tone_on_entry_and_exit": true,
      "user_join_video_off": false,
      "room_join_video_off": false,
      "enable_chat": true,
      "enable_room_previews": false,
      "dark_primary": "#044EF4",
      "dark_background": "#FFFFFF",
      "dark_foreground": "#1D2127",
      "dark_success": "#17BB58",
      "dark_negative": "#F42C50",
      "light_primary": "#044EF4",
      "light_background": "#FFFFFF",
      "light_foreground": "#1D2127",
      "light_success": "#17BB58",
      "light_negative": "#F42C50",
      "meta": {},
      "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
      }
    }
  ]
}

Lists the project’s managed Video Conferences. These configurations provide hosted guest and moderator access and define when each conference can be joined. Use Get video conference when you already have the conference ID.

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.

Lists the project's managed Video Conferences. These configurations provide hosted guest and moderator access and define when each conference can be joined. Use [Get video conference](/docs/apis/rest/video/video-conferences/get-video-conference) when you already have the conference ID. #### 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) ```

Query parameters

starts_afterstringOptional

Return conferences with a join_from time on or after this timestamp. Accepts RFC 3339 datetime or Unix timestamp.

ends_beforestringOptional

Return conferences with a join_until time on or before this timestamp. Accepts RFC 3339 datetime or Unix timestamp.

include_active_sessionbooleanOptional

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

page_numberintegerOptional>=0Defaults to 0

Page number to return. Requires page_token for values greater than 0.

page_sizeintegerOptional1-1000Defaults to 50

Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.

page_tokenstringOptional

Token for cursor-based pagination. Required when page_number is greater than 0.

Response

The request has succeeded.

linksobject

Pagination links.

datalist of objects

List of conferences.

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error