Variables-Version 12.X or greater

Note that variable names are case sensitive, and there are two underscore characters before and after each.

VARIABLE

USE

BRANDS

VARIABLE

USE

BRANDS

__activecallStatus__

LED speed for active call

Sangoma

__activecallStatusColor__

LED color for active call

Sangoma

__activecallStatusEnable__

LED enable for active call

 

__adminPass__ 

The Admin Password as defined in the Global Settings Section of EPM

ALL

__amcolor__

AM identifier color for display on the AND clock as defined in the AND templates

AND

__answer__

SIP allow auto answer as defined in the Aastra templates

Aastra

__audioAlert__

BLF Audio Alert Keys

Sangoma

__b1label__

Program button 1 label if the device supports showing a label on a LCD screen for this button. The variable can be __b1label__ thru __b60label__ representing each program button on a device.

MOST

__b1type__

Program button 1 type such as speed-dial, BLF and others depending on what the device supports. The variable can be __b1type__ thru __b60type__ representing each program button on a device.

MOST

__b1value__

Program button 1 value such as the speed-dial number that is dialled when button is pressed. The variable can be __b1value__ thru __b60value__ representing each program button on a device.

MOST

__background__

Image background location

MOST

__backgroundName__

Image name

Yealink

__backlightActive__

Backlight Active Level

Sangoma

__backlightInActive__

Backlight In-Active Level

Sangoma

__backlightTimeout__

Backlight timeout

Sangoma

__barge__

SIP intercom allow barge in as defined in the Aastra templates

Aastra

__blfVisual__

BLF visual alert enable/disable

Sangoma

__blfAudo__

BLF audio alert enable/disable

Sangoma

__cadance__

Flash Cadance for Algo 8128

Algo

__callingX__

1-9 Action for calling state on horizontal keys.

Digium

__callwaiting__

Call Waiting tone style

Polycom

__cid_masquerade__

CID Sip Alias for Extension

ALL

__clockcolor__

Clock color for the display on the AND clock as defined in the AND templates

AND

__clockfont__

Clock font for the display on the AND clock as defined in the AND templates

AND

__colon__

Speed of colon blink for the display on the AND clock as defined in the AND templates

AND

__confCallRelease__

Three way calling release type

Sangoma

__country__

Country code for language

Sangoma

__destination__

This is the IP Address or FQDN that the phone will register to based on what is defined in each device template

ALL

__directedCallPickup__

Feature code for directed call pick-up.

Snom

__dndOff__

Feature code to dial to turn off Do Not Disturb as defined in the PBX Feature Code admin

Some

__dndOn__

Feature code to dial to turn on Do Not Disturb as defined in the PBX Feature Code admin

Some

__dnd__

Feature code to toggle Do Not Disturb on or off as defined in the PBX Feature Code admin

Some

__cfaOn__

Call Forwarding Always On

Vtech

__cfaOff__

Call Forwarding Always Off

Vtech

__cfnaOn__

Call Forwarding Not Available On

Vtech

__cfnaOff__

Call Forwarding Not Available Off

Vtech

__cfbOn__

Call Forwarding Busy On

Vtech

__cfbOff__

Call Forwarding Busy Off

Vtech

__connectedX__

1-9 Action for connected state on horizontal keys.

Digium

__contactPhoto__

URL for Contact Photos

Sangoma

__cwOn__

Call Waiting On

Vtech

__cwOff__

Call Waiting Off

Vtech

__dhcpVlan__

DHCP on VLAN

Sangoma

__dialX__

1-9 Action for dial state on horizontal keys.

Digium

__dialpattern__

Dial pattern for template

ALL (used by some)

__directory__

Directory Location

Aastra

__expImagePath__

Expansion Module Contact Images Path

Sangoma

__failoverVPN__

Failover VPN configuration address.

Sangoma

__failoverXML__

Failover XML server path.  Uses backup destination address.

Sangoma

__firmware__

The path to the firmware folder based on what you pick in the template

MOST

__flash__

Algo 8128 Flash style

Algo

__focus__

Switch focus to ringing lines defined as in the Aastra templates

Aastra

__ftppass__

The FTP password to use for auto provisioning as defined in each device template

ALL

__ftpserver__

The IP address of the configuration server to use for auto provisioning as defined in each device template

ALL

__ftpuser__

The FTP username to use for auto provisioning as defined in each device template

ALL

__fb__

Feedback suppression as defined in the AND templates

AND

__guiOverride__

GUI Override setting

Sangoma

__headset__

Headset enable/disable

Sangoma

__headsetRing__

Headset device to ring

Sangoma

__holdX__

1-9 Action for hold state on horizontal keys.

Digium

__hotline__

Enable offhook dial to this number

Sangoma

__idleX__

1-9 Action for idle state on horizontal keys.

Digium

__incomingX__

1-9 Action for incoming state on horizontal keys.

Digium

__intercom__

Feature code for Intercom

ALL

__keypress__

Code to unlock the door for Algo 8180 as defined in the Algo and CyberData templates

Algo, CyberData

__keypressTone__

