The 3CX Phone Provisioning Templates make use of a set of variables which are replaced by the extension’s details when an extension is provisioned. There are situations where you might need to customize the Phone Provisioning Templates as explained in ‘Editing the Phone Provisioning Templates‘.
The following table documents the variables used in the 3CX Provisioning Templates.
VARIABLE | DESCRIPTION | COMMENTS |
%%blf1%% | BLF followed by digit 1, 2, 3, etc. | The BLF extension placeholder used to provision a specific phone key. In the Extension settings, Provisioning section, you can provision a phone with BLF keys. Configure the entries accordingly, depending on how many keys you provision, or how many sidecars (BLF key expansion modules) you attach to your phone. |
%%blffirstname1%% | First name of selected extension used for BLF. | If you provision a phone to monitor extension 105, and the first name of extension 105 is James, you will see James in the LCD display of the BLF key / sidecar. |
%%blflastname1%% | Last name of selected extension used for BLF. | If you provision a phone to monitor extension 105, and the last name of extension 105 is Brown, you will see Brown in the LCD display of the BLF key / sidecar. |
%%blfno%% | Used to be able to pick up a call by pressing the BLF key. | |
%%blktime%% | Backlight timeout | The timeout that specifies when the phone will dim the display |
%%codec1%% | Codec value priority 1. | In the provisioning section, you can specify the first preferred codec to be used. |
%%codec2%% | Codec value priority 2. | In the provisioning section, you can specify the first preferred codec to be used. |
%%codec3%% | Codec value priority 3. | In the provisioning section, you can specify the first preferred codec to be used. |
%%codec4%% | Codec value priority 4. | In the provisioning section, you can specify the first preferred codec to be used. |
%%datestyle%% | The date format of the IP Phone | Specifies the format of the date shown on phone's display |
%%defringtone%% | The default ringtone of the IP Phone | The ringtone that will be used for the simple calls |
%%DESKPHONE_PASSWORD%% | Phone Web login password. | Also used for CTI calls authentication. |
%%DIALCODECONFGATEWAY%% | Conference extension number | |
%%DKtype%% | Used only for Yealink phones. Internal to Yealink. | Yealink phone need to know line type in order for a BLF key to change behavior. |
%%dstEnableDisable%% | Configures the phone to read the parameter to enable or disable DST settings. | |
%%dstEnableDisable%% | Configures the phone to read the parameter to enable or disable DST settings. | |
%%extension_auth_id%% | Extension Authentication ID. | |
%%extension_auth_pw%% | Extension Authentication Password. | SIP authentication password |
%%extension_first_name%% | Extension First Name. | |
%%extension_last_name%% | Extension Last Name. | |
%%extension_number%% | Extension Number. | |
%%firmware%% | Firmware file name. | |
%%langlcdUI%% | Language used to configure the phone – LCD Screen. | Some phones have the ability to configure the LCD and the Web management separately. |
%%langwebUI%% | Language used to configure the phones web UI. | |
%%langwebUI2%% | Language used to configure the phones web UI. | Some phones need extra parameters |
%%Line%% | Used only for Yealink phones. Internal to Yealink. Yealink phone need to know line ID in order for a BLF key to change behavior. | |
%%lldpenabled%% | Enable LLDP | Enable or disable the LLDP feature of the phone |
%%local_sbc_ip%% | Session Border Controller IP address. | This is the variable used to provision the phones using Session Border Controller mode. |
%%local_sbc_port%% | Session Border Controller port. | This is the variable used to provision the phones using Session Border Controller mode. |
%%logo_filename%% | Logo filename | The name of the custom logo file |
%%logo%% | Custom logo path | The path to custom logo file that includes the Custom Logo folders and file names |
%%mac_address%% | The MAC address of the phone – used to generate a suitable configuration file for each phone. | |
%%missedled%% | Power LED functionality when the phone has a missed call | Enables or disables the power indicator LED to flash when the IP phone has a missed call |
%%multicastenabled%% | ||
%%multicastrgip1%% | ||
%%multicastrgipport1%% | Multicast address | The IP address and SIP port of the Multicast Ring Group |
%%multicastrgname1%% | Multicast Label | The Label of the Multicast Ring Group |
%%multicastrgport1%% | ||
%%mwiled%% | Power LED functionality when the phone has a voicemail | Enables or disables the power indicator LED to flash when the IP phone receives a voicemail |
%%param::DIALCODEPROFILE%% | Dial Code value taken from 3CX Phone System configuration. | Can be used to change user profile status. Default value is *3. Example:”%%param::DIALCODEPROFILE%%2″ – DND ON and “%%param::DIALCODEPROFILE%%0” – DND OFF. |
%%param::PBXPUBLICIP%% | Public IP Address/FQDN of the 3CX Phone System. | |
%%param::pickup%% | Pick up code taken from the 3CX Phone System configuration. | |
%%param::sipport%% | The SIP Port of the 3CX Phone System installation. | |
%%param::time_dst_end_day%% | DST parameters – Day where DST ends. | |
%%param::time_dst_end_hour%% | DST parameters – Hour where DST ends. | |
%%param::time_dst_end_month%% | DST parameters – Month where DST ends. | |
%%param::time_dst_saving_minutes%% | Daylight savings time in Minutes. | |
%%param::time_dst_start_day%% | DST parameters – Day where DST starts. | |
%%param::time_dst_start_hour%% | DST parameters – Hour where DST starts. | |
%%param::time_dst_start_month%% | DST parameters – Month where DST starts. | |
%%param::time_ntp_server%% | NTP (Network Time Protocol) server used. | |
%%param::time_timezone_ grandstream%% | Time zone formats for Grandstream Phones. | |
%%param::time_timezone_ grandstreamexec%% | Time zone formats for Grandstream Executive phones. | |
%%param::time_timezone_aastra%% | Time zone formats for Aastra phones. | |
%%param::time_timezone_cisco79x0%% | Time zone formats for Cisco79X0 phones. | |
%%param::time_timezone_cisco79x1%% | Time zone formats for Cisco79X1 phones. | |
%%param::time_timezone_cyberdata%% | Time zone formats for CyberData devices. | |
%%param::time_timezone_fanvil%% | Time zone formats for Fanvil phones. | |
%%param::time_timezone_htek%% | Time zone formats for Htek phones. | |
%%param::time_timezone_linksys%% | Time zone formats for Cisco Phones. | |
%%param::time_timezone_snom%% | Time zone formats for SNOM phones. | |
%%param::time_timezone_yealink%% | Time zone formats for Yealink phones. | |
%%param::time_utc_offset_minutes%% | DST offset parameter in minutes. | |
%%param::time_utc_offset_seconds%% | DST offset parameter in seconds. | / Not used anymore only Hour is used |
%%payload1%% | Payload values used to provision phones with specific codecs. | |
%%payload2%% | Payload values used to provision phones with specific codecs. | |
%%payload3%% | Payload values used to provision phones with specific codecs. | |
%%payload4%% | Payload values used to provision phones with specific codecs. | Can be local or external depending on the context and where it is used. |
%%pbx_ip%% | The IP Address/FQDN of the 3CX Phone System. | |
%%PHONE_IP%% | The IP address of the phone | |
%%PHONE_WEB_PASSWORD%% | The Web login password of the phones | Important when configuring a phone as a remote extension using STUN. |
%%phonesipport%% | The phones local SIP port. | |
%%PickupValue%% | Value taken from 3CX Phone System that refers to the PICKUP code. | Default value is *20*. |
%%PROVLINK.HOST%% | The FQDN of the installed 3CX Phone System | Example: %%PROVLINK.HOST%% that will provide the FQDN of the system |
%%PROVLINK.PATH%% | The Provisioning Path of the System | Example: %%PROVLINK.PATH%% that will provide the provisioning path of the system |
%%PROVLINK.PORT%% | The HTTP Port of the 3CX Phone System Installation. | Example: %%PROVLINK.PORT%% that will provide the provisioning port |
%%PROVLINK.PROTOCOL%% | Provisioning protocol | Can be only HTTP, i.e.“http” |
%%PROVLINK%% | Phone provisioning default URL. | This is the phone provisioning default URL. Provisioning URL’s are specified in the Settings-> Phone Provisioning tab. The provisioning URL will be automatically set according to the chosen Provisioning Method. Contains FQDN and Provisioning port |
%%PROVLINKEXT%% | Phone provisioning External/Public URL. Non secure. | This is the phone provisioning External/Public URL. It is non secure, because phones will be provisioned using HTTP protocol. |
%%PROVLINKEXTSEC%% | Phone provisioning External/Public URL. Secure. | This is the phone provisioning External/Public URL. It is secure, because phones will be provisioned using HTTPS protocol. |
%%PROVLINKLOCAL.HOST%% | Host part of phone provisioning Local URL | |
%%PROVLINKLOCAL.PATH%% | Provisioning folder path of phone provisioning Local full non-secure URL | |
%%PROVLINKLOCAL.PORT%% | Port part of phone provisioning Local full non-secure URL | |
%%PROVLINKLOCAL.PROTOCOL%% | Provisioning protocol | |
%%PROVLINKLOCAL%% | Phone provisioning Internal/Local URL. Non secure. | This is the phone provisioning Internal/Local URL. It is non secure, because phones will be provisioned using HTTP protocol. |
%%queueid%% | The Custom Queue ringtone of the IP Phone | Used when the "Use custom ringtones per queue" is enabled |
%%queueringtone%% | The default Queue ringtone of the IP Phone | Used when the "Use default ringtone for all queues" is enabled |
%%queueringtonevalue%% | The "Alert-Info" text that will be sent to to the IP Phone | Used when the "Use custom ringtones per queue" is enabled |
%%rtp_port_max%% | RTP port range Maximum value. | |
%%rtp_port_min%% | RTP port range Minimum value | |
%%scrsavertime%% | Screensaver timeout | The timeout that specifies when the phone will show the Screensaver on the display |
%%timestyle%% | The time format of the IP Phone | Specifies the format of time shown on phone's display |
%%TimeZoneName%% | Time zone name in the format – each phone is different. | |
%%userphone%% | Used only for SNOM phones to change the behavior of a function key. | |
%%value%% | The value required to configure a BLF key. | Each phone has different values and each combination of values mean something. The available values are documented in each template in the top part. |
%%vlanpcenabled%% | Enable VLAN on PC port | Enables or disables the VLAN on the PC port of the phone |
%%vlanpcportid%% | PC port VLAN ID | VLAN ID used on the PC port of the phone |
%%vlanpcportpriority%% | PC port VLAN Priority | VLAN Priority used on the PC port of the phone |
%%vlanwanenabled%% | Enable VLAN on WAN port | Enables or disables the VLAN on the WAN port of the phone |
%%vlanwanportid%% | WAN port VLAN ID | VLAN ID used on the WAN port of the phone |
%%vlanwanportpriority%% | WAN port VLAN Priority | VLAN Priority used on the WAN port of the phone |
%%vm_number%% | The Voicemail Extension number. | The Voicemail Extension number which is provisioned so you can press the VM button on the phone and call the voicemail service directly. |
%%VMPIN%% | Extension Voicemail PIN Number. | |
%%XFERmethod_Value%% | DSS transfer method | Defines the transfer method (blind or attended) of DSS key |
distinctive_ring_tones.alert_info.X.ringer | ||
distinctive_ring_tones.alert_info.X.text | ||
queuecrt1 (queuecrtX) | ||
sysparam.CUSTOMIZE_QUEUE_RINGTONES | 0 - Same ringtone for all Queues, 1 - distinctive ringtone per Queue |