Auto Provisioning - Variables in Templates

A provisioning template is built from placeholder variables written in the form {{.VariableName}}. When Cloud Voice provisions a device, it reads the template and replaces each placeholder with the actual value for that device, so a single template can configure many phones or gateways. This page lists the variables you can use, grouped by the area of configuration they control. For background on how templates fit into device rollout, see Auto Provisioning Overview.

Several variable names end in a numbered placeholder such as _X. In those sections X stands for an index, for example a handset ID, template ID, codec priority, or function key ID. The exact meaning is noted at the start of each affected section.

How to read this page

This is a lookup reference, not a procedure. Each entry is a placeholder that Cloud Voice fills in per device at provisioning time. A variable only has an effect on devices that support the matching setting, and the brand or model heading above each group (for example the DECT or Yealink W80B sections) tells you which devices those variables apply to.

Preference settings

Variable	Description
{{.PhoneWebLanguage}}	Language used on the phone’s web interface.
{{.PhoneLanguage}}	Language used on the phone’s own display.
{{.Tones}}	The phone’s default ringtone.
{{.CallWaiting}}	Turns call waiting on or off.
{{.PhoneUser}}	Username of the admin account used to sign in to the phone’s web interface.
{{.PhonePassword}}	Password of the admin account for the phone’s web interface.
{{.VarPassword}}	Password of the var account for the phone’s web interface.
{{.UserPassword}}	Password of the user account for the phone’s web interface.
{{.TimeZone}}	The time zone.
{{.TimeZoneName}}	The name of the time zone.
{{.DaylightSavingTime}}	The daylight saving time setting.
{{.PrimaryNtpServer}}	Address of the primary NTP (Network Time Protocol) server, which the phone uses to set its clock.
{{.SecondaryNtpServer}}	Address of the secondary NTP server, used if the primary one cannot be reached.
{{.TimeFormat}}	The time format.
{{.DateFormat}}	The date format.
{{.DateSeparatorFormat}}	Character that separates the parts of the date.
{{.TransferModeViaDsskey}}	Transfer mode applied to function keys.
{{.SuppressDtmfDisplay}}	Controls whether the phone hides DTMF (Dual-Tone Multi-Frequency, the tones the keypad makes) digits on screen.
{{.AutoProvisionServerUrl}}	URL of the provisioning server.
{{.AutoProvisionServerUrlWithoutProtocol}}	Provisioning server URL with the transport protocol omitted.
{{.AutoProvisionServerProtocolUppercase}}	Transport protocol from the provisioning URL, written in uppercase.
{{.AutoProvisionServerProtocolLowercase}}	Transport protocol from the provisioning URL, written in lowercase.
{{.ProvisioningFile}}	Name of the configuration file.
{{.FirmwareUrl}}	URL of the firmware.
{{.FirmwareUrlWithoutProtocol}}	Firmware URL with the transport protocol omitted.
{{.FirmwareFile}}	Name of the firmware file.
{{.FirmwareFullDownloadUrl}}	Complete firmware download URL.
{{.FirmwareVersion}}	Firmware version.
{{.EnableUacsta}}	Turns uaCSTA on or off. uaCSTA is a protocol that lets a computer application control the phone, used for features such as click-to-dial.
{{.AlertInfoText_X}}	Alert-Info text that prompts the phone to play a particular ringtone.
{{.AlertInfoRingtone_X}}	Ringtone that pairs with the matching Alert-Info entry.
{{.WallpaperImageServerUrl}}	URL of the phone’s wallpaper image.
{{.WallpaperFileName}}	File name of the wallpaper image.
{{.ScreenSaverImageServerUrl}}	URL of the screensaver image.
{{.ScreensaverFileName}}	File name of the screensaver image.
{{.BootLogoImageServerUrl}}	URL of the boot logo image.
{{.BootLogoFileName}}	File name of the boot logo image.
{{.ScreensaverWaitTime}}	Idle time, in seconds, before the screensaver starts.
{{.VoicemailPowerNotifications}}	Controls whether the power LED flashes when a new voicemail or text message arrives.
{{.MissedCallPowerNotifications}}	Controls whether the power LED flashes when a call is missed.
{{.BlfStatusChangeExitScreen}}	Controls whether the phone leaves the screensaver when a BLF (Busy Lamp Field) status changes. A BLF key shows whether another extension is idle, ringing, or on a call.