Enable/Disable key press tone

Sangoma

__lcdLanguage__

LCD Display Language

Sangoma

__ldapBase__

LDAP Base

Sangoma

__ldapDisplayName__

LDAP Display Name

Sangoma

__ldapLookupCall__

LDAP Lookup For Incoming Call

Sangoma

__ldapMaxHits__

LDAP Max Hits

Sangoma

__ldapNameFilter__

LDAP Name Filter

Sangoma

__ldapNumberFilter__

LDAP Number Filter

Sangoma

__ldapPassword__

LDAP Password

Sangoma

__ldapPort__

LDAP Port

Sangoma

__ldapProtocol__

LDAP Protocol

Sangoma

__ldapSearchDelay__

LDAP Search Delay

Sangoma

__ldapServerAddress__

LDAP Server Address

Sangoma

__ldapSort__

LDAP Sorting Results

Sangoma

__ldapUsername__

LDAP User Name

Sangoma

__line1Enable__

Whether to enable line 1 on the device based on extension mapping section of EPM for phones that support a enable or disable per line. The variable can be __line1Enable__ thru __line24Enable__ representing each line button that is programmed on the device depending on how many lines the device supports.

Some

__line1Ext__

The extension number to be used for line 1 or the default line for each phone. This is pulled from the extension mapping page for each extension. The variable can be __line1Ext__ thru __line24Ext__ representing each line button that is programmed on the device depending on how many lines the device supports.

ALL

__line1extPort__

The SIP port for the Extension assigned to account 1.  This is pulled from the extensions module. The variable can be __line1extPort__ thru __line24extPort__ representing each line button that is programmed on the device depending on how many lines the device supports.

ALL

__line1Name__

The extension name to be used for line 1 or the default line for each phone. This is pulled from the extension name in your PBX based on the extension number associated with this line. The variable can be __line1Name__ thru __line24Name__ representing each line button that is programmed on the device depending on how many lines the device supports.

ALL

"__line1Pass__"

The extension password to be used for line 1 or the default line for each phone. This is pulled from the extension SIP secret in your PBX based on the extension number associated with this line. The variable can be __line1Pass__ thru __line24Pass__ representing each line button that is programmed on the device depending on how many lines the device supports.

ALL

__line1ServerPort__

The server registration port

ALL

__line1Dest__

The server registration host name/IP

 

__line1sipPort__

Device listen port

ALL

__line1VMPass__

The extensions voicemail password to be used for line 1 or the default line for each phone. This is pulled from the extension set voicemail password in your PBX based on the extension number associated with this line. The variable can be __line1Pass__ thru __line24Pass__ representing each line button that is programmed on the device depending on how many lines the device supports.

ALL

__line1type__

What type of function the Line key 1 will be. The variable can be __line1type__ thru __line8type__ representing each line button on the phone

Grandstream

__line1acct__

What account the the Line key 1 will be tied to. The variable can be __line1type__ thru __line8type__ representing each line button on the phone

Grandstream

__line1label__

What will be displayed on the Line key 1 LCD display. The variable can be __line1type__ thru __line8type__ representing each line button on the phone

Grandstream

__line1value__

If the line key is setup for something like a BLF or Speed-dial this would be what number is dialled or monitored for line key 1. The variable can be __line1type__ thru __line8type__ representing each line button on the phone

Grandstream

__linekeys__

The number of line keys each registered user should take up for Polycom phones only

Polycom

__logoled__

Logo LED settings

Sangoma

__mac__

MAC address in upper case

ALL

__mac6__

First 6 digits of MAC address in upper case

ALL

__micvolume__

Mic volume as defined in the AND templates

AND

__misscallsStatus__

LED speed for missed calls

Sangoma

__misscallsStatusColor__

LED color for missed calls

Sangoma

__misscallsStatusEnable__

LED enable for missed calls

Sangoma

__missed__

Whether to display missed calls on the device for Polycom Phones only as defined in the Polycom templates.

Polycom

__mode__

Sip detect mode for Algo 8128

Algo

__model__

Model of phone as defined in the Extension Mapping for Audio Codes and CyberData

Audio Codes, CyberData

__monitored__

Monitored event for Algo 8128

Algo

__msgfont__

Message font for the display on the AND clock as defined in the AND templates

AND

__msgcolor__

Message color for display on the AND clock as defined in the AND templates

AND

__multicastAddress__

Multicast address and port, comma separated. Also used are __multicastAddress2__ - __multicastAddress6__

Some

__multicastEnable__

Multicast enable

Some

__mute__

SIP intercom mute mic as defined in the Aastra templates

Aastra

__offset__

GMT time offset

Polycom

__offhook__

Auto off hook as defined as in the Aastra templates

Aastra

__outboundcid__

Outbound Caller ID from extensions.

All

__pcport__

PC Port setting

Htek

__pincode0__

Pin code for unlocking door on Cyberdata devices. The variable can be __pincode0__ thru __pincode9__ as defined in the Cyberdata templates

CyberData

__pmcolor__

PM identifier color for display on the AND clock as defined in the AND templates

