Configuration Template

The configuration template is a text file which will be served to the phone when it requests its configuration. The template can contain a set of keywords that will be replaced with the actual value of the phone the SIP phone model template is used for.

A keyword is declared as %KEYWORD-NAME%, and is case insensitive.

The variables are as follows:

Keyword name	Usage
Extension	The local extension that is assigned to the device.
Name	The name of the user the device/extension is assigned to.
Language	The language to use on the device userinterface.
CallWaiting	Sets the call waiting state. On brand Snom it can be on or off, on all other models it is 1 or 0.
CustomConfig	Declares where in the configuration file, custom user defined configuration is inserted.
MasterPin
Softkeys
SoftkeyStart	The template section between this and SoftkeyEnd is looped for each softkey, and inside the loop SoftkeyFunction, SoftkeyLabel and SoftkeyIndex relates to the actual softkey.
SoftkeyEnd	See above.
SoftkeyIndex	The index of the softkey the function is to be applied to.
SoftkeyFunction	The function a softkey is to perform.
SoftkeyLabel	The text label to apply to the softkey.
SoftkeyValue	The value the softkey should activate. For a BLF or SPEEDDIAL it is a phone number or extension, for a URL it's the URL to call.
Network
NetworkDHCP	Specifies if DHCP should be enabled. For brand Snom it can be on or off, on all other phones it is 1 or 0.
NetworkDNS1	If no DHCP, this is the primary DNS server.
NetworkDNS2	If no DHCP, this is the secondary DNS server.
NetworkGateway	If no DHCP, this is the default gateway.
NetworkIP	If no DHCP, this is the the IP address.
NetworkSubnet	If no DHCP, this is the subnet mask.
NetworkVlanId	If VLAN is required, this is the VLAN to use, defaults to 0.
NetworkVlanPriority	If VLAN is required, this is the VLAN priority.
Authentication
Username	Username for authenticating the device against the PBX.
Password	Password for authenticating the device against the PBX.
Server	Hostname of the SIP server the device must connect to - sip.telecomx.dk.
Audio
AudioHandsetSpeaker	Audio level for handset speaker.
AudioHandsetMicrophone	Audio level for handset microphone.
AudioHandsfreeSpeaker	Audio level for device base speaker.
AudioHandsfreeMicrophone	Audio level for device base microphone.
AudioHeadsetSpeaker	Audio level for headset speaker.
AudioHeadsetMicrophone	Audio level for headset microphone.
AudioRinger	Audio level for ringer (ringtone).
headsetButton	Configuration of dedicated headset button on the phone.
Ringtone	The ringtone to use.
RingtoneCustom	If ringtone is custom, ID of ringtone.
Handsets (for multi handset devices)
HandsetStart	The template section between this and HandsetEnd is looped for each handset. Inside the loop HandsetIndex is maintained and all variables, except for Network variables are for the individual handset device.
HandsetIndex	The index of the handset.
HandsetId	A string that identifies the individual handset.
HandsetEnd	The end of the handset loop. See HandsetStart.
Mac	Mac address of the device.
Conditional
IF	Start of IF section: %%IF <Variable>=/!="Value"%%. Variable is any on this list, value may be quoted or not. Example: %%IF NetworkDHCP=true%%
ENDIF	End of IF section: ENDIF <Variable>%%. Example: %%ENDIF NetworkDHCP%%.

Network Note

NetworkDNS1, NetworkDNS2, NetworkGateway, NetworkIP, NetworkSubnet can also be specified with a postfix that specifies the part of the IP address from 0-3, e.g. NetworkIP.0, NetworkIP.1, NetworkIP.2, NetworkIP.3.