📄 Auto Provisioning - Variables in Templates

The provision templates make use of a set of variables that are replaced by the actual value when a device is provisioned. This topic shows you the variables used in the provisioning templates.

Preference settings

Variable	Description
`{{PhoneWebLanguage}}`	The language configured on phone web interface.
`{{PhoneLanguage}}`	The language configured on phone interface.
`{{Tones}}`	The default ringtone of the phone.
`{{CallWaiting}}`	Enable or disable call waiting feature.
`{{PhoneUser}}`	The user name for logging in to the phone web interface.
`{{PhonePassword}}`	The password for logging in to the phone web interface.
`{{TimeZone}}`	The time zone.
`{{TimeZoneName}}`	The time zone name.
`{{DaylightSavingTime}}`	The daylight saving time.
`{{PrimaryNtpServer}}`	The primary NTP server address.
`{{SecondaryNtpServer}}`	The second NTP server address.
`{{TimeFormat}}`	The time format.
`{{DateFormat}}`	The date format.
`{{DateSeparatorFormat}}`	The date separator format.
`{{TransferModeViaDsskey}}`	The transfer mode for function key.
`{{SuppressDtmfDisplay}}`	Enable or disable the IP phone to suppress the display of DTMF digits.
`{{AutoProvisionServerUrl}}`	The URL of provision server.
`{{AutoProvisionServerUrlWithoutProtocol}}`	The URL of provision server without transport protocol.
`{{AutoProvisionServerProtocolUppercase}}`	The uppercase representation of the transport protocol in the auto provisioning URL.
`{{AutoProvisionServerProtocolLowercase}}`	The lowercase representation of the transport protocol in the auto provisioning URL.
`{{ProvisioningFile}}`	The name of configuration file.
`{{FirmwareUrl}}`	The URL of firmware.
`{{FirmwareUrlWithoutProtocol}}`	The URL of firmware without transport protocol.
`{{FirmwareFile}}`	The name of firmware.
`{{FirmwareFullDownloadUrl}}`	The full download URL of firmware.
`{{FirmwareVersion}}`	The version of firmware.
`{{EnableUcsta}}`	Enable or disable uaCSTA.
`{{AlertInfoText_X}}`	The alert info text to trigger the IP phone to play a specific ring tone.
`{{AlertInfoRingtone_X}}`	The specific ring tone corresponding to Alert info.

Contact settings for Yealink / Flyingvoice / Wildix / Dinstar phones

Variable	Description
`{{CompanyPbUrl}}`	The URL of company contact file.
`{{CompanyPbName}}`	The name of company contact.
`{{PersonalPbUrl}}`	The URL of personal contact file.
`{{PersonalPbName}}`	The name of personal contact.

Account settings for IP phones

Variable	Description
`{{EnAbAccount}}`	Enable or disable extension registration.
`{{AccountLabel}}`	The extension label.
`{{AccountDisplayName}}`	The display name of extension.
`{{AccountRegistrationName}}`	The registration name of extension.
`{{AccountRegistrationExtNumber}}`	The registration number of extension.
`{{AccountRegistrationPassword}}`	The registration password of extension.
`{{AccountSipServerAddr}}`	The URL of PBX server for extension registration.
`{{AccountSipServerPort}}`	The port of PBX server for extension registration.
`{{AccountSipServerTransportType}}`	The type of transport protocol for extension registration.
`{{AutoAnswer}}`	Enable or disable auto answer feature.
`{{CheckVoicemail}}`	The voicemail feature code.

Account settings for DECT phones (k is the handset ID)

Variable	Description
`{{EnAbAccount_k}}`	Enable or disable extension registration.
`{{Srtp_k}}`	Enable or disable extension SRTP feature.
`{{AccountLabel_k}}`	The extension label.
`{{AccountDisplayName_k}}`	The display name of extension.
`{{AccountRegistrationName_k}}`	The registration name of extension.
`{{AccountRegistrationExtNumber_k}}`	The registration number of extension.
`{{AccountRegistrationPassword_k}}`	The registration password of extension.
`{{AccountSipServerAddr_k}}`	The URL of provisioning server for extension registration.
`{{AccountSipServerPort_k}}`	The port of provisioning server for extension registration.
`{{AccountSipServerTransportType_k}}`	The type of transport protocol for extension registration.
`{{CheckVoicemail_k}}`	The voicemail feature code.

