Class CallRecording

CallRecording is the backend-agnostic facade for Post Call Recording. It selects a backend-specific connector based on the resolved calling backend and delegates all read/delete operations to it, while re-emitting the connector's recording lifecycle events.

Post Call Recording (convergedRecordings) is a Webex Calling cloud capability, so only the Webex Calling (WXC) backend is supported today; other backends (BWRKS/UCM/INVALID) are rejected, following the same convention used by the Voicemail client. Adding support for another backend is a matter of dropping in a new connector and a case here — no consumer-facing changes required.

Example

const callRecording = createCallRecordingClient(webex, logger);

Hierarchy

  • Eventing<CallRecordingEventTypes>
    • CallRecording

Implements

Properties

logger

Methods

getCallRecording deleteRecording

Events

emit on off

Properties

logger

logger: LoggerInterface

Methods

getCallRecording

  • Reads Post Call Recordings, delegating to the active backend connector. The operation is selected by the request type and the response type is inferred per request.

    Type Parameters

    • T extends GetCallRecordingRequest

    Parameters

    • request: T

      The discriminated read request.

    Returns Promise<RecordingResponseFor<T>>

deleteRecording

  • Moves a single recording to the recycle bin (soft delete) via POST /convergedRecordings/softDelete. Requires spark:recordings_write on the access token; the recording can be restored from the recycle bin via the platform restore API.

    Parameters

    • recordingId: string

      The recording id (id) to move to the recycle bin.

    • Optional options: DeleteRecordingOptions

      Deprecated. Ignored (compliance permanent delete is not exposed).

    Returns Promise<RecordingDeleteResponse>

Events

emit

  • Type Parameters

    • E extends keyof CallRecordingEventTypes

    Parameters

    • event: E

      Event that is going ot be emitted.

    • Rest ...args: Parameters<CallRecordingEventTypes[E]>

      Parameters that are emitted with the event.

    Returns boolean

on

  • .

    Type Parameters

    • E extends keyof CallRecordingEventTypes

    Parameters

    • event: E

      Event to listen to.

    • listener: CallRecordingEventTypes[E]

      Callback for event.

    Returns CallRecording

off

  • .

    Type Parameters

    • E extends keyof CallRecordingEventTypes

    Parameters

    • event: E

      Event to remove listener on.

    • listener: CallRecordingEventTypes[E]

      Callback for event.

    Returns CallRecording

Settings

Member Visibility

Theme