Skip to main content

Variables in CallFire XML

All variables in CallFire XML follow the following format = ${variable_name}

System variables have the "call." prepended to each name. For example = ${call.callerid}

Reserved Variable List

VariableDescription
call.calleridCaller ID of the incoming call.
call.callerid.alphaThis is the alphanumeric caller ID on an incoming call.
call.dnisThe phone number dialed for an incoming call.
contact.aReferences the column in the uploaded data for the user. For example, contact.A would reference the 'A' column of the Excel sheet used to upload the phone numbers for the campaign. Valid from 'A' to 'ZZ'
call.idThis is the ID of the active call. Each call on CallFire has a unique ID.
call.lastinputThe last digits that the user entered.
call.pathAn internal reference to the action being performed. This is referred to as the node path, and will show up in logs to help identify which node is executing.
call.phonenumberThe phone number that is called. Used for outbound.

Date and Time

Date and time stamps can be created using the following variables. All times are in Coordinated Universal Time (UTC). The formula should look like = ${variable.name}

VariableDescription
global.dateGives the date in month, day, year.
global.timeGives the time in hour:minutes:seconds
global.time.hourGives the hour only.
global.time.hour.militaryGives the hour in military time.
global.date.monthGives the month only.
global.date.dayGives the day of the month only.
global.date.dayOfWeekGives the numeric day of the week only. Sunday is read as "1" and Saturday as "7."
global.date.yearGives the year only.

Reserved System Variables

CallFire currently has six reserved variables that are linked to your account contacts. These can be referenced in XML code as such:

${contact.firstName}
${contact.lastName}
${contact.zipcode}
${contact.workPhone}
${contact.mobilePhone}
${contact.homePhone}

${contact.x} is also allowed, where x references the column in the Excel file you are uploading.

For example, a play tag like this: Hello ${contact.firstName} ${contact.lastName}. Your account has a balance of ${contact.a}. would read your contact's full name, followed by the contents of the A column in the uploaded Excel file.

Localizing Date and Time Variables

A few date and time variables can be configured to your local time zone. Currently, these include:

${global.date.TimeZoneID.month}
${global.date.TimeZoneID.day}
${global.time.TimeZoneID}

All three are read as integers by the CallFire Play tag, so the text-to-speech will not read "January," but "1."

You can find a link to the appropriate TimeZoneIDs here: http://www.lipscorner.net/viewthread.php?tid=27408

For example, if you are on the west coast of the US, you can personalize the tags like this:

${global.date.America/Los_Angeles.month}
${global.date.America/Los_Angeles.day}
${global.time.America/Los_Angeles}