AND

__powerStatus__

LED speed for power status

Sangoma

__powerStatusColor__

LED color for power status

Sangoma

__powerStatusEnable__

LED enable for power status

Sangoma

__PriAcctName__

Primary Account Name

All

__pringtone__

Audio page tone for the Algo 8180 as defined in the Algo templates

Algo

__pvolume__

Audio page volume for the Algo 8180 as defined in the Algo templates

Algo

__protocol__

Download protocol as defined in each device template

ALL

__provisionAddress__

The IP address of the configuration server to use for auto provisioning as defined in each device template

Some

__provisionport__

HTTP port to use for provisioning as defined in the global settings section of EPM

ALL

__record__

Feature code for Record

Sangoma

__remoteDisconnect__

Remote disconnect setting

Sangoma

__restapps__

RESTapps file location

Aastra/Digium/Yealink

__phoneApps__

URL for phone applications

Aastra/Digium/Obihai/Sangoma/Yealink

__ringingStatusSpeed__

LED speed for ringing status

Sangoma

__ringingStatusSpeedColor__

LED color for ringing status

Sangoma

__ringingStatusSpeedEnable__

LED enable for ringing status

Sangoma

__ringtone__

Audio ring tone for Sangoma Phones

Sangoma

__ringtoneUrl__

Path to ring tone locations

Sangoma

__rringtone__

Audio ring tone for the Algo 8180 as defined in the Algo templates

Algo

__rvolume__

Audio ring volume for the Algo 8180 as defined in the Algo templates

Algo

__screensaver__

Screen saver setting for Sangoma Phones

Sangoma

__scrollLabel__

Enable line key label scrolling

Sangoma

__seccolor__

Second color for display on the AND clock as defined in the AND templates

AND

__seconds__

Whether to display seconds on the AND clock as defined in the AND templates

AND

__sipPort__

SIP port to use for SIP as defined in the global settings section of EPM

ALL

__speeddial1__

Speed-dial for button number 1 on the phone as defined in the device template for devices that support this feature. The variable can be __speeddial1__ thru __speeddial9__ representing numbers 1-9 on the keypad of the phone.

Some

__spkrvolume__

Speaker volume as defined in the AND templates

AND

__srtpMode1__

SRTP Mode (__srtpMode1-4)

Sangoma

__ssImage__

URL to image for Screen Saver

Sangoma

__stutter__

Stutter disabled as defined as in the Aastra templates

Aastra

__textLogo__

Logo Screen Saver Text

Sangoma

__timeformat__

Time format as defined in the AND templates

AND

__timeOff__

Length of time for led to be off for Algo 8128

Algo

__timeOn__

Length of time for led to be on for Algo 8128

Algo

__timeout__

SIP digit timeout as defined in the Aastra templates

Aastra

__timeserver1__

Time server1 as defined in the device templates.

ALL

__timeserver2__

Time server2 as defined in the device templates if they support 2 time servers

Some

__timeserver3__

Time server3 as defined in the device templates if they support 3 time servers

Some

__timezone__

Time zone code as defined in the Device templates for the time zone

ALL

__timezone2__

Time zone code for Panasonic UT670 only as defined in the Panasonic template for the time zone

Panasonic

__timezonembu__

Time zone code for Aastra MBU400 only as defined in the Aastra template for the time zone

Aastra

__timezonename__

Time zone name as defined in the Aastra, Xorcom, Yeaklink templates for the time zone

SOME

__toneset__

Tone set as defined in the Aastra templates

Aastra

__transport1__

SIP Transport type (__transport1-4__)

Sangoma

__userPass__

User password as defined in the Global Settings Section of EPM

ALL

__version__

Version of the firmware that is used as defined in the device templates

Panasonic

__visualAlert__

BLF Visual Alert keys

Sangoma

__voicemail__

Feature code to dial to access the voicemail system as defined in the PBX Feature Code admin

ALL

__voicemailExt__

Voicemail Extension from Extensions page.  Added in 12.0.0.78

None

__voicemessageStatus__

LED speed for voice message waiting

Sangoma

__voicemessageStatusColor__

LED color for voice message waiting

Sangoma

__voicemessageStatusEnable__

LED enable for voice message waiting

Sangoma

__webport__

Port for Aastra XML scripts as defined in the Global Settings section

Aastra

__wEnable1__

Wireless enable for network 1

Incom Grandstream

__wEncryption1__

Wireless encryption type

Grandstream

__wSecurity1__

Wireless security type for network 1

Incom Grandstream

__wssid1__

Wireless SSID for network 1

Incom Grandstream

__wWEPBits1__

WEP Bits (64/128) for network 1

Incom Grandstream

__wWPAPSKKey1__

WPA PSK key phrase for network 1

Incom Grandstream

__wWPAPSKPass1__

WPA PSK encrypted password for network 1

Incom Grandstream

__z001__

Zone controllers for the Cyberdata Zone Paging Server. The variable can be __z001__ thru __z144__ as defined in the Cyberdata templates

CyberData

Return to Documentation Home I Return to Sangoma Support