Firmware variables point the phone at an update

The firmware variables tell the phone which firmware image to download and install. Make sure the URL, file name, and version all refer to the same intended build. Pointing a phone at the wrong or incompatible firmware interrupts service while it re-flashes and, in the worst case, can leave the device needing manual recovery.

VLAN settings for phones

VLAN (Virtual Local Area Network) settings place the phone’s network traffic onto a tagged segment. Most desk phones have two Ethernet ports: a WAN (Wide Area Network) port that connects to the switch, and a PC port that a computer can be daisy-chained through.

Variable	Description
{{.WanVlanEnable}}	Turns VLAN on or off for the phone’s WAN port.
{{.WanVlanId}}	VLAN ID for the WAN port.
{{.WanVlanPriority}}	VLAN priority for the WAN port.
{{.PcVlanEnable}}	Turns VLAN on or off for the phone’s PC port.
{{.PcVlanId}}	VLAN ID for the PC port.
{{.PcVlanPriority}}	VLAN priority for the PC port.
{{.DhcpVlanEnable}}	Controls whether the phone acquires its VLAN ID through a DHCP (Dynamic Host Configuration Protocol) option.
{{.DhcpVlanOption}}	DHCP option(s) the phone reads the VLAN ID from. Separate multiple options with commas.

VLAN IDs must match the switch

The VLAN ID you set here has to match the VLAN configured on the switch port the phone plugs into. A mismatch can leave the phone unable to reach the network or register to the PBX, and recovering it often means a factory reset at the desk. Confirm the correct VLAN with whoever manages the network before you provision.

Contact settings for Yealink, Flyingvoice, Wildix, and Dinstar phones

These variables load shared and personal phonebooks onto phones from the listed manufacturers.

Variable	Description
{{.CompanyPbUrl}}	URL of the company phonebook file.
{{.CompanyPbName}}	Name of the company phonebook.
{{.PersonalPbUrl}}	URL of the personal phonebook file.
{{.PersonalPbName}}	Name of the personal phonebook.

Account settings for IP phones

These variables register an extension on a desk phone. Registration uses SIP (Session Initiation Protocol), the signalling protocol that connects the phone to the PBX (Private Branch Exchange, your phone system).

Variable	Description
{{.EnbAccount}}	Turns extension registration on or off.
{{.AccountLabel}}	The extension label.
{{.AccountDisplayName}}	Display name of the extension.
{{.AccountRegistrationName}}	Registration name of the extension.
{{.AccountRegistrationExtNumber}}	Registration number of the extension.
{{.AccountRegistrationPassword}}	Registration password of the extension.
{{.AccountSipServerAddr}}	Address of the PBX the extension registers to.
{{.AccountSipServerPort}}	Port on the PBX the extension registers to.
{{.AccountSipServerTransportType}}	Transport protocol used for registration.
{{.AutoAnswer}}	Turns auto answer on or off.
{{.CheckVoicemail}}	Feature code used to check voicemail.

Rendered templates contain live credentials

The registration name, number, and password placeholders resolve to the working SIP credentials an extension uses to connect. Once a template is rendered for a device it holds real, usable credentials: anyone who obtains it could register as that extension and place calls at your account’s expense. Handle exported or edited templates as sensitive files, and do not share them over insecure channels.

Account settings for DECT phones

DECT (Digital Enhanced Cordless Telecommunications) is the standard used by cordless handsets that pair with a base station. In this section, X is the handset ID.

Variable	Description
{{.EnbAccount_X}}	Turns extension registration on or off.
{{.SRTP_X}}	Turns SRTP on or off for the extension. SRTP (Secure Real-time Transport Protocol) encrypts the call audio, and the PBX side must support it too.
{{.AccountLabel_X}}	The extension label.
{{.AccountDisplayName_X}}	Display name of the extension.
{{.AccountRegistrationName_X}}	Registration name of the extension.
{{.AccountRegistrationExtNumber_X}}	Registration number of the extension.
{{.AccountRegistrationPassword_X}}	Registration password of the extension.
{{.AccountSipServerAddr_X}}	Address of the provisioning server the extension registers to.
{{.AccountSipServerPort_X}}	Port of the provisioning server the extension registers to.
{{.AccountSipServerTransportType_X}}	Transport protocol used for registration.
{{.HandsetIPUI_X}}	IPUI (International Portable User Identity) used to register the handset, similar to a serial number that identifies the specific handset.
{{.CheckVoicemail_X}}	Feature code used to check voicemail.

