List room recordings

GET

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

GET

/api/video/room_recordings

curl https://{your_space_name}.signalwire.com/api/video/room_recordings \
     -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",
      "room_session_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
      "status": "completed",
      "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"
    }
  ]
}

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.

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)

Query parameters

media_ttlintegerOptional>=0

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

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 room recordings.

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error