Recordings
Method |
Path |
Return Model |
Summary |
---|---|---|---|
GET |
List recordings that are complete. |
||
GET |
Get a stored recording's details. |
||
DELETE |
void |
Delete a stored recording. |
|
POST |
Copy a stored recording. |
||
GET |
List live recordings. |
||
DELETE |
void |
Stop a live recording and discard it. |
|
POST |
void |
Stop a live recording and store it. |
|
POST |
void |
Pause a live recording. |
|
DELETE |
void |
Unpause a live recording. |
|
POST |
void |
Mute a live recording. |
|
DELETE |
void |
Unmute a live recording. |
GET /recordings/stored
List recordings that are complete.
GET /recordings/stored/{recordingName}
Get a stored recording's details.
Path parameters
- recordingName: string - The name of the recording
Error Responses
- 404 - Recording not found
DELETE /recordings/stored/{recordingName}
Delete a stored recording.
Path parameters
- recordingName: string - The name of the recording
Error Responses
- 404 - Recording not found
POST /recordings/stored/{recordingName}/copy
Copy a stored recording.
Path parameters
- recordingName: string - The name of the recording to copy
Query parameters
- destinationRecordingName: string - (required) The destination name of the recording
Error Responses
- 404 - Recording not found
- 409 - A recording with the same name already exists on the system
GET /recordings/live/{recordingName}
List live recordings.
Path parameters
- recordingName: string - The name of the recording
Error Responses
- 404 - Recording not found
DELETE /recordings/live/{recordingName}
Stop a live recording and discard it.
Path parameters
- recordingName: string - The name of the recording
Error Responses
- 404 - Recording not found
POST /recordings/live/{recordingName}/stop
Stop a live recording and store it.
Path parameters
- recordingName: string - The name of the recording
Error Responses
- 404 - Recording not found
POST /recordings/live/{recordingName}/pause
Pause a live recording. Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused. Paused time is not included in the accounting for maxDurationSeconds.
Path parameters
- recordingName: string - The name of the recording
Error Responses
- 404 - Recording not found
- 409 - Recording not in session
DELETE /recordings/live/{recordingName}/pause
Unpause a live recording.
Path parameters
- recordingName: string - The name of the recording
Error Responses
- 404 - Recording not found
- 409 - Recording not in session
POST /recordings/live/{recordingName}/mute
Mute a live recording. Muting a recording suspends silence detection, which will be restarted when the recording is unmuted.
Path parameters
- recordingName: string - The name of the recording
Error Responses
- 404 - Recording not found
- 409 - Recording not in session
DELETE /recordings/live/{recordingName}/mute
Unmute a live recording.
Path parameters
- recordingName: string - The name of the recording
Error Responses
- 404 - Recording not found
- 409 - Recording not in session