REST ClientVideoVideoRoomSessions

list_recordings

View as MarkdownOpen in Claude

List recordings created during a room session.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the Room Session.

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

datalist of objectsRequired
List of room recordings.

Response 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": [
    {
      "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"
    }
  ]
}

Example

from signalwire.rest import RestClient
client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)
recordings = client.video.room_sessions.list_recordings("session-id")