Recordings¶

Since: 12.0.0¶

listStored¶

Since: 12.0.0¶

GET /recordings/stored¶

List recordings that are complete.

getStored¶

Since: 12.0.0¶

GET /recordings/stored/{recordingName}¶

Get a stored recording's details.

Path parameters¶

Parameters are case-sensitive. * recordingName: string - The name of the recording

Error Responses¶

• 404 - Recording not found

deleteStored¶

Since: 12.0.0¶

DELETE /recordings/stored/{recordingName}¶

Delete a stored recording.

Path parameters¶

Parameters are case-sensitive. * recordingName: string - The name of the recording

Error Responses¶

• 404 - Recording not found

getStoredFile¶

Since: 14.0.0¶

GET /recordings/stored/{recordingName}/file¶

Get the file associated with the stored recording.

Path parameters¶

Parameters are case-sensitive. * recordingName: string - The name of the recording

Error Responses¶

• 403 - The recording file could not be opened
• 404 - Recording not found

copyStored¶

Since: 12.5.0¶

POST /recordings/stored/{recordingName}/copy¶

Copy a stored recording.

Path parameters¶

Parameters are case-sensitive. * 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

getLive¶

Since: 12.0.0¶

GET /recordings/live/{recordingName}¶

List live recordings.

Path parameters¶

Parameters are case-sensitive. * recordingName: string - The name of the recording

Error Responses¶

• 404 - Recording not found

cancel¶

Since: 12.0.0¶

DELETE /recordings/live/{recordingName}¶

Stop a live recording and discard it.

Path parameters¶

Parameters are case-sensitive. * recordingName: string - The name of the recording

Error Responses¶

• 404 - Recording not found

stop¶

Since: 12.0.0¶

POST /recordings/live/{recordingName}/stop¶

Stop a live recording and store it.

Path parameters¶

Parameters are case-sensitive. * recordingName: string - The name of the recording

Error Responses¶

• 404 - Recording not found

pause¶

Since: 12.0.0¶

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¶

Parameters are case-sensitive. * recordingName: string - The name of the recording

Error Responses¶

• 404 - Recording not found
• 409 - Recording not in session

unpause¶

Since: 12.0.0¶

DELETE /recordings/live/{recordingName}/pause¶

Unpause a live recording.

Path parameters¶

Parameters are case-sensitive. * recordingName: string - The name of the recording

Error Responses¶

• 404 - Recording not found
• 409 - Recording not in session

mute¶

Since: 12.0.0¶

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¶

Parameters are case-sensitive. * recordingName: string - The name of the recording

Error Responses¶

• 404 - Recording not found
• 409 - Recording not in session

unmute¶

Since: 12.0.0¶

DELETE /recordings/live/{recordingName}/mute¶

Unmute a live recording.

Path parameters¶

Parameters are case-sensitive. * recordingName: string - The name of the recording

Error Responses¶

• 404 - Recording not found
• 409 - Recording not in session