Set Call State

This Telephony tool step changes the state of a call. Set Call State could be used to indicate to CIC client users that a call is in voice mail or sending/receiving a fax. While calls delivering voice mail or a fax are actually in a state of Connected, CIC client users will see "Voice Mail" or "FAX."

See States for information on state strings.

Inputs

Call Identifier

The unique identifier for the call.

New Call State

The state to which the call is set.

Voicemail recording will be performed

Set to True if the call will be transferred to voice mail. This prepares the call for recording.

Call should be moved to the system queue

Set to True if the call should be moved to System queue.

True: Claim control of this call

Set to True to take control of the call so that audio can be played for the call.

Cancel pending operations

Set to True to cancel any operations about to be performed on the call object. For example, if a prompt or audio file was about to be played, the play operation would be canceled.

Associate call with virtual station

This Boolean is set to true if the call is associated with a virtual station. By default, this parameter is false.

Exit Paths

Success

This step takes the Success exit path if the state is changed.

Failure

This step takes the Failure exit path if the state cannot be changed. This can occur 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.