Package version:

Class CallRecording

CallRecording class represents call recording related APIs.

Index

Constructors

Methods

delete downloadStreaming downloadToPath downloadToStream getState pause resume start stop

Constructors

constructor

new CallRecording(endpoint, credential, options?): CallRecording
Parameters
- endpoint: string
- credential: any
- Optionaloptions: CallAutomationApiClientOptionalParams
Returns CallRecording
- Defined in callRecording.ts:34

Methods

delete

delete(recordingLocationUrl, options?): Promise<void>
Deletes a recording.
Parameters
- recordingLocationUrl: string
  The recording location url. Required.
- options: OperationOptions = {}
  Additional request options contains deleteRecording api options.
Returns Promise<void>
- Defined in callRecording.ts:164

downloadStreaming

downloadStreaming(sourceLocationUrl, options?): Promise<ReadableStream>
Returns a stream with a call recording.
Parameters
- sourceLocationUrl: string
  The source location url. Required.
- options: DownloadRecordingOptions = {}
  Additional request options contains downloadRecording api options.
Returns Promise<ReadableStream>
- Defined in callRecording.ts:176

downloadToPath

downloadToPath(sourceLocationUrl, destinationPath, options?): Promise<void>
Downloads a call recording file to the specified path.
Parameters
- sourceLocationUrl: string
  The source location url. Required.
- destinationPath: string
  The destination path. Required.
- options: DownloadRecordingOptions = {}
  Additional request options contains downloadRecording api options.
Returns Promise<void>
- Defined in callRecording.ts:220

downloadToStream

downloadToStream(sourceLocationUrl, destinationStream, options?): Promise<void>
Downloads a call recording file to the specified stream.
Parameters
- sourceLocationUrl: string
  The source location url. Required.
- destinationStream: WritableStream
  The destination stream. Required.
- options: DownloadRecordingOptions = {}
  Additional request options contains downloadRecording api options.
Returns Promise<void>
- Defined in callRecording.ts:195

getState

getState(recordingId, options?): Promise<RecordingStateResult>
Returns call recording properties.
Parameters
- recordingId: string
  The recordingId associated with the recording.
- options: OperationOptions = {}
  Additional request options contains getRecordingProperties api options.
Returns Promise<RecordingStateResult>
- Defined in callRecording.ts:117

pause

pause(recordingId, options?): Promise<void>
Pauses a call recording.
Parameters
- recordingId: string
  The recordingId associated with the recording.
- options: OperationOptions = {}
  Additional request options contains pauseRecording api options.
Returns Promise<void>
- Defined in callRecording.ts:146

resume

resume(recordingId, options?): Promise<void>
Resumes a call recording.
Parameters
- recordingId: string
  The recordingId associated with the recording.
- options: OperationOptions = {}
  Additional request options contains resumeRecording api options.
Returns Promise<void>
- Defined in callRecording.ts:155

start

start(options): Promise<RecordingStateResult>
Starts a call recording with the specified options.
Parameters
- options: StartRecordingOptions
  Operation options.
Returns Promise<RecordingStateResult>
- Defined in callRecording.ts:51

stop

stop(recordingId, options?): Promise<void>
Stops a call recording.
Parameters
- recordingId: string
  The recordingId associated with the recording.
- options: OperationOptions = {}
  Additional request options contains stopRecording api options.
Returns Promise<void>
- Defined in callRecording.ts:137