Sign in
Room Recordings

List room recordings

Lists recordings produced by the project's Video Rooms across sessions. Returned media links use the requested media_ttl lifetime. Use List room session recordings when you already know the Room Session.

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.

get/api/video/room_recordings

Query parameters

media_ttlinteger

Generated media links will be valid for this many seconds. Default is 900 (15 minutes).

page_numberinteger

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

page_sizeinteger

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

page_tokenstring

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

Response

The request has succeeded.

Example response

{
  "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": [
    {
      "started_at": "2022-01-01T10:00:00Z",
      "finished_at": "2022-01-01T11:00:00Z",
      "duration": 120,
      "size_in_bytes": 20971520,
      "format": "video/mp4",
      "cost_in_dollars": 0.05,
      "uri": "https://files.signalwire.com/temporary/link/to/the/recording/file",
      "created_at": "2022-01-01T10:00:00Z",
      "updated_at": "2022-01-01T11:00:00Z"
    }
  ]
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.