SIP server template for Yealink W80B (k is the template ID, X=1, 2 or 3)

Variable	Description
`{{TemplateName_X}}`	The template name.
`{{TemplateServerAddr}}`	The URL of PBX server for extension registration.
`{{TemplateServerPort}}`	The port of PBX server for extension registration.
`{{AccountSipServerTemplate}}`	The type of transport protocol for extension registration.

Audio codec (x is the codec priority, X=1, 2, 3 or 4)

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

Video codec (x is the codec priority, X=1, 2, 3 or 4)

Variable	Description
`{{AccountVideoCodec_X}}`	The priority of the video codec.
`{{AccountCodecH264}}`	Enable or disable H264 codec.
`{{AccountCodecH264_Priority}}`	The priority of the H264 codec.
`{{AccountCodecH264_Hp}}`	Enable or disable H264_Hp codec.
`{{AccountCodecH264_Hp_Priority}}`	The priority of the H264_Hp codec.
`{{AccountCodecH263}}`	Enable or disable H263 codec.
`{{AccountCodecH263_Priority}}`	The priority of the H263 codec.
`{{AccountCodecH263_P}}`	Enable or disable H263_P codec.
`{{AccountCodecH263_P_Priority}}`	The priority of the H263_P codec.
`{{AccountCodecVp8}}`	Enable or disable Vp8 codec.
`{{AccountCodecVp8_Priority}}`	The priority of the Vp8 codec.

Function key (k is the function key ID)

Variable	Description
`{{FunktionKeyType_k}}`	The type of function key.
`{{FunktionKeyType2_k}}`	The type of function key (for Dynamic VPK).
`{{FunktionKeySubtype_k}}`	The subtype of function key.
`{{FunktionKeyLine_k}}`	The extension to which function key applies.
`{{FunktionKeyCodeValue_k}}`	The feature code of function key.
`{{FunktionKeyValue_k}}`	The object of function key.
`{{FunktionKeyExtension_k}}`	The number where the call can be picked up by function key.
`{{FunktionKeyCodeExtension_k}}`	The pickup code applied for function key.
`{{FunktionKeyLabel_k}}`	The label of function key that is displayed on phone screen.

LDAP Directory (k is the template ID, X=1, 2 or 3)

Variable	Description
`{{EnableLdap_X}}`	Enable LDAP directory.
`{{LdapName_X}}`	Specify the name of LDAP directory.
`{{LdapMode_X}}`	Set up the LDAP mode.
`{{LdapHost_X}}`	The address of LDAP Server.
`{{LdapNameFilter_X}}`	The LDAP name filter.
`{{LdapNumFilter_X}}`	The LDAP number filter.
`{{LdapNameAttr_X}}`	The name attribute returned by LDAP Server.
`{{LdapNumAttr_X}}`	The number attribute returned by LDAP Server.
`{{LdapDisplayName_X}}`	The name of the search results displayed on IP phones.
`{{LdapMaxHit_X}}`	The maximum number of search results to be returned by LDAP Server.
`{{LdapIncomingLookup_X}}`	Enable or disable IP phone to perform an LDAP search when receiving an incoming call.
`{{LdapDialLookup_X}}`	Enable or disable IP phone to perform an LDAP search when placing a call.
`{{LdapSort_X}}`	Enable or disable IP phone to sort out search results in alphabetical and numerical order.
`{{LdapPort_X}}`	The port of LDAP Server.
`{{LdapBase_X}}`	The base entry of the LDAP directory.
`{{LdapUser_X}}`	The user accessing the LDAP Server.
`{{LdapPassword_X}}`	The password for accessing to the LDAP Server.

Others

Variable	Description
`{{MacAddress}}`	The MAC address of phone.

📝 Note: Here the value does not need a separator of : . For example, 891359769886.

📋 Auto Provisioning - Supported Devices 👤 User Roles & Permissions