Result Variables

Result Variables store information on activity in each module during the call.
These Result Variables ($RVs) can then be used later in the VoiceGuide script, allowing the VoiceGuide script to act based on the information in the previously set $RVs.

Result Variables can also be accessed and created/set by external systems, using VoiceGuide's COM/WCF/REST/etc interfaces.
This is one of the mechanisms by which external systems can directly monitor and control the progress of the VoiceGuide script in real-time.

Please refer to each module's reference for more information on $RVs created by that module.
VoiceGuide's vgEngine trace files also contain details of all created/set $RVs.

Where can Result Variables be used

$RVs can be used anywhere in the VoiceGuide script. eg:

• Specifying the 'trigger' and the destination modules in Paths leaving a module,
• Filenames of sound files which are to be played or recorded,
• What digits/dates/amounts are to be spoken to the caller in the Say Number module,
• Looking up information in a database,
• As parameters when calling other programs, web services, etc.
• Evaluate Expression modules,
• Send Email module: in destination Email address, Title, Message Body and Attachment Filename.

Note

If a Result Variable is used in the script that has not yet been defined, it will be replaced with nothing (an empty string), not a digit zero.

eg: If you use expression:

C:\sound_files\info_$RV[InformationNumber].wav

and the script has not yet defined $RV[InformationNumber] then the resulting string after the Result Variables are replaced will be:

C:\sound_files\info_.wav

If Result Variables are used 'Comparison' type expressions in Evaluate Expression modules, it is usually best to use quotes around the RVs which may be empty.
Also, quotes should be used when using RVs in a VBScript in situations where replacement with an empty string could potentially lead to syntax errors unless quotes have been used.

Often Used Result Variables

$RV[module title]

Used to access the 'main' information associated by a particular module. eg:

	Module Type	Result Variable will contain
	Play	The key pressed by the caller
	Get Number Sequence	The number entered by the caller
	Record	The last recorded filename.

All modules create more then one Result Variable. Please see documentation for each module type and the vgEngine trace file to see what $RVs are created by each module.

The module Result Variables are created for the duration of the call, and all modules running on that line during the call will be able to access them. Even if the script jumps to another script then the next script will still be able to access the Result Variables created by any previous script during current call.

$RV_CIDNUMBER

Caller's Telephone Number.

On traditional analog telephone lines the CallerID information is usually sent between the first and the second ring.
Hence on analog systems the calls must be answered after second ring.
On VoIP and ISDN systems CallerID is provided at beginning of the call.

$RV_CIDNAME

Caller's Name (if available).

On traditional analog telephone lines the CallerID information is usually sent between the first and the second ring.
Hence on analog systems the calls must be answered after second ring.
On VoIP and ISDN systems CallerID is provided at beginning of the call.

$RV_DNIS

Telephone number called by the caller. Provided on VoIP and ISDN lines.
$RV_DNIS is often used to determine which script should handle the call.
eg: an Evaluate Expression module can be used to goto to different scripts based on $RV_DNIS value.
See here for DNIS Routing example.

$RV_DIALEDNUMBER

On outbound call this variable stores the telephone number which was dialed.

$RV_LINEID

Identification number of the line device which is handling this call. The ID number refers to an internal line ID number - not the position in which that line's status is displayed in VoiceGuide's status window.

$RV_PORT

Line Device's position is VoiceGuide's line status listing. The first line/port has $RV_PORT of 1, the second line/port has $RV_PORT of 2, etc.

Some Other Result Variables :

Global RVs

Global RV can be preset in VG.INI, in section [Scripts], using an expression that lists multiple RVs on one line, like this:

GlobalRV=[SomeOption]{true}[MyValue]{23}[SomeEmail]{admin@mydomain.com}

These RVs will then be loaded and set when the VoiceGudie service starts and can be used in scripts. eg. If using example above then $RV[SomeOption] can be used in the scripts.

Current Date/Time Result Variables

eg. you can use this expression to create a date and time 'timestamp' :

$RV_YY$RV_MM$RV_DD$RV_HH$RV_NN$RV_SS.$RV_MS

Script Branching (Goto/Gosub/Return) related Result Variables

These RVs are set when a Goto or Gosub branch is made to another script:

$RV[ScriptEnd_Time]
$RV[ScriptEnd_Goto_Script]
$RV[ScriptEnd_Goto_Module]
$RV[ScriptStart_Time]
$RV[ScriptStart_CalledFrom_Script]
$RV[ScriptStart_CalledFrom_Module]

SIP Headers

The headers of incoming SIP calls can be accessed using these $RVs:

$RV[sip_header_callid]
$RV[sip_header_contact_display]
$RV[sip_header_contact_uri]
$RV[sip_header_content_disposition]
$RV[sip_header_content_encoding]
$RV[sip_header_content_length]
$RV[sip_header_content_type]
$RV[sip_header_diversion_uri]
$RV[sip_header_event]
$RV[sip_header_expires]
$RV[sip_header_from]
$RV[sip_header_from_display]
$RV[sip_header_referred_by]
$RV[sip_header_refer_to]
$RV[sip_header_remove]
$RV[sip_header_replaces]
$RV[sip_header_request_uri]
$RV[sip_header_to]
$RV[sip_header_to_display]

Other SIP headers to retrieve can be set in VG.INI section [SIP] entry: MonitoredHeaders
eg:

[SIP]
MonitoredHeaders=User-Agent|Diversion

will result in these $RVs being created and holding the value of corresponding header:

$RV[sip_header_User-Agent]
$RV[sip_header_Diversion]

Outbound dialing related Result Variables

Conference & Call Transfers related Result Variables

ACD Agent related Result Variables