Voicemail Pro Installation and Maintenance Page 158
15-601063 Issue 22e (16 May 2010)IP Office Release 6
Available Variables
Variable
Write
Description
$CID
Contains the unique call ID that the IP Office assigns to all calls that it handles. The same
call ID is shown in IP Office SMDR records.
$CLI
Holds the CLI of the caller if available to the IP Office.
$COUNTER
Voicemail Pro 5.0+ provides counter variable $COUNTER1 to $COUNTER15. These can be
used in the same way as other variables. They can also be manipulated using Generic
action commands for Set Counter , Clear Counter , Counter Decrement and
Counter Increment . They can also be used with the Decrement and Test Counter
and Increment and Test Counter actions. By default the initial value of a counter
variable is 0. The formats $COUNTERx or $COUNTER[x] are both supported.
$CP
The 16 variables $CP0 to $CP15 are used to store values (call parameters) for the
duration of a call within the call flow. Values can be written into these variables using the
Generic action command CPx:<value> where x is 0 to 15 and <value> is the value
to be stored. The formats $CPx or $CP[x] are both supported.
$DBD
A set of 6 variables $DBD[0] to $DBD[5] for fields extracted from a current database
record. See Database Actions . The formats $DBDx or $DBD[x] are both supported.
$DDI
Holds the DDI of the call if available. (Voicemail Pro 4.1+)
$ETA
Holds the expected time to answer in seconds for a queued caller. This time is based on the
last 5 queued and answered calls for the same target in the last hour. The variable can be
used to speak the value as a prompt or to test the value in a condition. Only available
when using hunt group Queued and Still Queued start points.
$KEY
Holds the last DTMF key series entered. For more information, see Example Call Flow .
$LOC
Holds the locale setting for the call passed by the IP Office system. See Changing the
Language of Custom Prompts .
$NAM
Holds the name of the mailbox user (blank for short codes). If used as a prompt, the
mailbox's recorded name prompt is played.
$POS
Holds the position of a queued caller. Can be used to speak the position as a prompt or test
the value in a condition. Only available when using Queued and Still Queued start points.
$QTIM
The same as the $ETA above but returns the estimated time to answer rounded up to the
nearest minute. This variable can be used to speak the value as a prompt or to test the
value in a condition.
$REG[name]
When used, this variable returns the current value of the named user variable.
$RES
Holds the value of the result of the previous action. For example when a call flow has been
branched by an action that has True and False results, on one branch the value of $RES
is "True", on the other "False".
$SAV
Holds the last saved result. This can be entered using the following entry in a Generic
action, Save:<value>, for example Save:$KEY or Save:1234.
$TARGET
For calls sent by the IP Office to a mailbox, this variable contains the original target of a
call, ie the original target user or hunt group. (Voicemail Pro 4.2+)
$TimeQueued
Holds the length of time, in seconds, that the call has been part of a particular hunt group
queue. Only available when using Queued and Still Queued start points. (Voicemail Pro
4.1+)
$TimeSystem
Holds the length of time, in seconds, since the call was presented to the IP Office system.
Only available when using Queued and Still Queued start points. (Voicemail Pro 4.1+)
$UUI
Available when a recording is triggered by auto-recording. Holds the user name, hunt
group name or account code that triggered the auto-recording process. See Customizing
Auto Recording .
$VAR
A general variable which can hold amongst other things DTMF key sequences.
ยทWrite
This column indicates those call variables where the existing value can be changed using methods such as VBScript
or generic action commands. Other call variables have a fixed value set when the call is received by the voicemail
server or, for $DBD values, the value is requested by the voicemail server.
184
194 190 191
192 248
249
184
250
265
304
184
294