From Bright Pattern Documentation
(Created page with "<translate> =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'' {|...") |
(Updated via BpDeleteTranslateTags script) |
||
| Line 1: | Line 1: | ||
| − | + | ||
=setCallHold= | =setCallHold= | ||
| Line 46: | Line 46: | ||
''null'' | ''null'' | ||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:01, 29 May 2024
• 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