From Bright Pattern Documentation

Revision as of 20:10, 2 April 2026 by Laura.donovan (talk | contribs) (Updated via BpClonePage extension. Source page: draft:AgentDesktop-client-side-javascript-api-specification/setCallRecordingMute)

< Previous | Next >
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

setCallRecordingMute

Mutes or unmutes the user's microphone for recording of specified call. Use true value to mute the recording and false to unmute the recording.

Request

Syntax

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

Parameters

Parameter Parameter Values Data Type Optional/Required Description
state boolean Required Set value to true in order to mute call recording; set value to false in order to unmute call recording.
interactionId string Optional ID of the specific interaction that you wish to record or stop recording. If not specified, the active interaction will be used. Special value “all” can be used in order to mute/unmute all calls at once.

Example Request

    muteCallRecordingButton.onclick = () => {

        adApi.setCallRecordingMute(true, "all");

    };

    unmuteCallRecordingButton.onclick = () => {

        adApi.setCallRecordingMute(false, "all");

    };

Return Value

null

< Previous | Next >