TeleFlow Variable @HOOK STATUS

From TeleFlow

---

Current revision

Description: Indicates whether the phone is on or off hook. If it is set to 'ON-HOOK', there is currently no call on the port, and steps/features requiring an active call (such as Play to play a file, or Get TT String to get touch tones from a caller) will fail (likely resulting in an application or fatal error). If it is set to 'OFF-HOOK', this means that there is a call active on the port.

Data Type: String

Sample Uses: This is helpful in flowcharts that are run both when a caller is on the line and when there is no one on the line. You might use this to determine whether or not to play a message to the caller. The most common example is playing a technical difficulties message in the event of an application error. When you go to the fatal error label, @HOOK_STATUS is the only way to know if a caller is still on the line. If they are, you can play them a message. If not, and you attempt to play a message, this will generate a fatal error. If not handled carefully, this can create an endless loop.

This is also useful to determine what to do when returning to a parent TAP after using Run TAP to run a child or sub-application. When you leave another TAP, you may be leaving it because the functions of that application are completed, but the caller is still on the line interacting with your application. It may also be that a hang up was detected in the application, and you can use @HOOK_STATUS to determine which of these is the case.

Please refer to TeleFlow System Variables for a complete list of system information and settings TeleFlow offers in special variables.