From Bright Pattern Documentation
< 5.19:AgentDesktop-client-side-javascript-api-specification
Revision as of 04:01, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 5.19


setCallRecording

Starts or stops a particular call recording.

Please note that you can find out the current state of call recording for each interaction by querying callRecording property of the InteractionData object.

Request

Syntax

setCallRecording(state: boolean, interactionId?: string): Promise<OperationResult<null>>

Parameters

Parameter Parameter Values Data Type Optional/Required Description
state Boolean Required Set the value to true to start call recording, set the value to false to stop call recording.
interactionId String Optional The ID of the specific interaction that you wish to record or stop recording. If not specified, the active interaction will be used.

Example Request

const interactionId = interactionsList[0].interactionId;

startCallRecordingButton.onclick = () => {

        adApi.setCallRecording(true, interactionId);

      };

stopCallRecordingButton.onclick = () => {

  adApi.setCallRecording(false, interactionId);

};

Return Value

null

< Previous | Next >