Interface ICallRecording

Reads Post Call Recordings. The GetCallRecordingRequest type selects the operation and constrains the rest of the request body; the resolved response type is inferred per request via RecordingResponseFor:

• LIST (GET /convergedRecordings) -> RecordingListResponse. The query params come from GetRecordingsOptions; both a from lower bound (derived from days when not provided) and a to upper bound (defaults to now) are always sent, because the API only returns results when the time window is bounded on both ends.
• DETAIL (GET /convergedRecordings/{recordingId}) -> RecordingResponse.
• METADATA (GET /convergedRecordings/{recordingId}/metadata) -> RecordingMetadataResponse.
• BY_CALL_SESSION -> RecordingListResponse. The recording API has no confirmed server-side filter for call session id, so this fetches a list and filters client-side on serviceData.callSessionId. The scan is bounded by the list query, so pass options to widen the time window/status/page when the target session may fall outside the defaults.

Example

const list = await callRecording.getCallRecording({type: RecordingRequestType.LIST, options: {max: 30}});
const one = await callRecording.getCallRecording({type: RecordingRequestType.DETAIL, recordingId});
const meta = await callRecording.getCallRecording({type: RecordingRequestType.METADATA, recordingId});
const bySession = await callRecording.getCallRecording({
  type: RecordingRequestType.BY_CALL_SESSION,
  callSessionId,
  options: {days: 30, max: 100},
});

Moves a recording to the recycle bin (soft delete).

Calls POST /convergedRecordings/softDelete with { recordingIds: [recordingId] }. The recording can be restored from the recycle bin via the platform restore API. Requires spark:recordings_write on the access token (recording owner). Control Hub "Delete recordings and transcripts" enables this for the user; it does not grant compliance-officer permanent delete.

Mercury emits convergedRecordings.updated + TRASH, surfaced as callRecording:deleted.

Example

await callRecording.deleteRecording(recordingId);