ADDRESS VOX Commands › Voice Commands › WINK Command

WINK Command

The WINK command sends a brief handshaking protocol signal through a voice channel.

A common use of the WINK command is to signal your telephone company's switching office to activate its Automatic Number Identification (ANI) service (if your telephone company offers the service in your area and you subscribe to it). The switching office returns the telephone number of the calling party; your REXX program can then collect the digits by issuing the GETDIGITS command.

This command has the following format:

ADDRESS VOX "WINK 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 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

Return Information:

After the WINK 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: 5112, 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.

Usage Note:

The switching office usually sends ANI digits between the first and second rings of an incoming call. The protocol required to obtain the ANI digits may vary from that described, depending on your local telephone company's requirements.

Example:

The following REXX code illustrates how to use the WINK command to send a wink signal to the CO switch:

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

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

...

/* Send a wink signal to the central office (CO) switch. */

address vox 'wink channel('handle')'

...

/* Release the voice channel. */

address vox 'releasechannel('handle')'