Variables used in the IP Phone 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.

%%blffirstname%%

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.

%%blflastname%%

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%%

The extension number of your BLF or Speed Dial

The target number for BLF, Speed Dial, Queue Login, Profile Status, Shared Parking

%%blktime%%

Backlight timeout

The timeout that specifies when the phone will dim the display

%%codec1%%

Codec value priority 1.

You can specify the value of the 1st preferred codec to be used.

%%codec2%%

Codec value priority 2.

You can specify the value of the 2nd preferred codec to be used.

%%codec3%%

Codec value priority 3.

You can specify the value of the 3rd preferred codec to be used.

%%codec4%%

Codec value priority 4.

You can specify the value of the 4th preferred codec to be used.

%%datestyle%%

The date format of the IP Phone

Specifies the format of the date shown on the phone's display.

%%defringtone%%

The default ringtone of the IP Phone

The ringtone that will be used for most calls, like extension to extension.

%%DESKPHONE_PASSWORD%%

Phone Web login password.

Also used for CTI calls authentication.

%%DKtype%%

Used only for Yealink phones. Internal to Yealink.

The DSS Key type, like Speed Dial, BLF, Shared Parking etc.

dstEnableDisable

Configures the phone to read the parameter to enable or disable DST settings.

Legacy

%%extension_auth_id%%

Extension SIP Authentication ID.

%%extension_auth_pw%%

Extension 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. Yealink specific value.

%%langwebUI%%

Language used to configure the phone's web UI.

Yealink specific value.

%%langwebUI2%%

Language used to configure the phone's web UI.

Yealink model specific value.

%%Line%%

Used only for Yealink phones. Internal to Yealink. Yealink phone need to know line ID that the BLF will use

This is always set to 1 for Yealink

%%lldpenabled%%

Enable LLDP

Enable or disable the LLDP feature of the phone

%%local_sbc_ip%%

Session Border Controller IP address.

The Proxy IP of your 3CX SBC.

%%local_sbc_port%%

Session Border Controller port.

The SIP port of your 3CX SBC.

%%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 for shared / personal phonebooks, and to define your device config file name that 3CX will generate for phone provisioning.

%%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

%%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

%%multicastenabled%%

Enabled Multicast Listening for local installations.

Used in Multicast Ring Groups

%%multicastrgip1%%

The listening address for Multicast Ring Groups

%%multicastrgport1%%

The listening port for Multicast Ring Groups

%%multicastrgname1%%

Multicast Ring Group Label

%%multicastrgipport1%%

The listening address and port  for Multicast Ring Groups

Some phones need it as a single variable ie. certain Snom models

%%param::DIALCODEPROFILE%%

Dial Code value taken from 3CX Phone System configuration.

Previously used by legacy phones to dial the code when you enabled DND for example.

Can be used to change user profile status. Default value is *3.

Example:”%%param::DIALCODEPROFILE%%2″ – DND ON and “%%param::DIALCODEPROFILE%%0” – DND OFF.

No longer used, modern phones update DND via uaCSTA.

%%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.

Legacy

%%param::time_dst_end_hour%%

DST parameters – Hour where DST ends.

Legacy

%%param::time_dst_end_month%%

DST parameters – Month where DST ends.

Legacy

%%param::time_dst_saving_minutes%%

Daylight savings time in Minutes.

Legacy

%%param::time_dst_start_day%%

DST parameters – Day where DST starts.

Legacy

%%param::time_dst_start_hour%%

DST parameters – Hour where DST starts.

Legacy

%%param::time_dst_start_month%%

DST parameters – Month where DST starts.

Legacy

%%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

%%phonesipport%%

The phone’s local SIP port.

Legacy - used for STUN phones

%%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%%

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

%%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.

queuecrt1 (queuecrtX)

IF statement that applies when using custom queue ringtones.

%%queueid%%

Custom Queue ringtone ID

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.

Legacy - used for STUN phones

%%rtp_port_min%%

RTP port range Minimum value

Legacy - used for STUN phones

%%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.

Used by some doorphones as the remote door unlock DTMF code.

%%XFERmethod_Value%%

DSS transfer method

Defines the transfer method (blind or attended) of DSS key