Skip to content

Function: setHeld() ​

ts
function setHeld(id, onHold): Promise<void>;

Defined in: Calls.ts:770

Changes the hold state of a call.

The system will emit a SetHeldActionEvent. Apply the hold state to your media connection when you receive this event.

Parameters ​

ParameterTypeDescription
idstringThe call session ID.
onHoldbooleanWhether the call should be on hold.

Returns ​

Promise<void>

See ​

addSetHeldActionListener — fires when the system requests a hold-state change.