List a Room Session's Recordings

GET 
/room_sessions/:id/recordings

A list of Room Recordings for a particular Room Session.

Permissions

The API token must include the following scopes: Video.

Request

Path Parameters

id uuidrequired

Unique ID of the Room Session

Query Parameters

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

Responses

200

OK

application/json

Schema

Schema

links

object

self string

first string

next string

prev string

data

object[]

Array [

id uuid

Unique ID of the Room Recording

room_session_id uuid

Unique ID of the Room Session the Room Recording was made in.

status string

started_at date-time

Timestamp of when the Room Recording started.

finished_at date-time

Timestamp of when the Room Recording stopped.

duration integer

The length of the Room Recording in seconds.

size_in_bytes integer

The number of bytes of the Room Recording file.

format string

The MIME type of the Room Recording file.

uri string

A temporary URL for accessing your recording file. This URL, by default, is only valid for 15 minutes.

created_at date-time

updated_at date-time

]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "room_session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "completed",
      "started_at": "2024-07-29T15:51:28.071Z",
      "finished_at": "2024-07-29T15:51:28.071Z",
      "duration": 120,
      "size_in_bytes": 20971520,
      "format": "video/mp4",
      "uri": "https://files.signalwire.com/temporary/link/to/the/recording/file",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}

Loading...