$ACCOUNT_CODE

Yes

The account code associated with the call.

$ANS_PARTY

–

Number of party who answered the call.

$ANS_PARTY_NAME

–

Name of the party who answered the call.

$CALL_DATE

–

The call date (UTC).

$CALL_TIME

–

The call time (UTC).

$CALLED

–

The called number.

$CALLED_NAME

–

The name, if available, of the called party.

$CALLED_TZOFFSET

–

The called parties time zone offset.

$CALLERS_TZOFFESET

–

The callers time zone offset.

$CID

–

Contains a unique call ID assigned to the call. This is not the same call ID as shown in IP Office SMDR records.

$CLI

Yes

Holds the CLI of the caller if available to the IP Office.

$CLI_NAME

–

The name, if available, of the caller.

$COUNTER

Yes

The voicemail server provides counter variable $COUNTER1 to $COUNTER15. These can be used in the same way as other call 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

Yes

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.

$DATE

–

The current date in long format, for example "3rd November 2015". The individual date and time elements can be accessed in numeric format using the $DAY, $MONTH, $YEAR, $HOUR, $MIN and $SEC variables.

$DAY

–

The current day number.

$DISPLAY

Yes

The phone display text.

$DBD

–

A set of 6 variables $DBD[0] to $DBD[5] for fields extracted from a current database record. The formats $DBDx or $DBD[x] are both supported.

$DDI

Yes

Holds the DDI of the call if available.

$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 Queued and Still Queued start points.

$FALLBACK_NUM

–

The fallback number associated with the call.

$HOUR

–

The current hour.

$ISDST

–

Indicates whether the system is currently using daylight saving or not.

$KEY

Yes

Holds the last DTMF key series entered. For more information.

$LOC

–

Holds the locale setting for the call passed by the IP Office system.

$MIN

–

The current minutes.

$MONTH

–

The current month as a numeric value.

$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.

$REC_ORIGINATOR

–

The recording originator.

$REG[name]

–

This variable returns the current value of the named user variable . This allows user variables to be used in the same way as call variables.

$RES

Yes

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

Yes

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.

$SEC

–

The current seconds.

$TAG

Yes

The tag text currently associated with the call.

$TARGET

Yes

For calls sent by the IP Office to a mailbox, this variable contains the original target of a call, that is, the original target user or hunt group.

$TARGET_NAME

–

The name of the target.

$TARGET_TZOFFSET

–

The targets time zone offset.

$TIME

–

The current system time.

$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.

$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.

$USER_DATA

–

$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.

$VAR

Yes

A general variable which can hold amongst other things DTMF key sequences.

$WEEKDAY

–

The day of the week.

$YEAR

–

The current year.