SIP server template for Yealink W80B

In this section, X is the template ID and can be 1, 2, or 3.

Variable	Description
{{.TemplateNameX}}	The template name.
{{.TemplateServerAddrX}}	Address of the PBX the extension registers to.
{{.TemplateServerPortX}}	Port on the PBX the extension registers to.
{{.AcountSipServerTemplate}}	Transport protocol used for registration.
{{.HandsetIPUI_X}}	IPUI used to register the handset.

Audio codec

A codec is the method used to compress and decompress the call audio. In this section, X is the codec priority and can be 1, 2, 3, or 4.

Variable	Description
{{.AccountAudioCodec_X}}	Priority position of the audio codec.
{{.AudioCodecsPriorities}}	The combined priority order of the audio codecs.
{{.AccountCodecPcmu}}	Turns the PCMU codec on or off.
{{.AccountCodecPcmu_Priority}}	Priority of the PCMU codec.
{{.AccountCodecPcma}}	Turns the PCMA codec on or off.
{{.AccountCodecPcma_Priority}}	Priority of the PCMA codec.
{{.AccountCodecIlbc}}	Turns the iLBC codec on or off.
{{.AccountCodecIlbc_Priority}}	Priority of the iLBC codec.
{{.AccountCodecIlbc_15_2_Kbps}}	Turns the iLBC_15_2 codec on or off.
{{.AccountCodecIlbc_15_2_Kbps_Priority}}	Priority of the iLBC_15_2 codec.
{{.AccountCodecIlbc_13_33_Kbps}}	Turns the iLBC_13_33 codec on or off.
{{.AccountCodecIlbc_13_33_Kbps_Priority}}	Priority of the iLBC_13_33 codec.
{{.AccountCodecG722}}	Turns the G722 codec on or off.
{{.AccountCodecG722_Priority}}	Priority of the G722 codec.
{{.AccountCodecG729}}	Turns the G729 codec on or off.
{{.AccountCodecG729_Priority}}	Priority of the G729 codec.
{{.AccountCodecG726_32}}	Turns the G726_32 codec on or off.
{{.AccountCodecG726_32_Priority}}	Priority of the G726_32 codec.
{{.AccountCodecSpeex}}	Turns the Speex codec on or off.
{{.AccountCodecSpeex_Priority}}	Priority of the Speex codec.
{{.AccountAdpcmCodec}}	Turns the Adpcm codec on or off.
{{.AccountCodecAdpcm_Priority}}	Priority of the Adpcm codec.
{{.AccountCodecMpeg4}}	Turns the Mpeg4 codec on or off.
{{.AccountCodecMpeg4_Priority}}	Priority of the Mpeg4 codec.
{{.AccountCodecGsm}}	Turns the GSM codec on or off.
{{.AccountCodecGsm_Priority}}	Priority of the GSM codec.
{{.AccountCodecOpus}}	Turns the Opus codec on or off.
{{.AccountCodecOpus_Priority}}	Priority of the Opus codec.

Keep at least one codec in common

A codec is only used on a call if it is enabled on both the phone and the PBX, and the priority values decide the order the phone offers them in. If the phone and the PBX share no common codec, the call can connect but carry no audio. Leaving a widely supported codec such as PCMU or PCMA enabled is a safe default.

Video codec

In this section, X is the codec priority and can be 1, 2, 3, or 4.

Variable	Description
{{.AccountVideoCodec_X}}	Priority position of the video codec.
{{.AccountCodecH264}}	Turns the H264 codec on or off.
{{.AccountCodecH264_Priority}}	Priority of the H264 codec.
{{.AccountCodecH264_Hp}}	Turns the H264_Hp codec on or off.
{{.AccountCodecH264_Hp_Priority}}	Priority of the H264_Hp codec.
{{.AccountCodecH263}}	Turns the H263 codec on or off.
{{.AccountCodecH263_Priority}}	Priority of the H263 codec.
{{.AccountCodecH263_P}}	Turns the H263_P codec on or off.
{{.AccountCodecH263_P_Priority}}	Priority of the H263_P codec.
{{.AccountCodecVp8}}	Turns the Vp8 codec on or off.
{{.AccountCodecVp8_Priority}}	Priority of the Vp8 codec.

