UC800 Series IP Phones Provisioning
- 1 1. Introduction
- 2 2. Manage Configuration
- 3 3. Encrypt Configuration Files
- 4 4. Customize Resource Files
- 5 5. Upgrade resource files
- 6 6. Upgrade Firmware
- 7 7. Obtain Provisioning Server's Address
- 8 8. Update mode
- 9 9. Download and Verify Configurations
- 10 10. Firmware and Configuration File Prefix and Postfix
- 11 11. Firmware Server and Configuration File Server
- 12 12. Manage Firmware and Download Configuration File
- 13 13. Pre_Configuration and Configuration Redirection
- 14 14. Automatic Provisioning Within LAN
- 15 15. Troubleshooting
- 16 16. Glossary
- 17 17. How to Edit cfg000x.xml
- 18 18. Generate Configuration File with Htek Provision Tool and Upgrade the Configuration File via HTTP/HTTPS/FTP/TFTP
- 19 19. Making Ringtone Notes
- 20 20. LCD and Web Language custom Guide
- 21 21. LCD and Web GUI custom Guide
- 21.1 21.1 How to custom the wallpaper1-wallpaper6?
- 21.2 21.2 How to custom the screensaver1- screensaver3?
- 21.3 21.3 How to custom the weblogo?
- 21.4 21.4 How to custom the eights menus(.png)in the main menu?
- 21.5 21.5 How to custom the ...Icon.png?
- 21.6 21.6 How to custom the lcdlogo_color.png?
- 21.7 21.7 How to custom the lcdlogo_bw.png?
- 22 22. Firmware Upgrade
- 23 23. Parameter List
1. Introduction
Please note: 8xx including all models:
UC802/ UC802T/ UC803/ UC803T/ UC804/ UC804T/ UC804G/ UC806/ UC806T/ UC806G/ UC840/ UC842/ UC860/ UC862
Htek IP Phone could be plugged directly into an IP network and be used without any manual configuration.
This guide provides instructions on how to provision Htek IP Phone with the minimum settings. Htek IP Phone supports FTP, TFTP, HTTP, and HTTPS for auto provisioning and are configured by default to use the HTTP.
This guide is a basic guidance for provisioning on Htek IP phones, including the models: Htek UC802/ UC802T/ UC803/ UC803T/ UC804/ UC804T/ UC804G/ UC806/ UC806T/ UC806G/ UC840/ UC842/ UC860/ UC862
Note: The auto provision just applies to FW 1.0.3.70 or FW after 1.0.3.70. For the latest FW, please download from our website www.htek.com.
2. Manage Configuration
Htek IP Phone could be configured via Web Interface and via Configuration File that download through TFTP/FTP/HTTP/HTTPS. All devices support a configuration file in proprietary binary format. Products like UC8xx, Unicorn3xxx and Unicorn6xxx accept configuration files in XML format in legacy proprietary binary format. The XML provisioning implementation also allows generic XML configuration file on top of the MAC based configuration file.
When Htek IP Phone boots up or reboots, it will issue a request for these configuration files named "factory000x.bin" --> "cfg000x.xml" -->"cfgMAC" --> "cfgMAC.xml", in which "000x" is the Device Code. Take UC862 For example, the configuration file name should
be factory0000.xml. You can refer to the <<Device Type and file list>>. This "MAC" is
the device Mac address, for example "cfg001fc10608ab". The configuration file name should be in lower case. The file "cfgMAC" is a proprietary binary format configuration file that must be generated by Htek configuration tools.
Device type, Device code and file list:
Device Type | Device Code | Device file |
UC802/UC802T | 0007 | factory0007.bin/cfg0007.xml |
UC803/UC803T | 0006 | factory0006.bin/cfg0006.xml |
UC804 | 0005 | factory0005.bin/cfg0005.xml |
UC804T | 00051 | factory00051.bin/cfg00051.xml |
UC804G | 00052 | factory00052.bin/cfg00052.xml |
UC806 | 0004 | factory0004.bin/cfg0004.xml |
UC806T | 00041 | factory00041.bin/cfg00041.xml |
UC806G | 00042 | factory00042.bin/cfg00042.xml |
UC840 | 0003 | factory0003.bin/cfg0003.xml |
UC842 | 0001 | factory0001.bin/cfg0001.xml |
UC860 | 0002 | factory0002.bin/cfg0002.xml |
UC862 | 0000 | factory0000.bin/cfg0000.xml |
Process of Htek products are as follows:
factory000x.bin -----used for factory default configuration for ODM/OEM
cfg000x.xml ----- used for update the common configuration which doesn't include the account information.
cfg001fc1xxxxxx ---- this file is a private format for each device
cfg001fc1xxxxxx.xml------used for configuration for each device . xml format
Provisioning Flow Chart:
Note: The provisioning program will apply and reload the settings after downloading the new configuration files. It means that a provision/re-direction server can redirect the device to a provision server without reboot. It can also be used to send the XML encryption password.
If factory000x.bin file does not download successfully, the provision program will download the cfg000x.xml file, or download the cfgMAC file. If the cfgMAC file does not download successfully, the provision program will download the cfgMAC.xml file.
2.1 Obtain configuration files
Before provisioning, first you need to obtain the configuration file. There are three CFG template files, cfg000x.xml , cfg$mac and cfgMAC.xml. The cfg000x.xml is a common configuration file which doesn't include the account information. The "mac" only takes effect for specific phone. The file name is the 12-digit mac address of phone. For example, if the phone's mac address is 001fc11a0012, the cfg$mac file name must be cfg001fc11a0012; The cfgMAC.xml file name must be cfg001fc11a0012.xml.
The phone will try to download these CFG files from the server during provisioning.
Note: The IP Phones that in FW 1.0.3.70 or FW after 1.0.3.70 would only recognize CFG files which use UTF-8 or ANSI encoding.
2.2 Obtain phone information
Before provisioning, you need the phone information, like MAC address, SIP account of the phone.
MAC Address: The unique 12-digit serial number of the phone. You can obtain it from the back of the phone.
SIP Account Information: It may include SIP credentials, like user name, password and IP address of the SIP server. Contact your system administrator for SIP account information.
2.3 Manage configuration files
Auto provision enables Htek IP Phone to update automatically via downloading configuration files. Before provisioning, you may need to edit and customize your configuration file which is composed of many configuration parameters. A configuration parameter is associated with particular field in the web configuration page. A parameter consists of a Capital letter P and 2 to 5 digit numeric numbers. i.e., P2 is associated with "Admin Password" in the Advanced Page. For detailed parameter list, please refer to <<parameter list>> in page 77.
2.4 How to edit cfg000x.xml file
You can customize configuration parameters by editing XML configuration file "cfg000x.xml", and different device would use different file name. you can refer to << How to Edit cfg000x.xml>> in page 39.
2.5 How to edit cfg$mac file
Cfg$mac file is a binary format configuration. It contains configuration parameters which apply to all phone models.
The line beginning with "#" is considered to be the annotation, and easy to understand each P value.
The parameters commonly edited in the cfg$mac file are described as follows:
#################################################################################### ## Configuration template for UC860 firmware version 1.0.3.70 #################################################################################### #################################################################################### # Account Settings #################################################################################### #--------------------------------------- # Account 1--basic setting #---------------------------------------
# Account Active (In Use). 0 - No, 1 - Yes # Number: 0, 1 # Mandatory P271 = {$line_active.line.1|1}
# Primary SIP Server(eg:sip.mycompany.com or IP address) # String P47 = {$server_host.line.1}
# Failover SIP Server(Optional, used when primary server no response) # String P967 =
# Second Failover SipServer(Optional, used when Failover SIP Server no response) P8851 =
# Prefer Primary SIP Server(Yes-will register to Primary SIP Server if Failover registration expires ) # Prefer Primary SIP Server (In Use). 0 - No, 1 - Yes # Number: 0, 1 # Mandatory P4567 = 0
# Outbound Proxy(proxy.myprovider.com, or IP address, if any) # string P48 =
# Backup Outbound Proxy(This is Usually Set as IP addr) P20047 =
# SIP Transport # 0 - UDP, 1 - TCP, 2 - TLS P130 = 0
# NAT Traversal. 0 - No, 1 - STUN 2 - No,but send keep alive #Number: 0-2 # Mandatory P52 = 2
# Label(This name will be displayed on the device's LCD) P20000=
# SIP User ID P35 = {$username.line.1}
# Authenticate ID P36 = {$username.line.1}
# Authenticate password P34 = {$secret.line.1}
# Name P3 = {$displayname.line.1}
# DNS Mode. 0 - A Record, 1 - SRV, 2 - NAPTR/SRV # Number: 0-2 # Mandatory P103 = 0
# User ID Is Phone Number.0 - No, 1 - Yes # Number:0, 1 P63 = 0
# SIP Registration. 0 - No, 1 - Yes # Number:0, 1 # Mandatory P31 = 1
# Unregister On Reboot.0 - No, 1 - Yes # Number:0, 1 # Mandatory P81 = 1
# Register Expiration(in minutes. default 1 hour, max 45 days) P32 = 15
# Outgoing Call Without Registration.0 - No, 1 - Yes # Number:0, 1 # Mandatory P109 = 1
# Local SIP Port(default 5060) P40 = 5060
# Use Random Port.0 - No, 1 - Yes # Number:0, 1 # Mandatory P78 = 0
# Voice Mail UserID(UserID for voice mail system) P33 =
# RPort.0 - No, 1 - Yes P136 = 0
# RFC 2543 Hold.0 - No, 1 - Yes P1100 = 1 |
We offer free Configuration File generator software in both Linux/Unix and Windows platform.
You can refer to << Generate Configuration Files with HPT >> in page 44.
2.6 How to edit cfgMAC.xml file
General XML syntax consists of a list of name-value pairs. P-Value is the element and value of the element represents the value for a particular configuration which P-Value represents corresponding.
Method 1:
You need to download cfg.xml file from IP Phone webpage(Management->Configuration ->Download xml file) or download this cfgMAC.xml file from website www.htek.com, then change the file name to cfgMAC.xml(mac is IP Phone address), and open the cfgMAC.xml, See the below screen shot:
The parameters edited in the cfgMAC.xml file are described as follows:
<?xml version="1.0" encoding="UTF-8" ?> <hl_provision version="1"> <config version="1"> <!--Account1/Basic--> <P271 para="Account1.Active">1</P271> <P47 para="Account1.Sipserver" /> <P967 para="Account1.FailoverSipserver" /> <P8851 para="Account1.SecondFailoverSipserver" /> <P4567 para="Account1.PreferPrimaryServer">0</P4567> <P48 para="Account1.OutboundProxy" /> <P20047 para="Account1.BackUpOutboundProxy" /> <P130 para="Account1.SipTransport">0</P130> <P52 para="Account1.NatTraversal">2</P52> <P20000 para="Account1.Lable" /> <P35 para="Account1.SipUserId" /> <P36 para="Account1.AuthenticateID" /> <P34 para="Account1.AuthenticatePassword" /> <P3 para="Account1.DispalyName" /> <P103 para="Account1.DnsMode">0</P103> <P63 para="Account1.UserIdIsPhoneNumber">0</P63> <P31 para="Account1.SipRegistration">1</P31> <P81 para="Account1.UnregisterOnReboot">0</P81> <P32 para="Account1.RegisterExpiration">15</P32> <P109 para="Account1.OutCallWithoutReg">1</P109> <P40 para="Account1.LocalSipPort">5060</P40> <P78 para="Account1.UseRandomPort">0</P78> <P33 para="Account1.VoiceMailId" /> <P136 para="Account1.RPort">0</P136> <P1100 para="Account1.RFC2543Hold">1</P1100> <P8775 para="Account1.ConnectMode">0</P8775>; |
You can edit the value in <> </>field.
For example: The phone's SIP Server is 192.168.0.100, you need to edit the <P47 para="Account1.Sipserver">192.168.0.100</P47>.
If you want to configure others, for example: , you need to change it as , only in this way you can change the value.
Method 2:
Login phone webpage, configure each item you want (like, account information, programmable keys, firmware upgrade path...). Management ->Configuration, download XML file, then change the name to cfgMAC.xml.
3. Encrypt Configuration Files
Htek Configuration Generator allows user to encrypt the generated configuration file with AES 128 bit encryption. It allows user to choose not to encrypt the configuration file in Windows version, but it is recommended to use encryption for security reason.
3.1 How to encrypt the XML configuration file
The XML configuration file could be encrypted in AES-128-CBC algorithm. The encryption password is defined in P8631 (Management->Auto Provision->Set Common AES Key ) of the configuration file.
The Password length is from 1-16, and password must be[ 0-9, A-F]
THE SHARED IV:: 0B1E1D000F0B07091D1F04071F1E0407
The OpenSSL command-line to encrypt the file is as follows:
Openssl enc –e –aes-128-cbc –K <password> -iv 0B1E1D000F0B07091D1F04071F1E0407 –in cfg.xml –out cfgxxxxxxxxxxxx.xml
When the XML configuration file is encrypted in this method, Phone would only be able to decrypt and parse the file if user set the XML Config File Password in P8631 of binary configuration file or in the web UI.
Detailed steps:
Step 1: Login webpage, click Management→Configuration, download cfg.xml file, then run, input ”Openssl enc –e –aes-128-cbc –K <password> -iv 0B1E1D000F0B07091D1F04071F1E0407 –in cfg.xml –out Cfgxxxxxxxxxxxx.xml” (xxxxxxxxxxxx is the MAC address)
THE SHARED IV: 0B1E1D000F0B07091D1F04071F1E0407
Step 2: Put the Cfgxxxxxxxxxxxx.xml under upgrade server path
Step 3: You must set the AES Key: Management→Auto Provision: AES Key:
4. Customize Resource Files
Htek IP Phone allows to customize some resource files, like ring tone file, language package file and logo files. For how to customize resource files, as follows:
4.1 Customize ring tone
Htek IP Phone has several factory-default ring tones (Ring1, Ring2, Ring3). You can customize Ring4, Ring5, Ring6, Ring7 and Ring8 tone and upload them to the phone via auto provisioning.
You can change the ring tone configuration parameter to personalize ring tone:
For example: P8721 = 8
For more information on customizing ring tone file, please refer to <<Making Ringtone Notes>> in page 60.
4.2 Customize LCD language
Htek IP Phone supports multiple language, You can modify the language and add a new language to the phone. The following table lists all available languages, associated language files and language template file:
Available language | Associated language files | Language template file |
English | (Default, can't be customized) | LCD_English_Template.xml |
French | 1_Français(French).xml | |
German | 2_Deutsch(German).xml | |
Spanish | 3_Español(Spanish).xml | |
Portuguese | 4_Português(Portuguese).xml | |
Russian | 5_русский(Russian).xml | |
Italian | 6_Italiano(Italian).xml | |
Polish | 7_Polski(Polish).xml | |
Turkish | 8_Türk(Turkish).xml | |
Serbian | 9_Srpski(Serbian).xml | |
ChinesSimplified | 10_简体中文(ChineseSimplified).xml | |
ChineseTraditional | 11_繁体中文(ChineseTraditional).xml | |
Slovenian | 13_Slovenščina(Slovenian).xml | |
Persian | 14_Persian(Farsi).xml | |
Hebrew | 15_עברית(Hebrew).xml | |
Slovak | 16_Slovak.xml | |
Czech | 17_Czech.xml | |
JapaneseSimplified | 18_日本語(JapaneseSimplified).xml | |
Dutch | 19_Nederlands(Dutch).xml |
Below picture shows a portion of LCD_English_Template.xml file:
English is the default language, you can change configuration parameter to other languages:
For more information on customizing an LCD language, please refer to <<LCD Language custom guide>> in page 62.
4.3 Customize web language
Htek IP Phone supports multiple language , You can modify the language and add a new language to the phone's webpage. The following table lists all available languages, associated language files and language template file:
Available language | Associated language files | Language template file |
English | (Default, can't be customized) | Web_English_Template.js |
French | 1_French.js | |
German | 2_German.js | |
Spanish | 3_Spanish.js | |
Portuguese | 4_Portuguese.js | |
Russian | 5_Russian.js | |
Italian | 6_Italian.js | |
Polish | 7_Polish.js | |
Turkish | 8_Turkish.js | |
ChineseSimplified | 10_ChineseSimplified.js | |
ChineseTraditional | 11_ChineseTraditional.js | |
Dutch | 19_Dutch.js |
Below picture shows a portion of Web_English_Template.js file:
English is the default language, you can change configuration parameter to other languages:
For more information on customizing web language file, please refer to << Web Language custom guide>> in page 64.
4.4 Customizing wallpaper
You can customize Htek UC840/UC842/UC860/UC862 IP phones' wallpaper.
Below table shows wallpaper's format and resolution for UC840/UC842/UC860/UC862 IP phones:
Phone model | Photo format | Resolution | One file size | Photo number |
UC840/UC842/UC860/UC862 | .jpg, .bmp | 480*320 | <=2M | 6 |
Wallpaper2 is default wallpaper, you can change configuration parameter to other wallpaper:
For more information on customizing wallpaper, please refer to << LCD and Web GUI custom Guide >> in page 68.
4.5 Customizing screensaver
You can customize Htek UC840/UC842/UC860/UC862 IP phones' screensaver.
Below table shows screensaver's format and resolution for UC840/UC842/UC860/UC862 IP phones:
Phone model | Photo format | Resolution | One file size | Photo number |
UC840/UC842/UC860/UC862 | .jpg, .bmp | 480*320 | <=2M | 3 |
Screensaver default is Off, you can change configuration parameter to activate the Screensaver :
For more information on customizing screensaver, please refer to << LCD and Web GUI custom Guide >> in page 68.
4.6 Customizing weblogo
You can customize Htek all phone models' weblogo on webpage.
Phone model | Photo format | Resolution | File size |