ADDRESS VOX Commands › Voice Commands › RELEASECHANNEL Command

RELEASECHANNEL Command

The RELEASECHANNEL command releases the voice channel identified by the specified channel handle, changing the channel's status from in-use to available and setting the channel's hook-state to on-hook. Use the RELEASECHANNEL command with the GETCHANNEL command to serialize a channel's I/O activity.

This command has the following format:

ADDRESS VOX "RELEASECHANNEL CHANNEL(channelhandle)
  [SYSTEM(sysname)]"

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.

Return Information:

After the RELEASECHANNEL 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: 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 RELEASECHANNEL command to release ownership of a previously acquired voice channel, freeing it for use by other REXX programs:

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

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

or

/* Get exclusive access to the first available channel in the */
/* OUTBOUND channel group. */

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

or

/* Get exclusive access to the first available channel in the */
/* INBOUND channel group. */

address vox 'answer group(inbound) prefix(handle)'
...

/* Release the voice channel. */

address vox 'releasechannel channel('handle')