GETCHANNELNUM Command

ADDRESS VOX Commands › Voice Commands › GETCHANNELNUM Command

GETCHANNELNUM Command

The GETCHANNELNUM command identifies the physical voice channel number associated with the specified channel handle.

This command has the following format:

ADDRESS VOX "GETCHANNELNUM CHANNEL(channelhandle)
   [SYSTEM(sysname)]
   [PREFIX(varname)]
   [CMDRESP(destination)]"

CHANNEL

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

SYSTEM

(Optional) Specifies the name of the system to which you want to direct the command.

The sysname value can contain up to eight alphanumeric characters.

Note: A system is a workstation on which a notification server resides. If CA Automation Point is running within a distributed system, (that is, if all CA Automation Point components are not running on a single workstation), you must specify the SYSTEM operand.

Default: The local system name.

PREFIX

(Optional) Specifies the name of the REXX stem variable (other than the default name) that contains the return information for the command.

For information about changing the default variable name, see ADDRESS VOX Return Information in this chapter.

Default: VOX.GETCHANNELNUM

CMDRESP

(Optional) Directs return information to a specific destination. For a list of valid destination values, see ADDRESS VOX Return Information in this chapter.

Default: REXX

Usage Note:

Typically, you do not need to issue the GETCHANNELNUM command except in the following situations:

When you need to reset it
When you have posted a callback number
When you need to get a particular channel

Return Information:

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

If the command executes successfully, the RC variable contains a value of zero. Additionally, the VOX.GETCHANNELNUM variable contains the returned channel handle.
If the command does not execute successfully, the RC variable contains one of the following values: 5117, 5155, 5199, 5204. (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.

Example:

The following REXX code illustrates how to use the GETCHANNELNUM command to determine the physical line number associated with the current channel handle, and then use that information in a REXX program:

/* Get exclusive access to the first available voice channel. */

address vox 'getchannel group(all) prefix(handle)'

/* Get the physical line number associated */
/* with the channel handle.                */

address vox 'getchannelnum channel('handle') prefix(channelnum)'

/* Get the telephone number of the line connected to the channel.*/

select
   when channelnum == 1 then phonenum='555-1000'
   when channelnum == 2 then phonenum='555-1001'
   when channelnum == 3 then phonenum='555-1002'
   when channelnum == 4 then phonenum='555-1003'
end

/* Page the "on-call" operator */

address vox 'call channel('handle') tonestring('pagernum')'

/* Indicate the telephone number that the operator should call */

address vox 'sendtones channel('handle') tonestring('phonenum')'

/* Wait up to 5 minutes for the operator to call back. */

address vox 'answerplay channel('handle') file(problem.vox options.vox) timeout(3000)'
...

/* Release the voice channel. */

address vox 'releasechannel channel('handle')