• 5.19

setCallHold

Sets a call’s hold status. A call may be placed on hold with the true value, and resumed with the false value.

Request

Syntax

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

Parameters

Parameter	Parameter Values	Data Type	Optional/Required	Description
state		Boolean	Required	A call may be placed on hold with the true value, and resumed 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

setCallHoldButton.onclick = () => {

    const holdCall = callHoldCheckbox.checked

    const itemId = activeInteractionIdInput.value

    adApi.setCallHold(holdCall, itemId)

}

Return Value

null

< Previous | Next >