Skip to main content

Recording

Start recording

Recordings are saved in Eyesons cloud storage and can be downloaded from there.

POST /rooms/<access_key>/recording # start recording
RESPONSES 201 CREATED, 404 NOT FOUND, 405 METHOD NOT ALLOWED, 406 NOT ACCEPTABLE, 410 GONE
info

Direct URLs to downloads expire, so it's better store the recording identifier and fetch a valid resource link on demand.

Stop recording

DELETE /rooms/<access_key>/recording # stop recording
RESPONSES 200 OK, 404 NOT FOUND, 410 GONE

Retrieve recording

GET /recordings/<recording_id>
HEADERS Authorization
RESPONSES 200 OK, 404 NOT FOUND

Example Response

{
"id": "63ede57ff3e015000fbe1af5",
"created_at": 1609491600,
"duration": 1800, // duration in seconds
"links": {
"self": "https://api.eyeson.team/recordings/63ede57ff3e015000fbe1af5",
"download": "https://fs.eyeson.com/meetings/<key>.webm?..."
},
"user": {
"id": "63ede350b20526000f64376d",
"name": "Jane Doe",
"avatar": "https://myawesomeapp.com/images/avatar.png",
"guest": false,
"joined_at": "2021-01-01T09:00:00.000Z"
},
"room": {
"id": "63ede350b20526000f64376b",
"name": "eyeson room",
"ready": true,
"started_at": "2021-01-01T09:00:00.000Z",
"shutdown": false,
"sip": {
...
},
"guest_token": "gKsiVlrvkFyL3klk1wBHLlm3"
}
}

Retrieve list of all recordings of a certain room

GET /rooms/<room_id>/recordings
HEADERS Authorization
RESPONSES 200 OK, 403 UNAUTHORIZED, 404 NOT FOUND
ParametersTypeDescription
pageInteger (optional)Fetch next set of recordings (limit is 25)
started_atISO8601 Timestamp (optional)Filter for a certain room instance (compare to started_at in room response)

Delete recording

DELETE /recordings/<recording_id>
HEADERS Authorization
RESPONSES 200 OK, 404 NOT FOUND