Station Audio

This Telephony tool makes a connection to a station queue. This connection creates a call object, and any type of audio can be played to that queue once the connection is made. You can also pass the connection to a Station Place Call tool.

Station audio calls made with this tool are only valid for a limited set of operations: play and input, station place call, and blind transfer.

Inputs

Station Queue Identifier

The station with which a connection is created.

User Identifier

If you specify a User Queue ID, the station audio call will be placed on that user queue in addition to the specified station queue.

Hide Call (Do not show on queues)

Set to True if you do not want the call to appear on a station queue.

Status Text

The Status Text input specifies a string which, if not empty, is the initial status string for the call. For the Off Hook handler, you should set it to "Manual Dialing."

Interrupt Current Call?

This Boolean determines whether or not the new connection will interrupt a currently connected call. By default, this parameter is set to "false."

Initiated by Phone?

This Boolean indicates whether or not the call was initiated by a phone, since hold requests for phone-initiated calls and client-initiated calls are handled differently. This parameter is set to “false” by default and is only set to “true” when the tool is called from inside the Station Off Hook initiator.

Outputs

Call Identifier

The unique identifier for the call. This call is created when a connection is established with the station queue.

Exit Paths

Success

This step takes the Success exit path if the Station Identifier is valid.

Failure

This path is taken if the operation fails. Reasons for failure can include currently active call or station audio call, or an invalid user queue. Insufficient voice resources can also cause this tool to fail if it is occurring frequently. The event log should indicate if this has been happening.