Hold

This Telephony tool step places a call on hold. The call that is placed on hold must be in a Connected state.

Inputs

Call Identifier

The unique identifier for a call to be placed on hold.

True: Claim control of this call

Set to True to place the call on hold and pass control of the call back to a handler, even if it was already picked up by a user.

Set to False if you want this step to fail if a user has already picked up the call. The user maintains control of the call.

Exit Paths

Success

This step takes the Success exit path if the call is placed on hold.

Failure

This tool can take the Failure exit path for several reasons. Failure can occur if the call disconnects, if the call is picked up by a user (and is no longer under the control of the handler), the call ID is no longer valid (if the call is deallocated), or system resource limitation.