• 5.19

setCallMute

Mute or unmute the user’s microphone for a particular call. Mute with the true value, and unmute with the false value.

Request

Syntax

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

Parameters

Parameter	Parameter Values	Data Type	Optional/Required	Description
state		Boolean	Required	Mute the user’s microphone with the true value, and unmute it with the false value.
interactionId		String	Optional	The ID of the interaction for which this action will apply to. If not specified, the active interaction will be used.

Example Request

setCallMuteButton.onclick = () => {

    const muteCall = callMuteCheckbox.checked

    const itemId = activeInteractionIdInput.value

    adApi.setCallMute(muteCall, itemId)

}

Return Value

null

< Previous | Next >