ADDRESS VOX Commands › Voice Commands › SENDTONES Command

SENDTONES Command

The SENDTONES command sends additional tones (telephone keypad digits) to an off-hook voice channel after a successful call connection.

This command has the following format:

ADDRESS VOX "SENDTONES CHANNEL(channelhandle) TONESTRING(tonestring)
  [ANALYSIS(YES|NO)]
  [SYSTEM(sysname)]
  [NAME(CPAparameterset)]"

For information on valid DTMF dialing characters, see the section Valid Dialing Characters.

CHANNEL

Specifies the channel handle (channelhandle)-identifying some physical channel-that the GETCHANNEL command returns.

TONESTRING

Specifies the numbers or other special digits (tonestring) to dial. Valid characters are: 0 1 2 3 4 5 6 7 8 9 * # a b c d & - ,   T P M L I X

ANALYSIS

(Optional) Activates call progress analysis for the voice channel.

If you experience a problem when sending a tone string, this option can help you to determine the reason. For example, a loop-drop condition (disconnection) may simply be a one-time occurrence; however, if CA Automation Point reports that it has detected a FAX tone, it is likely that your REXX program has connected with the wrong telephone extension.

Valid values are:

YES

Activates call progress analysis when sending tones (this is necessary for a supervised call-transfer operation).

NO

Does not activate call progress analysis when sending tones (this is necessary for a blind call-transfer operation).

Default: NO, unless the NAME operand is specified, in which case ANALYSIS(YES) is used.

SYSTEM

(Optional) Specifies the name of the system that is running the notification server to which you want to direct the command.

The sysname value can contain up to eight alphanumeric characters.

Default: The local system name.

NAME

(Optional) Specifies the name of the call progress analysis (CPA) parameter set to use for dialing. CPA set names can be created and configured using the Configuration Manager.

When NAME is specified, the ANALYSIS operand uses the value YES.

Default: EngineDefault

Return Information:

After the SENDTONES command executes, it sets the special REXX return code variable RC.

• If the command executes successfully, the RC variable contains a value of zero.
• If the command does not execute successfully, the RC variable contains one of the following values: 5102, 5112, 5117, 5155, 5199, 5204, 5300, 5301, 5302, 5303, 5304, 5305, 5306. (See the Message Reference Guide for further information.) Additionally, the VOX.ERROR variable contains the complete VOX error message, which includes the four-digit return code and complete error message text.

Usage Note:

Unlike the CALL command, the SENDTONES command does not set a voice channel's hook state.

Example:

The following REXX code illustrates how to use the SENDTONES command to send the tone digits of a telephone extension to which you want to transfer:

mainnumber = '9,555-4000'
extension = '1492'

/* Get exclusive access to a specific voice channel. */

address vox 'getchannel channelnum(1) prefix(handle) system(laengine)'

/* Call your company's main telephone number. */

address vox 'call channel('handle') tonestring('mainnumber') system(laengine)'

/* Have the automated attendant transfer */
/* you to the desired extension.         */

address vox 'sendtones channel('handle') tonestring('extension') analysis(yes)'
...

/* Release the voice channel. */

address vox 'releasechannel channel('handle')'
exit