This page lists all the variables included in the configuration files of the devices supported by VoipNow based on the equipment manufacturer.
Overview
In general, there are small differences between the configuration files of different devices belonging to the same manufacturer. That is why only the particular variables are highlighted in separate sections.
Common variables
The variables that are common to all the devices are grouped.
| Variable | Details |
<!TFTP_PRO_URL!> | Replaced with the FTP provisioning URL. |
<!NTPSERVERIP!> | Replaced with the IP address of the NTP Server (as defined in the Unified Communications → Timezone page). |
<!PROTOCOL!> | Replaced with the download protocol. |
<!PRO_SERVER_IP!> | Replaced with the HTTP provisioning server URL. |
<!PRO_PATH!> | Replaced with the HTTP provisioning server path. |
<!ADMINUSER!> | Replaced with the username of the administrator account for the phone web interface. The username is defined in the Provisioning page. |
<!ADMINPASS!> | Replaced with the password of the administrator account for the phone web interface. The password is defined in the Provisioning page. |
<!EXTENSIONUSER#<x>!> | Replaced with the extended number (e.g. <client_id>*<extension_id> of the extension connected to the device's line <x>. This tag is useful when creating a provisioning template for a device that cannot display the full <!EXTENSIONUSER!>. |
<!EXTENSIONPASS#<x>!> | Replaced with the password of the extension connected to the device's line <x>. |
<!CLIENTNAME#<x>!> | Replaced with the Contact name as defined in the contact information of the extension connected to the device's line <x>. This name is displayed on the device's screen. |
<!VOIPNOW_SERVER_IP!> | Replaced with the IP address of the VoipNow server. |
<!VOIPNOW_SERVER_PORT!> | Replaced with the port of the VoipNow server. |
<!EXTENSIONNUMBER#1!> | Replaced by the short extension number. |
Other variables
The Aastra devices supported by VoipNow are: 9112i, 480i CT, 480i, 9133i, 51i. Aastra 9112i, 9133i, 51i and 480i need the following supplementary variables:
<!AASTRA_TZ_NAME!>:Replaced with the time zone name used by the Aastra devices.<!AASTRA_TZ_CODE!>:Replaced with the time zone code used by the Aastra devices.<!AASTRA_TZ_MINUTES!>:Replaced with the time zone minutes used by the Aastra devices.<!NTPSERVERIP!>:Replaced with the IP address of the NTP Server (as defined in the Unified Communications → Timezone page).
The Cisco devices supported by VoipNow are: 7940, 7960, SPA504G. The replaceable variables common to the configuration files of all the Cisco devices are:
<!COMPANYNAME!>:Replaced with the Company name as defined in the extension's contact information. It is displayed on the top right corner of the screen.<!TIMEZONE!>:Replaced with the time zone the device is in.<!FIRMWARE!>:Replaced with the device's firmware version.
The Escene devices supported by VoipNow are ES410 and ES620. The replaceable variables common to the configuration files of these devices are:
<!TIMEZONE!>:Replaced with the time zone the device is in. Displayed as a GMT offset.<!ADMINUSER!>:Replaced with the username of the administrator account for the phone web interface. The username is defined in the Provisioning page.<!UPDATE_INTERVAL!>:Replaced with the time interval after which the device is resynchronized with the provisioning server to search for available configuration file updates.<!ENABLE_LINE_01#<x>!>:Replaced with the status (enabled or disabled) of the extension connected to the device's line <x>.
The Fanvil devices supported by VoipNow are C56 and C62. The replaceable variables common to the configuration files of these devices are:
<!FANVIL_VERSION!>:Replaced with the version of the configuration file.<!TIMEZONE!>:Replaced with the time zone the device is in. Displayed as a GMT offset.<!UPDATE_INTERVAL!>:Replaced with the time interval after which the device is resynchronized with the provisioning server to search for available configuration file updates.<!ENABLE_LINE_01#<x>!>:Replaced with the status (enabled or disabled) of the extension connected to the device's line <x>.<!ADMINUSER!>:Replaced with the username of the administrator account for the phone web interface. The username is defined in the Provisioning page.<!PHONE_MAC!>:Replaced with the MAC address of the device.<!FANVIL_PROTOCOL!>:Replaced with the protocol used for reading the configuration file.
The Grandstream devices supported by VoipNow are: gxp 2000, gxp 2020, Handy Tone 286, Handy Tone 486, Handy Tone 488, Handy Tone 502. The replaceable variables common to the configuration files of all the Grandstream devices are:
<!GS_FIRMWARE_UPGRADE!>:Variable used only with Grandstream devices to specify the protocol used in firmware and configuration provisioning.<!PRO_URL!>:Replaced with the provisioning URL based on the provisioning protocol used by the device.<!TIMEZONE!>:Replaced with the time zone the device is in. Displayed as offset in minutes to GMT.
Grandstream gxp 2000, 2020 and Handy Tone 488 need the supplementary variable <!ENABLE_LINE_01#<x>!> which is replaced with the status (enabled or disabled) of the extension connected to the device's line <x>.
The Linksys devices supported by VoipNow are: SPA-901, SPA-921, SPA-922, SPA-941, SPA-942, SPA-962, SPA2102, SPA8000, PAP-2T. The replaceable variables common to the configuration files of all the Linksys devices are:
<!KAMAILIO_SERVER_IP!>:Replaced with the IP address of the Kamailio server handling the voicemail messages.<!KAMAILIO_SERVER_PORT!>:Replaced with the port of the Kamailio server handling the voicemail messages.<!UPDATE_INTERVAL!>:Replaced with the time interval after which the device is resynchronized with the provisioning server to search for available configuration file updates.<!PRO_URL!>:Replaced with the provisioning URL based on the provisioning protocol used by the device.<!EXTENSION_LENGTH!>:Variable used when defining phone dial plans to fill the proper number of x characters.<!TIMEZONE!>:Replaced with the time zone the device is in. Displayed as a GMT offset.
Linksys SPA-901 to 962 need the following supplementary variables:
<!COMPANYNAME!>:Replaced with the Company name as defined in the extension's contact information. It is displayed on the top right corner of the screen.<!ENABLE_LINE_YESNO#<x>!>:Replaced if the line <x> should be enabled or disabled.
The Panasonic devices supported by VoipNow are: KX-UT123, KX-UT670. The replaceable variables that can be found in the configuration files of the devices mentioned above are:
<!ADMINUSER!>:Replaced with the username of the administrator account for the phone web interface. The username is defined in the Provisioning page.<!TIMEZONE!>:Replaced with the time zone the device is in. Displayed as a GMT offset.<!HTTP_PRO_URL!>:Replaced with the provisioning URL based on the provisioning protocol used by the device.<!UPDATE_INTERVAL!>:Replaced with the time interval after which the device is resynchronized with the provisioning server to search for available configuration file updates.
The Polycom devices supported by VoipNow are: IP 501, IP 550, IP 650, Soundpoint 300/301, Soundpoint 330/320. The replaceable variables common to the configuration files of all the Polycom devices are:
For the Device Configuration File #1:
<!PHONE_LMAC!>:Replaced with the device's MAC address.<!UNIQUEID!>:Replaced with the device's unique identification number.
For the Device Configuration File #3:
<!TIMEZONE!>:Replaced with the time zone the device is in. Displayed as a GMT offset.The Snom devices supported by VoipNow are: 300, 320, 360, M3. The replaceable variables common to the configuration files of all the Snom devices are:
<!TIMEZONE!>:Replaced with the time zone the device is in.<!PRO_URL!>:Replaced with the provisioning URL based on the provisioning protocol used by the device.<!UPDATE_INTERVAL!>:Replaced with the time interval after which the device is resynchronized with the provisioning server to search for available configuration file updates.
The replaceable variables that can be found in the Thomson ST2030S configuration files are:
For the Device Configuration File #1: <!TIMEZONE!>: Replaced with the time zone the device is in.
For the Device Configuration File #2: <!UNIQUEID!>: Replaced with the device's unique identification number.
The variable is used in the device's .cfg file name, obtained through a FTP request.
The Tiptel devices supported by VoipNow are: IP280, IP284, IP286. The replaceable variables common to the configuration files of all the Tiptel devices are:
For the Device Configuration File #1:
<!ENABLE_LINE_01#<x>!>:Replaced with the status (enabled or disabled) of the extension connected to the device's line <x>.<!TIMEZONE!>:Replaced with the time zone the device is in.
<!UPDATE_INTERVAL!>:Replaced with the time interval after which the device is resynchronized with the provisioning server to search for available configuration file updates.<!PRO_URL!>:Replaced with the provisioning URL based on the provisioning protocol used by the device.
For now, VoipNow supports the XRS 5440 device. The replaceable variables that can be found in its configuration files are:
<!TIMEZONE!>:Replaced with the time zone the device is in. Displayed as a GMT offset.<!ENABLE_LINE_01#<x>!>:Replaced with the status (enabled or disabled) of the extension connected to the device's line <x>.<!ADMINUSER!>:Replaced with the username of the administrator account for the phone web interface. The username is defined in the Provisioning page.
The Yealink devices supported by VoipNow are: SIP-T20P, SIP-T22P, SIP-T26P, SIP-T28P
Yealink and Tiptel devices share the same replaceable variables.
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.