Auto Provisioning
Aaron Bailey
Overview
Auto provisioning works with Option 66 to allow a SIP phone or gateway to provision itself by loading a configuration file hosted on the Voiceware server. Use of this feature is encouraged because it will save a lot of time during and post installation.
Voiceware version 4.3.0.6 added the ability to set Ringdown (hotline) and the disconnect polarity (loop or ground). New template files for the Phonesuite and Grandstream gateways are available to make use of these features. See their sections below for more info.
How To:
Enable option 66 is the local firewall and point it to the Voiceware server.
See Option 66 section below for the correct option 66 string format.
Setup a user, device, and endpoint in Voiceware
Ensure that the correct device is selected from the template drop down
Plug in the device, it should pull its configuration from Voiceware, reboot once or twice, and then be fully configured.
Log into Voiceware and navigate to the Endpoints page
On the sidebar click Manage Templates
Using the drop-down select the template file you wish to modify
Click download and save it to your computer
Edit the file as needed
From the Manage Templates screen select the template file again (if not already selected) and click delete. This will ensure that the edited copy will not be overwritten.
Select Browse under the “Upload a Template” section
Select the local edited copy of the template file
Click Upload
Once finished refresh the screen and ensure that the template file appears under the drop down of available template files
Voiceware has several data options or flags for use in a phones configuration file. The basic method for creating a new phone auto configuration file is to:
Download the base template file from either the phone manufactures website or from the configured phone itself
An existing template can also be downloaded and modified for different models of phone or gateway from the same vendor, this normally saves a lot of time
Insert the appropriate data flags (see below) into the correct areas of the file
Name the file with the correct naming format (again see below)
Upload and test the new file
While the above process seems straight forward in practice the process can take many hours. Below are some tips to help speed the process.
Download a blank config from the phone first.
Setup the phone via the GUI and test to make sure calling, speed dials, and voicemail work.
Download the configuration file again.
Compare the two, this will show you what data goes where and importantly what format that data is in.
Reference the phones manual for help with config file values that you don’t understand.
Create the template file and test
Don’t forget that you can watch logs of what file the phone is trying to pull from Voiceware, this is invaluable when trying to figure out what format the filename needs to be in (see Troubleshooting below)
In some configuration files there are lines with curly brackets “{“ or “}”. Having these can cause the template file to not generate. To fix put a {literal} tag around the line. See below
{literal}abal_Cfg={{}{}}12124{/literal}
Some phones require each dial plan item to be on a separate line. In this case we can use the code below to preform this function.
{assign var="splitmap" value="|"|explode:$config.digitmap}
PrefixRulesNum={$splitmap|count}
{assign var="digit" value="0"}
{foreach $splitmap as $dpentry}
PrefixRules{$digit}={$digit} {$dpentry} Voiceware
{assign var="digit" value=$digit+1}
Here is what each piece of the code does:
Assign var: this takes the dial plan string and separates each value based on the pipe “|” character.
PrefixRuleNum: This is optional, it provides a simple count of the resulting dial plan entries (it was required for one gateway brand)
assign var: Sets a variable with the value 0, required because each entry needed a unique number counting up from 0.
Foreach: assigns the variable “dpentry” for each of the values in the digit map.
PrefixRules: This is formatting unique to the gateway template in question. Modify this line to write out the template file as needed by the gateway.
Assign var: this last line increases the value of the “digit” variable by 1, again needed to provide a unique ID for each entry starting at 0.
If phones are not auto configuring to a system correctly or at all here are some things to check.
Double check the MAC address entered into the phones page is correct. If this is wrong the phone will likely never auto configure. Check the address or try and setup another phone.
Look for the config file in /var/lib/tftpboot. If you log into Voiceware via SSH you can navigate to this directory and then list all files (ls) to see if a file with your phones MAC is present. If not click “regen configs” from the Phones page sidebar menu and enter ls again. If it still does not appear try and setup a new phone with a fake MAC address using any template and see if that file appears. If not contact Phonesuite tech support, if it does appear delete and recreate the phone entry.
Verify SIPnp is running. SIPnp is required for auto config, to see if its running enter the command ps ax | grep sipnp. If running you will see:
2465 ? Ss 0:45 perl /opt/asgi_scripts/sipnp.pl
22138 pts/0 S+ 0:00 grep --color=auto sipnp
If not you will see:
22138 pts/0 S+ 0:00 grep --color=auto sipnp
If SIPnp is not running start it with the command “
sudo start voiceware-sipnp
"
Try and download the config file manually to verify port 80 is open. Log into the system via SSH and go to /var/lib/tftpboot, next enter ls to list all files. Find a configuration file and copy its name. Lastly open a new tab in your browser and navigate to http://<ip>/p/<configname.com (i.e. http://1.2.3.4/p/Vtech_SNOM_0004f5293491.cfg). If you can manually download the file then the phone should be able to as well.
In some cases you can also take this config file and attempt to manually (via the phones GUI, not Voiceware) upload the file directly into the phone. If this does not work then something is wrong with the configuration files content or format. Check the phones page to ensure you are using the correct template and that all info has been added correctly.
Voiceware uses port 80 to allow a phone to download a config file, this port must be open on the proceeding firewall.
Additional Information
Voiceware 4.3 displays a link on the Endpoints page to download the phones configuration file. This file can be downloaded and pushed into the phone manually. If it works then the issue is with option 66 or the network.
From the CLI the command
journalctl -t webapps -f | grep get
can be ran while the phone is rebooted. You should see a log entry when the phone reaches out to ask for its config file. This is useful to ensure that A) the phone is reaching out to Voiceware and B ) to check what file name the phone or gateway is trying to grab.
Basic Overview
Please read the special considerations sections for the phone or gateway you are working with. They provide some very important information!
Option 66 (and sometimes 160) are part of the DHCP protocol. In essence these options are a way for the router to pass additional information to any device asking for an IP address on the network. There are many options used for many purposes but we will focus on 66 (TFTP server name) and 160 (custom option Polycom phones use).
When any IP device is connected to a network the device sends a broadcast request asking for an IP address. The DHCP server (normally the router) sees this request and response back to the device with its IP address and any additional options. Option 66 is an address where the phone should look to retrieve a configuration file, this address is the Voiceware server.
As seen in the simplified diagram above the phone first obtains an IP address from the DHCP server then asks Voiceware for a configuration file normally (but not always) identified with a MAC address. The phone then download this file and uses it to configure itself for use.
Ideally a reseller can setup the devices and phones within Voiceware then plug in the phones and have them set themselves up without the need to enter the phones GUI or set any configuration on the phone itself.
Brand | DHCP Option | Type | Value |
Vtech | 66 | Text | http://<ip>/p |
Polycom | 160 | Text | http://<ip>/p |
Yealink | 66 | Text | http://<ip>/p |
Cetis 330 | 66 | Text | <ip> |
Cetis C3, CM, CD | 66 | Text | http://<ip>/p |
Yeastar Gateway | N/A |
| N/A |
Vtech SNOM | 66 | Text | http://<ip>/p/ |
Grandstream Gateway | 66 | Text | HTTP://<ip>/p |
AEI VX-3108 | N/A |
|
|
Vtech M500 | 159 | Text | http://<ip>/p/{mac}.xml |
PSG | 66 | Text | https://<ip>/p |
Cetis 330IP phones use only TFTP to auto-configure and thus will not work on hosted systems. If using Cetis guest room phones for a hosted system setup the phones on the hosted system as normal (including checking the “Override Server IP” check box, see below). After all phones are setup the configuration files will need to be manually moved to the local failover Voiceware server (Cetis configs are located in /var/lib/tftpboot and all end with “3300IP.txt” (i.e. 53. 3300IP.txt). These files should be moved into the same directory and have the permissions root www-data.
Note also that the 330IP phones MUST have a Config version set to “2.0002” or they will not pull the configuration file.
Cetis C3, CM, and CD phones MUST have the Config version set to “3.1000” or they will not pull the configuration file. Also know that speed dial keys are assigned from the top right to the bottom left (two rows). Lastly the MAC address configuration will only work for onsite systems on Voiceware 2.2 and below. Voiceware 2.3 or 3.X are required for hosted system configuration using MAC address-based configuration. To use the C3, CM, or CD models with a hosted system you must move the configuration files (either MAC or ID based) to a local server (see Cetis 330IP above for information on how to do this).
The C3, CM, and CD phones have two different template files available. Template files with “MAC” in the name are MAC address-based files, the ones with “ID” are ID based and require that the ID of the phone be entered manually on each phone during placement.
For hosted systems it is important for hosted systems that the “Override Server IP” box is checked in the Phone setup screen and that the Hosted IP address is entered here. This is because Voiceware assumes that it and the phones are on the same local network. This is not true in a hosted environment and thus the configuration file must have the correct Public IP address for the hosted system. Otherwise the phones will be told to find the Voiceware server at the local IP of the hosted network (i.e. 192.168.1.222) and not the hosted Public IP (i.e. 12.34.56.78).
Vtech Phones Time Zone
Vtech phones do not support all the time zones found in Voiceware users page. Below is a list of what time zone to select in Voiceware when using Vtech phones.
Eastern (UTC-5) America/New_York
Central (UTC-6) America/Chicago
Mountain (UTC-7) America/Denver
Pacific (UTC-8) America/Los_Angeles
Alaska (UTC-9) America/Anchorage
Hawaii (UTC-10) America/Honolulu
Vtech S2XXX Phones
In order for these phones to autoconfigure using HTTP you must use the latest firmware 70.3.58.6 or better.
https://phone-firmware.s3.amazonaws.com/vmlinuz_70_3_85_06.large
Vtech LS-S3410
This phone is a guest room phone and because guest rooms don’t have a time zone like users do you must set it manually in the template file. Download the LS-S3410 template file and find the line “time_date.selected_timezone” and set the time zones as outlined above in section Vtech time zones. For example, your finished time zone might look like:
"time_date.selected_timezone = America/New_York"
Note the space before and after the equals sign.
Custom speed dials are setup as such so that speed dial 1 is the HS Service and 2 is the HS Emergency buttons on the cordless handsets. Speed dials 3-12 are the buttons on the base set.
The Jacob Jensen Bittel IP phones require two configuration files to be generated in order to function. Bittel phones first look for a file <MAC>.flag. This flag file is the same for all phones and has only two lines in it, one of which tells the phone to update is configuration. The second file <MAC>.cfg contains the actual configuration information. To generate two files create a phone entry and select the Jacob Jensen A template file, then save the phones entry. Next edit the phone again and change the template file to the Jacob Jensen B file, then save again. This will create both required files for the phone. Note also with this phone only local TFTP configuration is currently supported, autoconfiguration can not at this time be easily done for a hosted system (see info about Cetis on hosted systems above).
Note that there is also a Jacob Jensen B5 file. This was created do handle a different firmware that was found on the phones. Best practice is to configure one phone using the process above and if it will not auto configure to use the B5 file and try again. Thanks to Jeremiah Carscadden of UTG for helping develop and test the B5 file.
There are two methods of auto configuration for the Yeastar gateways. If using an Express+ system the gateways can be placed on the Voiceware (eth1, not customer side) network and they will configure out of the box.
Option 66 is not available, the server URL must be manually set in the gateway before it will configure.
A user with the Property Code should be created and assigned to each gateway. This is done because the gateway will send an email itself should there be an issue with it. The subject name of the email will be “Yeastar Gateway Web Login Issue on [property code] MAC:[mac]”. Without this user created / assigned the property code will not be included and finding the gateway having problems might be difficult.
DHCP
Setup the gateway in the Voiceware, don’t forget to assign a user to the gateway.
Log into the gateway
Navigate to System --> Auto Provision Settings
In Provision Method set
Server URL: Yes
Set the Server URL to the Voiceware IP (i.e. http://192.168.1.222/p)
Click Save then Apply
Go to Restart and Reboot
Reboot the gateway
The gateway should reboot and get its configuration changes. Always make sure to use the latest available template file to ensure proper function.
Static IP
If setting the gateway to a static address the template file “Static_IP” must be used. Beyond that the setup is the same as above.
Note that Phonesutie gateways have a default 6000 second max outbound call duration, and internal ringing matched on 3- and 4-digit extensions. Max ring time is set to 86400 seconds, caller ID and MWI light options can be changed in the Advanced tab (neon by default).
Also note that the following changes have been made:
*** menu is now ***4. Password is “123456” or the password set in the phones page or admin page.
Feature codes to enable DND and other troublesome features from the guest room phones have been changes to new numbers such as *11122, *11133, etc. Its hoped that a guest will not enter this string in error. These can be changed starting on line 342 in the auto configuration TPL file.
To reset a guest room phone back to defaults (i.e. turn off DND and forwarding) dial *11111 from the phone.
The gateway will email alerts@phonesuite.com if it detects a problem. This email address can be changed as needed in the TPL file on lines 100-104.
Not that pressing # before dialing a number will act as redial.
Helpful speed dials:
*97: Read back port number
*98: Read back device name assigned to port
*99: Provision gateway without a reboot
Note that Polycom phones will not pull an updated configuration if the reset phone option is used from the Polycom GUI. A reboot from the Polycom GUI or a reset from the Voiceware GUI will force the phone to update its configuration.
Voiceware will detect SIP phones on the same network and will attempt to display their model and IP. It does this via a script that listens to the network for ARP packets and filters them by MAC address. When an ARP request is received by the system with an originating OUI (MAC prefix), it adds it to the database with all the details it has.
It will then try to discover more information via SIP OPTIONS message or by waiting for additional information to be sent on the network.
Periodically it will proactively "poke" via SIP all already known devices for more information.
When selecting a template you may notice that there are sometimes two versions of the same template, one marked as MAC and the other as ID. The difference between these files is that one will use a MAC address as the identifier in the file name. The other will only identify the configuration file with an ID number. The ID number files are used when you don’t know the MAC address of the phone that will be in each room. Instead relying on an ID number to be assigned to each file (and thus guest room) that can then later be keyed into whatever phone is placed in that room.
Template and Config Files
Template files are used as the basis for creating the actual configuration file for each phone. For example, if a reseller uses the Phones page to set up five Polycom phones Voiceware will use the Polycom template file to create each phones unique configuration file using the data entered via the Phones page. The usage of the template files as a method of creating the actual configuration file the phone will use is important because any changes made to the template file will affect all configuration files created for that phone.
The top of the file contains a small heading section that allows the resulting configuration file name to be set along with several options for enabling features like missed calls display and number of lines available on the device. Remove the descriptions in parentheses when creating a template file.
Header
{*BEGIN INI--
[config]
description=
fileformat=cfg[mac].xml
maxdevices=12
maxkeysperdevice=6
Description is a simple label, something like “Yeastar Gateway” or “AEI A32”
File format is the type of file that will be created. Normally the file extensions are .cfg or .xml. Note also the file name normally requires the MAC address, this can be written as:
[mac]
for 112233aabbcc[MAC]
for 112233AABBCC[id]
to use the ID of the phones in the Endpoints page, needed for Cetis phones. Files written out as “28.3300IP.txt” for example.
Max Devices is the number of lines the device supports, for a gateway this is the number of ports.
Max Keys Per Device is the max number of line keys that are supported by the device and the max that a user can assign in Voiceware. Setting this value to 1 removes the line key drop-down.
Options
[options]
mcd=false
(Missed calls display, or show missed calls)
cwt=false
(Call waiting tone)
vmb=false
(Voicemail button, i.e. map voicemail key to extension)
park=false
(Add a park key to the device)
xfer=false
(Add a fast transfer key to the device)
speed=false
(Allow custom speed dial keys to be added to the device)
polarity=false
(Sets if the disconnect polarity setting will be displayed)
ringdown=true
(Sets if a ring down extension field will be available)
--END INI*}
Variables are dynamic values that are written into a configuration file for a phone. For example the devices name and password are variables that are written out with unique values for each endpoint configured.
Below is a list of variables that can be used. Note that all variables need to be contained in a curly bracket and start with the “$” symbol.
Data Tag | Data Type | Description |
{$config.phone_id} | int | ID of the phone |
{$config.mac} | string | MAC address of phone "001122334455" |
{$config.http_iface} | string | Enable the web interface on phone (1 yes 0 no) |
{$config.pc_port} | int | Enable (0) or disable (-1) PC Port on phone |
{$config.dnd} | int | Enable (1) or disable (0) DND |
{$config.call_fwd} | int | Enable (1) or disable (0) Call Forwarding |
{$config.vm_sa} | string | voicemail notification sound "chord" or "silence" |
{$config.vm_la} | string | voicemail enabled “contact" or "disabled" |
{$config.stickyvol_head} | string | sticky volume on headset "1" or "0" |
{$config.stickyvol_spkr} | string | sticky volume on speaker "1" or "0" |
{$config.stickyvol_hand} | string | sticky volume on handset "1" or "0" |
{$config.hold_remind} | string | enable hold reminder beep "1" or "0" |
{$config.hold_remind_per} | string | how often in seconds to remind of hold |
{$config.hold_remind_start} | string | how long in seconds before first reminder |
{$config.regX.id} | int | device ID for regX (X = line key) |
{$config.regX.name} | string | device name for regX ("testdev") |
{$config.regX.accountcode} | string | accountcode for regX (if set) |
{$config.regX.username} | string | SIP username for regX ("testdev") |
{$config.regX.secret} | string | SIP password for regX ("E8o6e%aGu$eteVir") |
{$config.regX.qualify} | string | whether or not keepalives are sent "yes" or "no" |
{$config.regX.allow} | string | codecs allowed for regX "ulaw,alaw,gsm" |
{$config.regX.disallow} | string | disabled codecs for reg |
{$config.regX.port} | string | SIP port to register to "5060" |
{$config.regX.language} | string | two-character language code (if set) |
{$config.regX.sip_calllimit} | string | maximum simultaneous calls for regX |
{$config.regX.sip_dtmfmode} | string | DTMF mode to use with regX "rfc2833/info/inband" |
{$config.regX.sip_speakerphone} | bool | answer all calls on speakerphone on regX |
{$config.regX.friendly_name} | string | plain English name for regX |
{$config.regX.sla_group} | string | the sla group regX belongs to (empty if no SLA) |
{$config.keysX} | int | how many line keys for X (same X as regX) |
{$config.mcdX} | bool | display missed calls for X (same X as regX) |
{$config.digitmap} | string | dialing digit map |
{$config.vmext} | string | voicemail extension, i.e. "8000" |
{$config.cwt} | string | call waiting tone "beep" or "ring" or "silent" |
{$config.timeoffset} | int | time offset from GMT in seconds (-25200) |
{$config.myip} | string | IP of server ex. "192.168.2.191" |
{$config.dst} | int | Enable (1) or Disable (0) DST support |
{$config.parkkey} | bool | Add a park key to phone (true/false) |
{$config.parkext} | string | extension to use for park key (if enabled) "700" |
{$config.qtext.X.xfer_dest} | string | quick transfer key X destination. (X starts at 0) |
{$config.qtext.X.xfer_label} | string | quick transfer key X label |
{$config.sdext.X.sd_dest} | string | custom speed dial X destination (X starts at 0) |
{$config.sdext.X.sd_label} | string | custom speed dial X label |
{$config.sdext.X.blf} | bool | Subscribe to BLF for speed dial X |
{$config.admin_pwd_set} | int | enable / disable interface admin password setting (1/0) |
{$config.admin_pwd} | string | interface admin password to use if admin_pwd_set is 1 "567" |
{$config.vlan_id_set} | string | enable / disable setting of VLAN "0"/"1" |
{$config.vlan_id} | string | VLAN ID to use on network if vlan_id_set is 1 |
{$config.dns_ip_set} | string | enable / disable setting of DNS IP |
{$config.dns_ip} | string | IP address of DNS server to use if dns_ip_set is 1 |
{$config.syslog_server_set} | string | Enable / Disable setting of syslog server host |
{$config.syslog_server} | string | IP or hostname of syslog server (if syslog_server_set) |
{$config.syslog_level} | string | Level of logging to syslog (if syslog_server_set) |
{$config.ringdown<n>} | string | Written out as $config.ringdown2 where 2 is the port. |
{$config.polarity<n>} | string | Values written are "loop", "ground" or "" if default is set in the Voiceware GUI. |
If an endpoint is assigned to a user these additional variables are also available.
Data Tag | Data Type | Description |
{$config.userdata.username} | string | User’s username |
{$config.userdata.firstname} | string | User's first name |
{$config.userdata.lastname} | string | User's last name |
{$config.userdata.pin} | string | User's voicemail PIN |
{$config.userdata.outbound_id} | string | User's outbound ID (if set) |
{$config.userdata.lang} | string | User's language (2-char - "en") |
{$config.userdata.timezone} | string | User's Timezone (America/Dawson_Creek) |
Some options need to be converted from one style to another. This can be handled as such:
If, for example, $config.dnd needs to say "true" or "false" in the config template, but it says 1 or 0 by default, change it like so (in the template):
{if $config.dnd == 1}true{else}false{/if}
Note that math operations are also available, for example:
{$config.timeoffset/3600}
Will take the time offset (normally listed in seconds) and convert it to hours.
If you need to set an account active code (not something supported directly by Voiceware) you can do so using:
{if $config.reg2.username != ""}1{else}0{/if}
Loops are also possible and used in the Yealink T48G template file as well as several other Yealink phones.
################################################################
Account Register
################################################################
{section name=i start=0 loop=16}
{assign var="reg" value=$smarty.section.i.index+1}
{assign var="line" value="reg$reg"}
{assign var="num" value="$reg"}
account.{$num}.enable={if $config.$line.username != ""}1{else}0{/if}
account.{$num}.label={$config.$line.friendly_name}
account.{$num}.display_name={$config.$line.username}
account.{$num}.auth_name={$config.$line.username}
account.{$num}.user_name={$config.$line.username}
account.{$num}.password={$config.$line.secret}
account.{$num}.sip_server.1.address={$config.myip}
account.{$num}.sip_server.1.port={$config.$line.port}
account.{$num}.sip_server.2.address={$config.myip}
account.{$num}.sip_server.2.port={$config.$line.port}
account.{$num}.outbound_proxy_enable=0
account.{$num}.sip_server_type = 0
{/section}
Smarty
Voiceware uses the Smarty template system. You can read much more about it and how to manipulate variables here: PHP Template Engine | Smarty
Here is an example of a VTech 715 template file:
sip_account.1.sip_account_enable = 1
sip_account.1.display_name = {$config.reg1.friendly_name}
sip_account.1.user_id = {$config.reg1.username}
sip_account.1.authentication_name = {$config.reg1.username}
sip_account.1.authentication_password = {$config.reg1.secret}
sip_account.1.dial_plan = {$config.digitmap}
sip_account.1.inter_digit_timeout = 3
sip_account.1.maximum_call_number = {$config.reg1.sip_calllimit}
When the config file is written out using this template the resulting file looks like this:
sip_account.1.sip_account_enable = 1
sip_account.1.display_name = John Smith
sip_account.1.user_id = 302
sip_account.1.authentication_name = 302
sip_account.1.authentication_password = bh44kd#dk34$r1
sip_account.1.dial_plan = Xn.
sip_account.1.inter_digit_timeout = 3
sip_account.1.maximum_call_number = 2
Note that the configuration file itself normally contains human readable information. In the above example it’s easy to see the display name is “John Smith” and the user ID is “302”. Also note that some values are pre-loaded in the template file. For example the top line of “sip_account_enable” is preset to “1” which enables the account. Voiceware does not have an equivalent option in its GUI so this value is pre-loaded into the template file and thus into every config file created with this template.
This concept of preloading is very important as it allows a reseller to make custom adjustments to every configuration file by just adjusting the template file. Say for example that every guest room phone needed to have the same speed dial values. The template file could be adjusted and placed back into the system (see below for instructions on how to do this) and then all configuration files created would have the same speed dial keys.
Data Sample
Below is an example of each field and sample data that will be outputted to it.
phone_id | 117 | reg2.sip_dtmfmode | rfc2833 |
mac | 1122334455 | reg2.sip_speakerphone |
|
http_iface | 1 | reg2.friendly_name | Rachel Summers |
pc_port | -1 | reg2.sla_group |
|
dnd | 0 | keys2 | 1 |
call_fwd | 0 | mcd2 |
|
vm_sa | silence | digitmap |
|
vm_la | disabled | vmext | 8000 |
stickyvol_head | 1 | cwt | beep |
stickyvol_spkr | 1 | timeoffset | -18000 |
stickyvol_hand | 1 | myip | 192.168.2.105 |
hold_remind | 0 | dst | 1 |
hold_remind_per | 30 | parkkey | 1 |
hold_remind_start | 60 | parkext | 700 |
reg1.id | 465 | qtext.0.xfer_dest | 300 |
reg1.name | 300 | qtext.0.xfer_label | Fast One |
reg1.accountcode |
| sdext.0.sd_dest | 301 |
reg1.username | 300 | sdext.0.sd_label | Custom 1 |
reg1.secret | Ce323uSu$#A3yMU | sdext.0.blf | 1 |
reg1.qualify | yes | qtext.1.xfer_dest |
|
reg1.allow | ulaw,alaw,gsm | qtext.1.xfer_label |
|
reg1.disallow |
| sdext.1.sd_dest | 302 |
reg1.port | 5060 | sdext.1.sd_label | Custom 2 |
reg1.language |
| sdext.1.blf |
|
reg1.sip_calllimit | 6 | admin_pwd_set | 1 |
reg1.sip_dtmfmode | rfc2833 | admin_pwd | 2150 |
reg1.sip_speakerphone |
| vlan_id_set | 0 |
reg1.friendly_name | Jubilation Lee | vlan_id |
|
reg1.sla_group |
| dns_ip_set | 0 |
keys1 | 2 | dns_ip |
|
mcd1 | 1 | syslog_server_set | 1 |
reg2.id | 75 | syslog_server | 192.168.2.50 |
reg2.name | 312 | syslog_level | 1 |
reg2.accountcode |
|
|
|
reg2.username | 312 | userdata.username | jlee |
reg2.secret | 7366%^#88Adf | userdata.firstname | Jubilation |
reg2.qualify | yes | userdata.lastname | Lee |
reg2.allow | ulaw,alaw,gsm | userdata.pin | 975039 |
reg2.disallow |
| userdata.outbound_id | 3035551111 |
reg2.port | 5060 | userdata.lang | en |
reg2.language |
| userdata.timezone | America/Detroit |
reg2.sip_calllimit | 6 | config.ringdown2 | 888 |
config.polarity2 | loop | ground | |
|
|
Template File Supported Options
Below are matrix's showing what options are supported in which file. Note that some options like device name and secret are omitted these are required for the phone to register and without them the phone would not work whatsoever.
The newer Polycom Edge B series is not yet fully supported. While the phone will provision and work things like speed dial keys can’t yet be assigned. At this time we don’t recommend using the Polycom Edge B series of phones.
Note: the E series runs a different firmware and an E series was tested and worked well.
-Aaron Bailey, 5/30/2023
Options | Polycom | Yealink T28P | VSP 715 | VSP 725 | VSP 726 | VSP 736 |
Phone ID |
|
|
|
|
|
|
Enable / Disable Web Interface | X | X | X | X | X | X |
Enable / Disable PC Port | X | X |
|
| X | X |
Enable / Disable DND | X | X |
|
|
|
|
Enable / Disable Forwarding | X | X |
|
|
|
|
Enable / Disable Voicemail Notification | X |
|
|
|
|
|
Enable / Disable Headset Sticky Volume | X |
|
|
|
|
|
Enable / Disable Speaker Sticky Volume | X |
|
|
|
|
|
Enable / Disable Handset Sticky Volume | X |
|
|
|
|
|
Enable / Disable Hold Reminder Tone | X |
| X | X | X | X |
Adjustable Hold Reminder Tone Interval | X |
| X | X | X | X |
Enable / Disable Keepalives | X |
| X | X | X | X |
Set Allowed Codecs | X |
|
|
|
|
|
Set Disallowed Codecs | X |
|
|
|
|
|
Language (Based on Voiceware System) | X |
| X | X |
|
|
Set Call Limit | X |
| X | X | X | X |
Set DTMF Mode | X |
|
|
|
|
|
Set Auto Answer on Speaker Phone | X |
|
|
|
|
|
Set SLA Group | X |
|
|
|
|
|
Set Number of Line Keys | X | X |
|
|
|
|
Enable / Disable Missed Calls Display | X |
| X | X | X | X |
Set Digit Map | X | X | X | X | X | X |
Set Voicemail Extension | X | X | X | X | X | X |
Set Call Waiting Tone | X |
| X | X | X | X |
GMT Offset in Seconds | X | X |
|
|
|
|
Enable / Disable Daylight Savings | X |
| X | X | X | X |
Add / Set Park Key | X |
| X | X | X | X |
Quick Transfer Keys | X |
|
|
|
|
|
Custom Speed Dials | X | X |
|
|
|
|
Set Phones Admin Password | X | X | X | X | X | X |
Set DNS Server Address | X | X | X | X | X | X |
VLAN Support | X | X | X | X | X | X |
Syslog Server Support | X | X | X | X | X | X |
Users Language | X |
| X | X | X | X |
Users Time Zone | X |
| X | X | X | X |
Options | S2XXX | 3300IP | AEI 9208 | Cetis C31 | Cetis CM | Cetis CD |
Phone ID |
| X | X | X | X | X |
Enable / Disable Web Interface |
|
|
|
|
|
|
Enable / Disable PC Port |
|
|
|
|
|
|
Enable / Disable DND |
|
|
|
|
|
|
Enable / Disable Forwarding |
|
|
|
|
|
|
Enable / Disable Voicemail Notification |
|
|
|
|
|
|
Enable / Disable Headset Sticky Volume |
|
|
|
|
|
|
Enable / Disable Speaker Sticky Volume |
|
|
|
|
|
|
Enable / Disable Handset Sticky Volume |
|
|
|
|
|
|
Enable / Disable Hold Reminder Tone |
|
|
|
|
|
|
Adjustable Hold Reminder Tone Interval |
|
|
|
|
|
|
Enable / Disable Keepalives |
|
| X |
|
|
|
Set Allowed Codecs |
|
|
|
|
|
|
Set Disallowed Codecs |
|
|
|
|
|
|
Language (Based on Voiceware System) | X |
|
|
|
|
|
Call Limit |
|
|
|
|
|
|
Set DTMF Mode |
|
|
|
|
|
|
Set Auto Answer on Speaker Phone |
|
|
|
|
|
|
Set SLA Group |
|
|
|
|
|
|
Set Number of Line Keys |
|
|
|
|
|
|
Enable / Disable Missed Calls Display |
|
|
|
|
|
|
Set Digit Map | X |
|
|
|
|
|
Set Voicemail Extension | X | X | X | X | X | X |
Set Call Waiting Tone |
|
|
|
|
|
|
GMT Offset in Seconds |
|
| X |
|
|
|
Enable / Disable Daylight Savings |
| X | X | X | X | X |
Add a Park Key |
| X |
|
|
|
|
Quick Transfer Keys |
|
|
|
|
|
|
Custom Speed Dials |
|
| X | X | X | X |
Set Phones Admin Password |
|
| X | X | X | X |
Set DNS Server Address |
|
|
|
|
|
|
VLAN Support |
| X | X | X | X | X |
Syslog Server Support | X | X | X | X | X | X |
Users Language |
|
|
|
|
|
|
Users Time Zone |
|
|
|
|
|
|
Options | HA9888 69 | Jacob Jensen | Vtech LS-S3410 | Vtech SNOM | Yeastar Gateway | Yealink T27G |
Phone ID |
|
|
|
|
|
|
Enable / Disable Web Interface |
|
| X | X | N/A | X |
Enable / Disable PC Port |
|
|
|
|
| X |
Enable / Disable DND |
|
|
|
| N/A |
|
Enable / Disable Forwarding |
|
|
|
| N/A |
|
Enable / Disable Voicemail Notification |
|
|
|
| N/A |
|
Enable / Disable Headset Sticky Volume |
|
|
|
| N/A |
|
Enable / Disable Speaker Sticky Volume |
|
|
|
| N/A |
|
Enable / Disable Handset Sticky Volume |
|
|
|
| N/A |
|
Enable / Disable Hold Reminder Tone |
|
|
|
| N/A | X |
Adjustable Hold Reminder Tone Interval |
|
|
|
| N/A | X |
Enable / Disable Keepalives |
|
|
|
|
|
|
Set Allowed Codecs |
|
|
|
|
|
|
Set Disallowed Codecs |
|
|
|
|
|
|
Language (Based on Voiceware System) |
|
|
|
|
|
|
Call Limit |
|
|
|
|
|
|
Set DTMF Mode |
|
|
|
|
|
|
Set Auto Answer on Speaker Phone |
|
|
|
| N/A |
|
Set SLA Group |
|
|
|
| N/A |
|
Set Number of Line Keys |
|
|
| X | N/A | X |
Enable / Disable Missed Calls Display |
|
|
|
| N/A | X |
Set Digit Map |
|
| X | X |
|
|
Set Voicemail Extension | X | X | X | X | N/A | X |
Set Call Waiting Tone |
|
|
|
| N/A |
|
GMT Offset in Seconds |
|
|
| X | X | X |
Enable / Disable Daylight Savings |
|
|
|
|
|
|
Add a Park Key |
|
|
| X | N/A |
|
Quick Transfer Keys |
|
|
| X | N/A |
|
Custom Speed Dials | X |
| X | X | N/A | X |
Set Phones Admin Password | X |
| X | X | X | X |
Set DNS Server Address |
|
|
|
| X |
|
VLAN Support | X | X | X |
| X | X |
Syslog Server Support |
|
| X |
|
| X |
Users Language |
|
|
| X | N/A |
|
Users Time Zone |
|
|
| X | N/A | X |
Options | AEI VX-8X08/9X08 | GXW4224 | GXW4216 | T46G | T48G | T31G |
Phone ID |
|
|
|
|
|
|
Enable / Disable Web Interface |
|
|
| X | X | X |
Enable / Disable PC Port |
| N/A | N/A | X | X | X |
Enable / Disable DND |
| N/A | N/A | X | X | X |
Enable / Disable Forwarding |
| N/A | N/A | X | X | X |
Enable / Disable Voicemail Notification |
| N/A | N/A | X | X | X |
Enable / Disable Headset Sticky Volume |
| N/A | N/A |
|
|
|
Enable / Disable Speaker Sticky Volume |
| N/A | N/A |
|
|
|
Enable / Disable Handset Sticky Volume |
| N/A | N/A |
|
|
|
Enable / Disable Hold Reminder Tone |
| N/A | N/A | X | X | X |
Adjustable Hold Reminder Tone Interval |
| N/A | N/A | X | X | X |
Enable / Disable Keepalives | X |
|
|
|
|
|
Set Allowed Codecs |
|
|
|
|
|
|
Set Disallowed Codecs |
|
|
|
|
|
|
Language (Based on Voiceware System) |
|
|
|
|
|
|
Call Limit |
|
|
|
|
|
|
Set DTMF Mode |
|
|
|
|
|
|
Set Auto Answer on Speaker Phone |
|
|
|
|
|
|
Set SLA Group |
|
|
|
|
|
|
Set Number of Line Keys |
| N/A | N/A | X | X | X |
Enable / Disable Missed Calls Display |
| N/A | N/A | X | X | X |
Set Digit Map | X | X | X | X | X | X |
Set Voicemail Extension | X | N/A | N/A | X | X | X |
Set Call Waiting Tone |
|
|
| X | X | X |
GMT Offset in Seconds | X |
|
| X | X | X |
Enable / Disable Daylight Savings | X |
|
|
|
|
|
Add a Park Key |
| N/A | N/A |
|
|
|
Quick Transfer Keys |
| N/A | N/A | X | X | X |
Custom Speed Dials | X | N/A | N/A | X | X | X |
Set Phones Admin Password | X | X | X | X | X | X |
Set DNS Server Address |
|
|
| X | X | X |
VLAN Support | X |
|
| X | X | X |
Syslog Server Support |
| X | X | X | X | X |
Users Language |
| N/A | N/A |
|
|
|
Users Time Zone |
| N/A | N/A | X | X | X |
Options | CTM S21XX | CTM S2411 L | CTM S2415 | LS S3410 | NG 32XX | Grandstream WP820 |
Phone ID |
|
|
|
|
|
|
Enable / Disable Web Interface |
|
|
|
|
|
|
Enable / Disable PC Port |
|
|
|
| X |
|
Enable / Disable DND |
|
|
|
|
|
|
Enable / Disable Forwarding |
|
|
|
|
|
|
Enable / Disable Voicemail Notification |
|
|
|
|
|
|
Enable / Disable Headset Sticky Volume |
|
|
|
|
|
|
Enable / Disable Speaker Sticky Volume |
|
|
|
|
|
|
Enable / Disable Handset Sticky Volume |
|
|
|
|
|
|
Enable / Disable Hold Reminder Tone |
|
|
|
|
|
|
Adjustable Hold Reminder Tone Interval |
|
|
|
|
|
|
Enable / Disable Keepalives |
|
|
|
|
|
|
Set Allowed Codecs |
|
|
|
|
|
|
Set Disallowed Codecs |
|
|
|
|
|
|
Language (Based on Voiceware System) |
|
|
|
|
|
|
Call Limit |
|
|
|
|
|
|
Set DTMF Mode |
|
|
|
|
|
|
Set Auto Answer on Speaker Phone |
|
|
|
|
|
|
Set SLA Group |
|
|
|
|
|
|
Set Number of Line Keys |
|
|
|
|
|
|
Enable / Disable Missed Calls Display |
|
|
|
|
|
|
Set Digit Map | X | X | X | X | X | X |
Set Voicemail Extension | X | X | X | X | X | X |
Set Call Waiting Tone |
|
|
|
|
|
|
GMT Offset in Seconds |
|
|
|
|
|
|
Enable / Disable Daylight Savings |
|
|
|
|
|
|
Add a Park Key |
|
|
|
|
|
|
Quick Transfer Keys |
|
|
|
|
|
|
Custom Speed Dials | X | X | X | X | X | X |
Set Phones Admin Password | X | X | X | X | X | X |
Set DNS Server Address |
|
|
|
|
|
|
VLAN Support | X | X | X | X | X |
|
Syslog Server Support | X | X | X | X | X | X |
Users Language |
|
|
|
|
|
|
Users Time Zone |
|
|
|
|
|
|
Options | AEI VX-3108 | M500 |
|
|
|
Phone ID |
|
|
|
|
|
Enable / Disable Web Interface |
|
|
|
|
|
Enable / Disable PC Port |
|
|
|
|
|
Enable / Disable DND |
|
|
|
|
|
Enable / Disable Forwarding |
|
|
|
|
|
Enable / Disable Voicemail Notification |
|
|
|
|
|
Enable / Disable Headset Sticky Volume |
|
|
|
|
|
Enable / Disable Speaker Sticky Volume |
|
|
|
|
|
Enable / Disable Handset Sticky Volume |
|
|
|
|
|
Enable / Disable Hold Reminder Tone |
|
|
|
|
|
Adjustable Hold Reminder Tone Interval |
|
|
|
|
|
Enable / Disable Keepalives |
|
|
|
|
|
Set Allowed Codecs |
|
|
|
|
|
Set Disallowed Codecs |
|
|
|
|
|
Language (Based on Voiceware System) |
| X |
|
|
|
Call Limit |
|
|
|
|
|
Set DTMF Mode |
|
|
|
|
|
Set Auto Answer on Speaker Phone |
|
|
|
|
|
Set SLA Group |
|
|
|
|
|
Set Number of Line Keys |
| X |
|
|
|
Enable / Disable Missed Calls Display |
|
|
|
|
|
Set Digit Map |
| X |
|
|
|
Set Voicemail Extension | X | X |
|
|
|
Set Call Waiting Tone |
|
|
|
|
|
GMT Offset in Seconds |
|
|
|
|
|
Enable / Disable Daylight Savings |
| X |
|
|
|
Add a Park Key |
|
|
|
|
|
Quick Transfer Keys |
|
|
|
|
|
Custom Speed Dials | X |
|
|
|
|
Set Phones Admin Password |
|
|
|
|
|
Set DNS Server Address |
|
|
|
|
|
VLAN Support |
| X |
|
|
|
Syslog Server Support |
| X |
|
|
|
Users Language |
| X |
|
|
|
Users Time Zone |
|
|
|
|
|
Options | Yealink T33G | Yealink T46S/G | Yealink T57W | Yealink T31G | Yealink T58A | Yealink W60B |
Phone ID |
|
|
|
|
|
|
Enable / Disable Web Interface | X | X | X | X | X | X |
Enable / Disable PC Port | X | X | X | X | X |
|
Enable / Disable DND | X | X | X | X | X |
|
Enable / Disable Forwarding | X | X | X | X | X |
|
Enable / Disable Voicemail Notification | X | X | X | X | X | X |
Enable / Disable Headset Sticky Volume |
|
|
|
|
|
|
Enable / Disable Speaker Sticky Volume |
|
|
|
|
|
|
Enable / Disable Handset Sticky Volume |
|
|
|
|
|
|
Enable / Disable Hold Reminder Tone | X | X | X | X | X | X |
Adjustable Hold Reminder Tone Interval | X | X | X | X | X | X |
Enable / Disable Keepalives |
|
|
|
|
|
|
Set Allowed Codecs |
|
|
|
|
|
|
Set Disallowed Codecs |
|
|
|
|
|
|
Language (Based on Voiceware System) |
|
|
|
|
|
|
Call Limit |
|
|
|
|
|
|
Set DTMF Mode |
|
|
|
|
|
|
Set Auto Answer on Speaker Phone |
|
|
|
|
|
|
Set SLA Group |
|
|
|
|
|
|
Set Number of Line Keys | X | X | X | X | X |
|
Enable / Disable Missed Calls Display | X | X | X | X | X | X |
Set Digit Map | X | X | X | X | X | X |
Set Voicemail Extension | X | X | X | X | X |
|
Set Call Waiting Tone | X | X | X | X | X |
|
GMT Offset in Seconds | X | X | X | X | X | X |
Enable / Disable Daylight Savings | X | X | X | X | X | X |
Add a Park Key |
|
|
|
|
|
|
Quick Transfer Keys | X | X | X | X | X |
|
Custom Speed Dials | X | X | X | X | X |
|
Set Phones Admin Password | X | X | X | X | X | X |
Set DNS Server Address | X | X | X | X | X | X |
VLAN Support | X | X | X | X | X | X |
Syslog Server Support | X | X | X | X | X | X |
Users Language |
|
|
|
|
|
|
Users Time Zone | X | X | X | X | X | X |
Change Logs
When a template file is updated or changed information about that change is listed in the change logs below. This information is important when upgrading a system or updating template files as when the phones reboot they will pull updated configs and might start to behave differently.
All information about the PSG is on its own page found here: Phonesuite Gateway
Vtech Snom
V 1.0 20190218
Created the phone template
V 1.1 20190715
Added the ability to disable the PC port
V 1.2 20190808
Changed the default clock display to 12-hour format
V 1.3 20190913
Added a flag to set the phone to accept paging calls, it’s called answer_after_policy.
Improved the way that the digit map is handled (faster dial upon pattern match).
V 1.4 20200221
Added three template default digit maps to help aid in dialing. These improvements include [8-9]011.....*, [8-9]......*, and * with a timeout of 10 seconds.
Edited the numbers the phone thinks are emergency numbers to remove 112 and 999 and add 8911 and 9911.
V 1.5 20210212
Set the default ring tone to tone 9 for all lines.
Made *97 the default directed call prefix.
Set speed dials to type BLF, not Extension.
V 1.6 20210402
Added a setting so the phone will automatically refresh its settings once every two hours. This was done so that settings changes made to the Endpoint in Voiceware will take effect automatically without requiring the user to reboot their phone.
V 2.0 20221028 (Tested on firmware 10.1.127.10, 10.1.119.10, and 10.1.33.3)
Created a separate file for the D713, D717, D735, and D785. This removes the need to set DHCP option 66 with a Vtech specific value.
Vtech_S2XXX
V1.2 20210618
Updated template so that unsupported options are hidden in the Voiceware GUI.
V 1.1 20180801
Added support for the config version number, previously it was hard coded to 999
VPS715
V 1.4 20171115
Added support for call waiting tone enable / disable via the GUI
Changed clock to 12-hour format
Changed date format to MM/DD/YY
VSP725
V 1.3 20171115
Added support for call waiting tone enable / disable via the GUI
Changed clock to 12-hour format
Changed date format to MM/DD/YY
VSP726
V 1.4 20171115
Added support for call waiting tone enable / disable via the GUI
Changed clock to 12-hour format
Changed date format to MM/DD/YY
Changed adaptive jitter delay to 30 and target to 45
Set to auto configure nightly and update its configuration
VPS736
V 1.3 20171115
Added support for call waiting tone enable / disable via the GUI
Changed clock to 12-hour format
Changed date format to MM/DD/YY
Changed adaptive jitter delay to 30 and target to 45
Set to auto configure nightly and update its configuration
Vtech LS-S3410
Version 1.1 20210618
Updated template so that unsupported options are hidden in the Voiceware GUI.
Vtech CTM-S2315
Version 1.0 20210624
Built on firmware 2.18.2.0
Speed dial keys are assigned M1, M2, M5, M6, M7, M8
Note that the emergency extension must be manually set in the template file, not via the Voiceware GUI.
Time zone must be manually set in the template file.
Vtech CTM-S2116
Version 1.0 20210624
Built on firmware 2.18.6.0
Speed dial keys are assigned Front Desk, room Service, Restaurant, Housekeeping, Valet
Note that the emergency extension must be manually set in the template file, not via the Voiceware GUI.
Time zone must be manually set in the template file.
Vtech CTM-S2411-L
Version 1.0 20210624
Built on firmware 2.19.0.0
Speed dial keys are assigned lower row left to right, upper row left to right, top down buttons right of key pad.
Note that the emergency extension must be manually set in the template file, not via the Voiceware GUI.
Time zone must be manually set in the template file.
Vtech CTM-S2415
Version 1.0 20210624
Built on firmware 2.18.4.0
Speed dial keys are assigned HS M1, M2, BS 1-4.
Note that the emergency extension must be manually set in the template file, not via the Voiceware GUI.
Time zone must be manually set in the template file.
Vtech M500 Base Station
Version 1.0 20230825. Tested on firmware 1.11.3
Auto provision uses option 159 NOT 66 as normal.
Auto provision is set to disabled after initial configuration.
Must use
/{mac}.xml
in the provisioning URL.A devices display name should be shorter, the name “Jonothon Starsmore” was to long and did not display on the phones (desk and cordless).
Speed dials and additional line keys must be manually set by logging into the base station for each hand or desk set.
Yeastar TA2400 Gateway
V 1.3 20190218
Created the gateway template.
V 1.6 20210225
Added default digit maps to speed dialing, based on the default Polycom digit map.
V 1.7 20210402
Removed the local dialing without prefix because it overlaps with extension dialing.
V 1.8 20211206 (Template file version 5)
Disabled the PNP and Server URL auto provision settings to aid in DHCP option 66 auto config.
V 1.9 20220117 (Template file version 6)
Re-enabled the server URL settings because DHCP option 66 does not work consistently.
Note a static IP version of the same file is available, its version 3.
Yeastar TA800
V 1.0
Tested on firmware version 41.19.0.32
Based on the template version 1.9 for the TA2400 and works the same way
Version 1.1 20210215
Added *97 as the default directed call prefix extension.
Version 1.2 20210621
Updated template so that unsupported options are hidden in the Voiceware GUI.
Yealink T27G
Version 1.2 20210618
Updated template so that unsupported options are hidden in the Voiceware GUI.
Yealink T31G
Version 1.1 20210712
Created for firmware version 124.86.0.20.
Note: After a phone reboot changes seem to take about a minute to apply, be patient.
The Template automatically enables the G729, Ulaw, Alaw, and G722 codecs in that order.
Yealink T33G
Version 1.1 20210712
Created for firmware version 124.86.0.20.
Note: After a phone reboot changes seem to take about a minute to apply, be patient.
The Template automatically enables the G729, Ulaw, Alaw, and G722 codecs in that order.
Version 1.2 20230808
Disabled DHCP options after initial configuration
Set the server address as http for provisioning
Yealink T46G
Version 1.1 20210712
Created the config for firmware 28.83.0.120.
Note: After a phone reboot changes seem to take about a minute to apply, be patient.
Note: While the automatic update feature is enabled and set for 2 hours it does not seem to work well. Because this phone is end of life there might not be a fix available.
The Template automatically enables the G729, Ulaw, Alaw, and G722 codecs in that order.
Version 1.2 20230808
Disabled DHCP options after initial configuration
Set the server address as http for provisioning
Yealink T46S
Version 1.1 20210712
Created for firmware version 66.86.0.15.
Note: After a phone reboot changes seem to take about a minute to apply, be patient.
The Template automatically enables the G729, Ulaw, Alaw, and G722 codecs in that order.
Version 1.2 20230808
Disabled DHCP options after initial configuration
Set the server address as http for provisioning
Yealink T48G
Version 1.1 20210712
Created for firmware version 35.83.0.120.
Note: After a phone reboot changes seem to take about a minute to apply, be patient.
The Template automatically enables the G729, Ulaw, Alaw, and G722 codecs in that order.
Version 1.2 20230808
Disabled DHCP options after initial configuration
Set the server address as http for provisioning
Yealink T57W
Version 1.1 20210712
Created for firmware version 69.85.25.2.
Note: After a phone reboot changes seem to take about a minute to apply, be patient.
The Template automatically enables the G729, Ulaw, Alaw, and G722 codecs in that order.
Version 1.2 20230808
Disabled DHCP options after initial configuration
Set the server address as http for provisioning
Yealink T58A
Version 1.1 20210712
Created for firmware version 69.85.25.2.
Note: After a phone reboot changes seem to take about a minute to apply, be patient.
The Template automatically enables the G729, Ulaw, Alaw, and G722 codecs in that order.
Version 1.2 20230808
Disabled DHCP options after initial configuration
Set the server address as http for provisioning
Yealink W60
Version 1.0 20210712
Created for firmware version 77.85.0.25.
The Template automatically enables the G729, Ulaw, Alaw, and G722 codecs in that order.
Unlike other Yealink phones the DID and Forward features can not be disabled.
Note: this phone must be assigned to a user (like installer) in order to display the correct time.
Version 1.2 20230808
Disabled DHCP options after initial configuration
Set the server address as http for provisioning
Cetis 3300IP
Version 1.1 20210618
Updated template so that unsupported options are hidden in the Voiceware GUI.
Cetis C31 (ID and MAC)
Version 1.1 20210618
Updated template so that unsupported options are hidden in the Voiceware GUI.
Cetis CD (ID and MAC)
Version 1.1 20210618
Updated template so that unsupported options are hidden in the Voiceware GUI.
Cetis CM (ID and MAC)
Version 1.1 20210618
Updated template so that unsupported options are hidden in the Voiceware GUI.
Bittel HA 9888 (69)
Version 1.1 20210618
Updated template so that unsupported options are hidden in the Voiceware GUI.
Bittel Jacob Jensen
Version 1.1 20210618
Updated template so that unsupported options are hidden in the Voiceware GUI.
Grandstream 4216
Version 1.1 20210805
Tested on firmware 1.0.19.4
Set the template to include a default digit map if none was set via the GUI. This fixes an issue where calls will not complete on newer versions of firmware for the gateway.
Version 1.2 20220825 (Tested on firmware 1.0.23.2)
Removed the firmware upgrade URL so that firmware upgrades don’t happen automatically
Disabled SSH access
Set default web access to HTTPS
Disabled the user and viewer access (admin remains)
Disabled the DHCP time zone option
Disabled option 66 after initial configuration
Version 2.0 20221021 (Tested on firmware 1.0.23.5)
Used the latest template version from Grandstream that organizes the P values into logical groupings and includes information about the settings and valid values.
Removed ringdown settings so that the provisioning file will not override custom settings.
Set the DHCP time zone option to disabled.
Disabled option 66 after initial provision.
Disabled most call features like DID and Forward
Version 2.1 20240619
Added support for ring down with zero delay. (Starting at P4210, all FSX ports)
Added support for polarity settings. This setting utilizes different profiles in the gateway to apply features to each port individually.
Default: no change, use profile 1.
Loop: use profile 2, set Loop Current Disconnect (P893) to yes, set Loop Current Disconnect Duration (P857) to 5000.
Ground: use profile 3, set Polarity Reversal (P665) to yes.
Grandstream 4224
Version 1.1 20210805
Tested on firmware 1.0.19.4
Set the template to include a default digit map if none was set via the GUI. This fixes an issue where calls will not complete on newer versions of firmware for the gateway.
Version 1.2 20220825 (Tested on firmware 1.0.23.2)
Removed the firmware upgrade URL so that firmware upgrades don’t happen automatically
Disabled SSH access
Set default web access to HTTPS
Disabled the user and viewer access (admin remains)
Disabled the DHCP time zone option
Disabled option 66 after initial configuration
Version 2.0 20221021 (Tested on firmware 1.0.23.5)
Used the latest template version from Grandstream that organizes the P values into logical groupings and includes information about the settings and valid values.
Removed ringdown settings so that the provisioning file will not override custom settings.
Set the DHCP time zone option to disabled.
Disabled option 66 after initial provision.
Disabled most call features like DID and Forward
Version 2.1 20240619
Added support for ring down with zero delay. (Starting at P4210, all FSX ports)
Added support for polarity settings. This setting utilizes different profiles in the gateway to apply features to each port individually.
Default: no change, use profile 1.
Loop: use profile 2, set Loop Current Disconnect (P893) to yes, set Loop Current Disconnect Duration (P857) to 5000.
Ground: use profile 3, set Polarity Reversal (P665) to yes.
Grandstream 4232
Version 1.1 20210805
Tested on firmware 1.0.19.4
Set the template to include a default digit map if none was set via the GUI. This fixes an issue where calls will not complete on newer versions of firmware for the gateway.
Version 1.2 20220825 (Tested on firmware 1.0.23.2)
Removed the firmware upgrade URL so that firmware upgrades don’t happen automatically
Disabled SSH access
Set default web access to HTTPS
Disabled the user and viewer access (admin remains)
Disabled the DHCP time zone option
Disabled option 66 after initial configuration
Version 2.0 20221021 (Tested on firmware 1.0.23.5)
Used the latest template version from Grandstream that organizes the P values into logical groupings and includes information about the settings and valid values.
Removed ringdown settings so that the provisioning file will not override custom settings.
Set the DHCP time zone option to disabled.
Disabled option 66 after initial provision.
Disabled most call features like DID and Forward
Version 2.1 20240619
Added support for ring down with zero delay. (Starting at P4210, all FSX ports)
Added support for polarity settings. This setting utilizes different profiles in the gateway to apply features to each port individually.
Default: no change, use profile 1.
Loop: use profile 2, set Loop Current Disconnect (P893) to yes, set Loop Current Disconnect Duration (P857) to 5000.
Ground: use profile 3, set Polarity Reversal (P665) to yes.
Grandstream 4248
Version 1.1 20210805
Tested on firmware 1.0.19.4
Set the template to include a default digit map if none was set via the GUI. This fixes an issue where calls will not complete on newer versions of firmware for the gateway.
Version 1.2 20220825 (Tested on firmware 1.0.23.2)
Removed the firmware upgrade URL so that firmware upgrades don’t happen automatically
Disabled SSH access
Set default web access to HTTPS
Disabled the user and viewer access (admin remains)
Disabled the DHCP time zone option
Disabled option 66 after initial configuration
Version 2.0 20221021 (Tested on firmware 1.0.23.5)
Used the latest template version from Grandstream that organizes the P values into logical groupings and includes information about the settings and valid values.
Removed ringdown settings so that the provisioning file will not override custom settings.
Set the DHCP time zone option to disabled.
Disabled option 66 after initial provision.
Disabled most call features like DID and Forward
Version 2.1 20240619
Added support for ring down with zero delay. (Starting at P4210, all FSX ports)
Added support for polarity settings. This setting utilizes different profiles in the gateway to apply features to each port individually.
Default: no change, use profile 1.
Loop: use profile 2, set Loop Current Disconnect (P893) to yes, set Loop Current Disconnect Duration (P857) to 5000.
Ground: use profile 3, set Polarity Reversal (P665) to yes.
Grandstream 4216_StaticIP
Version 1.0 20211012
Tested on firmware 1.0.19.4
Template allows a static IP to be set.
Version 1.1 20220825 (Tested on firmware 1.0.23.2)
Removed the firmware upgrade URL so that firmware upgrades don’t happen automatically
Disabled SSH access
Set default web access to HTTPS
Disabled the user and viewer access (admin remains)
Disabled the DHCP time zone option
Disabled option 66 after initial configuration
Version 2.0 20221021 (Tested on firmware 1.0.23.5)
Used the latest template version from Grandstream that organizes the P values into logical groupings and includes information about the settings and valid values.
Removed ringdown settings so that the provisioning file will not override custom settings.
Set the DHCP time zone option to disabled.
Disabled option 66 after initial provision.
Disabled most call features like DND and Forward
Grandstream 4224_StaticIP
Version 1.0 20211012
Tested on firmware 1.0.19.4
Template allows a static IP to be set.
Version 1.1 20220825 (Tested on firmware 1.0.23.2)
Removed the firmware upgrade URL so that firmware upgrades don’t happen automatically
Disabled SSH access
Set default web access to HTTPS
Disabled the user and viewer access (admin remains)
Disabled the DHCP time zone option
Disabled option 66 after initial configuration
Version 2.0 20221021 (Tested on firmware 1.0.23.5)
Used the latest template version from Grandstream that organizes the P values into logical groupings and includes information about the settings and valid values.
Removed ringdown settings so that the provisioning file will not override custom settings.
Set the DHCP time zone option to disabled.
Disabled option 66 after initial provision.
Disabled most call features like DND and Forward
Grandstream 4234_StaticIP
Version 1.0 20211012
Tested on firmware 1.0.19.4
Template allows a static IP to be set.
Version 1.1 20220825 (Tested on firmware 1.0.23.2)
Removed the firmware upgrade URL so that firmware upgrades don’t happen automatically
Disabled SSH access
Set default web access to HTTPS
Disabled the user and viewer access (admin remains)
Disabled the DHCP time zone option
Disabled option 66 after initial configuration
Version 2.0 20221021 (Tested on firmware 1.0.23.5)
Used the latest template version from Grandstream that organizes the P values into logical groupings and includes information about the settings and valid values.
Removed ringdown settings so that the provisioning file will not override custom settings.
Set the DHCP time zone option to disabled.
Disabled option 66 after initial provision.
Disabled most call features like DND and Forward
Grandstream 4248_StaticIP
Version 1.0 20211012
Tested on firmware 1.0.19.4
Template allows a static IP to be set.
Version 1.1 20220825 (Tested on firmware 1.0.23.2)
Removed the firmware upgrade URL so that firmware upgrades don’t happen automatically
Disabled SSH access
Set default web access to HTTPS
Disabled the user and viewer access (admin remains)
Disabled the DHCP time zone option
Disabled option 66 after initial configuration
Version 2.0 20221021 (Tested on firmware 1.0.23.5)
Used the latest template version from Grandstream that organizes the P values into logical groupings and includes information about the settings and valid values.
Removed ringdown settings so that the provisioning file will not override custom settings.
Set the DHCP time zone option to disabled.
Disabled option 66 after initial provision.
Disabled most call features like DND and Forward
Grandstream WP820
Version 1.0 20210823
Tested on firmware 1.0.7.50
Note that when the phone configures it will set the server IP as its location to pull configuration files from and disable option 66. This way option 66 can be changed later and the phone will continue to pull configuration from the server.
Phone will check daily for new configurations in between the hours of 1 and 3am.
Note the digit map must be entered inside curly brackets (i.e. { 3xx | 4xx} otherwise it will not work and the default will remain in use. Note also that things outside the digit map can’t be dialed.
VX-3108
Version 1.0 20230804
Tested on firmware vx302.vb
Tested only with TFTP server (not HTTP)
Speed dials are set 1-7 for Select Services then the front desk button, then emergency
There is no digit map in the phone
This phone was only tested with TFTP, when tested HTTP did not work. Also note that the phones web GUI is disabled by default. To load the web GUI take out the battery, press and hold the red phone end call button, put the battery back in. The phone will then enter AP mode. Using a laptop search for the new wireless network and connect using the info displayed on the screen (login to the web GUI is “admin” and “1234”.
Legacy Template Files
To remove clutter we occasionally remove older template files. These files will remain on older systems and can be downloaded from the links below and pushed into newer systems if needed.
https://phone-configs-4.s3.amazonaws.com/VTech_D717.tpl
https://phone-configs-4.s3.amazonaws.com/VTech_D717-directory.tpl
https://phone-configs-4.s3.amazonaws.com/VTech_D735.tpl
https://phone-configs-4.s3.amazonaws.com/VTech_D735-directory.tpl
https://phone-configs-4.s3.amazonaws.com/Grandstream4216_V1-2.tpl
https://phone-configs-4.s3.amazonaws.com/Grandstream4224_V1-2.tpl
https://phone-configs-4.s3.amazonaws.com/Grandstream4232_V1-2.tpl
https://phone-configs-4.s3.amazonaws.com/Grandstream4248_V1-2.tpl
https://phone-configs-4.s3.amazonaws.com/Grandstream4216_V1-1_StaticIP.tpl
https://phone-configs-4.s3.amazonaws.com/Grandstream4224_V1-1_StaticIP.tpl
https://phone-configs-4.s3.amazonaws.com/Grandstream4232_V1-1_StaticIP.tpl
https://phone-configs-4.s3.amazonaws.com/Grandstream4248_V1-1_StaticIP.tpl