Function key

A function key is a programmable button on the phone (also called a DSS key). In this section, X is the function key ID.

Variable	Description
{{.FunctionkeyType_X}}	The function key’s type.
{{.FunctionkeyType2_X}}	The function key’s type, used for Dynamic VPK (Virtual Programmable Key).
{{.FunctionkeySubtype_X}}	The function key’s subtype.
{{.FunctionkeyLine_X}}	Extension the function key applies to.
{{.FunctionkeyCodeValue_X}}	Feature code assigned to the function key.
{{.FunctionkeyValue_X}}	The object the function key acts on.
{{.FunctionkeyExtension_X}}	Number whose calls the function key can pick up.
{{.FunctionkeyCodeExtension_X}}	Pickup code the function key uses.
{{.FunctionkeyLabel_X}}	Label shown for the function key on the phone screen.

LDAP directory

LDAP (Lightweight Directory Access Protocol) lets the phone look up contacts from a central directory server instead of a locally stored phonebook. In this section, X is the template ID and can be 1, 2, or 3.

Variable	Description
{{.EnableLdap_X}}	Enables the LDAP directory.
{{.LdapName_X}}	Name of the LDAP directory.
{{.LdapMode_X}}	The LDAP mode.
{{.LdapHost_X}}	Address of the LDAP server.
{{.LdapNameFilter_X}}	The LDAP name filter.
{{.LdapNumFilter_X}}	The LDAP number filter.
{{.LdapNameAttr_X}}	Name attribute returned by the LDAP server.
{{.LdapNumAttr_X}}	Number attribute returned by the LDAP server.
{{.LdapDisplayName_X}}	Name shown for each search result on the phone.
{{.LdapMaxHit_X}}	Maximum number of results the LDAP server returns.
{{.LdapIncomingLookup_X}}	Controls whether the phone runs an LDAP search on an incoming call.
{{.LdapDialLookup_X}}	Controls whether the phone runs an LDAP search when placing a call.
{{.LdapSort_X}}	Controls whether the phone sorts results in alphabetical and numerical order.
{{.LdapPort_X}}	Port of the LDAP server.
{{.LdapBase_X}}	Base entry of the LDAP directory.
{{.LdapUser_X}}	User account used to access the LDAP server.
{{.LdapPassword_X}}	Password used to access the LDAP server.

Gateway

These variables apply to VoIP gateways rather than phones. LAN (Local Area Network) and PPPoE (Point-to-Point Protocol over Ethernet) settings define how the gateway connects to the network.

Variable	Description
{{.KeyAsSend}}	Turns the Key as Send feature on or off.
{{.SipVoipServerIdx}}	ID of the VoIP server template.
{{.AdminPassword}}	The admin password.
{{.EnbLanSettings}}	Turns LAN settings on or off.
{{.Hostname}}	The host name.
{{.LanIpAddress}}	Primary IP address of the LAN port.
{{.LanSubnetMask}}	Subnet mask of the LAN port.
{{.LanGateway}}	Gateway of the LAN port.
{{.LanPrimaryDns}}	Primary DNS (Domain Name System) server of the LAN port.
{{.LanSecondaryDns}}	Secondary DNS server of the LAN port.
{{.LanIpAddress2}}	Secondary IP address of the LAN port.
{{.LanSubnetMask2}}	Secondary subnet mask of the LAN port.
{{.PppoeUsername}}	PPPoE username.
{{.PppoePassword}}	PPPoE password.

Others

Variable	Description
{{.MacAddress}}	The phone’s MAC (Media Access Control) address, the hardware identifier printed on the device.

Enter the MAC address without separators

Type the MAC address as a continuous string with no : separators, for example 09139876900e. Cloud Voice matches a device to its configuration by MAC address, so a value that is wrongly formatted or incorrect means the device will not be provisioned.