Htek UC601 User manual

1
Htek UC9xx Series IP Phones
Auto Provision User Guide
Version 2.0.4.4.24
Feb. 2018

2
Table of Contents
1. Introduction.................................................................................................................1
2. Manage Configuration .................................................................................................1
2.1 Obtain configuration files....................................................................................3
2.2 Obtain phone information...................................................................................3
2.3 Manage configuration files..................................................................................3
2.4 How to edit cfg000x.xml file ................................................................................3
2.5 How to edit cfg$mac file......................................................................................3
2.6 How to edit cfgMAC.xml file................................................................................6
3. Encrypt Configuration Files..........................................................................................9
3.1 How to encrypt the XML configuration file...........................................................9
4. Customize Resource Files.........................................................................................11
4.1 Customize ring tone..........................................................................................11
4.2 Customize LCD language.................................................................................11
4.3 Customize web language.................................................................................13
4.4 Customizing wallpaper......................................................................................14
4.5 Customizing screensaver.................................................................................14
4.6 Customizing weblogo........................................................................................15
5. Upgrade resource files...............................................................................................15
5.1 How to configure URL for hlpres.tar..................................................................15
5.2 How to configure URL for Language.tar............................................................15
5.3 How to configure URL for exp_pres.tar.............................................................15
5.4 How to configure Path for ringx.bin...................................................................16
5.5 How to configure URL for Screensaver.............................................................16
5.6 How to configure URL for Wallpaper.................................................................16
6. Upgrade Firmware.....................................................................................................17
6.1 Configuring HTTP Server.................................................................................17
6.2 How to Configuring HTTP Server......................................................................17
7. Obtain Provisioning Server's Address........................................................................20
8. Update mode.............................................................................................................22
9. Download and Verify Configurations..........................................................................24
9.1 Download configuration files.............................................................................24
9.2 Resolve and Update configurations..................................................................24
9.3 Verify configurations.........................................................................................24
10. Firmware and Configuration File Prefix and Postfix..................................................27
11. Firmware Server and Configuration File Server........................................................29
12. Manage Firmware and Download Configuration File................................................30
13. Pre_Configuration and Configuration Redirection ....................................................31
14. Automatic Provisioning Within LAN..........................................................................32
15. Troubleshooting.......................................................................................................33
16. Glossary..................................................................................................................35
17. How to Edit cfg000x.xml ..........................................................................................36
18. Generate Configuration File with Htek Provision Tool and Upgrade the Configuration

3
File via HTTP/HTTPS/FTP/TFTP...................................................................................40
18.1 Generate the configuration file for Htek IP Phones..........................................40
18.2 Upgrade cfgMAC file via HTTP/TPFP/FTP/HTTPS.........................................46
18.2.1 Upgrade cfgMAC file via Htek Provision Tool........................................46
18.2.2 Upgrade cfgMAC file via configuring Htek IP Phone..............................51
19. Making Ringtone Notes ...........................................................................................56
20. LCD and Web Language Custom Guide..................................................................58
20.1 LCD Language custom guide .........................................................................58
20.2 Web Language custom guide .........................................................................60
21. LCD and Web GUI custom Guide............................................................................64
21.1 How to custom the wallpaper1-wallpaper6?....................................................64
21.2 How to custom the screensaver1- screensaver3?...........................................64
21.3 How to custom the weblogo?..........................................................................64
21.4 How to custom the eights menus(.png)in the main menu?..............................64
21.5 How to custom the ...Icon.png?.......................................................................64
21.6 How to custom the lcdlogo_color.png? ...........................................................65
21.7 How to customthe lcdlogo_bw.png?................................................................65
22. Firmware Upgrade...................................................................................................66
22.1 Upgrade through HTTP ..................................................................................66
22.2 Upgrade through TFTP...................................................................................67
22.3 Upgrade through FTP.....................................................................................70
22.4 Upgrade through HTTPS................................................................................71
23. Parameter List.........................................................................................................73

1
1. Introduction
Please note: 9xx including all models:
UC601/ UC901/ UC902/ UC903/ UC912/ UC912G/ UC912GM/ UC923/ UC924/ UC924E/
UC926/ UC926E
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 UC601/ UC901/ UC902/ UC903/ UC912/ UC912G/ UC912GM/ UC923/ UC924/
UC924E/ UC926/ UC926E
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 Filethat
download through TFTP/FTP/HTTP/HTTPS. All devices support a configuration file in
proprietary binary format. Products like UC9xx, Unicorn3xxx and Unicorn6xxx accept
configuration filesin 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 UC924 for example, the configuration file name should be
factory0012.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
UC601
0111
factory0111.bin/cfg0111.xml
UC901
0018
factory0018.bin/cfg0018.xml
UC902
0017
factory0017.bin/cfg0017.xml
UC903
0016
factory0016.bin/cfg0016.xml

2
UC912/UC912G/
UC912GM
0019
factory0019.bin/cfg0019.xml
UC923
0013
factory0013.bin/cfg0013.xml
UC924
0012
factory0012.bin/cfg0012.xml
UC924E
0112
factory0112.bin/cfg0112.xml
UC926
0010
factory0010.bin/cfg0010.xml
UC926E
0110
factory0110.bin/cfg0110.xml
Process of Htek products are as follows:
factory000x.bin -----used for factorydefault configuration for ODM/OEM
cfg000x.xml ----- used for update the common configuration which doesn’t include the
account information.
cfg001fc1xxxxxx ---- this file isa private format for each device
cfg001fc1xxxxxx.xml------used for configuration for each device. xml format
Provisioning Flow Chart:
Picture 1: Provisioning Flow Chart
Note: The provisioning program will apply and reload the settings after downloading the
newconfiguration 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.

3
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 FW1.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. Aconfiguration
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 68.
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 t o<< How
to Edit cfg000x.xml>> in page 40.
2.5 How to edit cfg$mac file
Cfg$mac file is a binary format configuration. It contains configuration parameters which

4
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 UC924 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 =

5
# 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 - ARecord, 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

6
# 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 HLLiteTool >> in the page 45.
2.6 How to edit cfgMAC.xml file
General XMLsyntax 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:

7
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" />

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

9
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 isas 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:

10

11
4. Customize Resource Files
Htek IP Phone allows to customize some resource files, like ring tone file, language
package fileand logo files. For howto 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 53.
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

12
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
Belowpicture shows a portion of LCD_English_Template.xml file:
English is the default language, you can change configuration parameter to other
languages:

13
For more information on customizing an LCD language, please refer to <<LCD Language
custom guide>> in page 56.
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
Belowpicture shows a portion of Web_English_Template.js file:

14
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 58.
4.4 Customizing wallpaper
You can customize Htek UC923/UC924/UC926 IP phones' wallpaper.
Belowtable shows wallpaper's format and resolution for UC923/UC924/UC926 IP phones:
Phone model
Photo format
Resolution
One file size
Photo number
UC923
.jpg, .bmp
320*240
<=2M
3
UC924
.jpg, .bmp
480*320
<=2M
3
UC924E
.jpg, .bmp
480*320
<=2M
3
UC926
.jpg, .bmp
480*272
<=2M
3
UC926E
.jpg, .bmp
480*272
<=2M
3
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 60.
4.5 Customizing screensaver
You can customize Htek UC923/UC924/UC926 IP phones' screensaver.
Belowtable shows screensaver's format and resolution for UC923/UC924/UC926 IP
phones:
Phone model
Photo format
Resolution
One file size
Photo number
UC923
.jpg, .bmp
320*240
<=2M
3
UC924
.jpg, .bmp
480*320
<=2M
3
UC924E
.jpg, .bmp
480*320
<=2M
3
UC926
.jpg, .bmp
480*272
<=2M
3
UC926E
.jpg, .bmp
480*272
<=2M
3
Screensaver default is Off, you can change configuration parameter to activate the

15
Screensaver :
For more information on customizing screensaver, please refer to <<LCDand Web GUI
custom Guide >> in page 61.
4.6 Customizing weblogo
You can customize Htek all phone models' weblogo on webpage.
Phone model
Photo format
Resolution
File size
UC601/UC901/UC902/UC903/UC912/
UC912G/UC912GM/UC923/UC924/U
C924E/UC926/UC926E
.jpg
225*93
<=2M
For more information on customizing weblogo, please refer to << LCD and Web GUI
custom Guide >> in page 61.
5. Upgrade resource files
Htek IP phone supports upgrade resource files through URL (support HTTP(s) server).
The files contain hlpres.tar, Language.tar, ring4.bin, ring5.bin, ring6.bin, ring7.bin,
ring8.bin, exp_pres.tar, Screensaver and Wallpaper. For howto configure these files URL
as follow:
5.1 How to configure URL for hlpres.tar
You can change the hlpres server configuration parameter to locate the file:
P20176=http(s)://192.168.0.254/hlpres.tar
5.2 How to configure URL for Language.tar
You can change the Language server configuration parameter to locate the file:
P20175=http(s)://192.168.0.254/Language.tar
5.3 How to configure URL for exp_pres.tar
You can change the exp_pres server configuration parameter to locate the file:
P20177=http(s)://192.168.0.254/exp_pres.tar

16
5.4 How to configure Path for ringx.bin
You can change the Ring server configuration Path, and IP Phone will get the files:
ring4.bin, ring5.bin, ring6.bin, ring7.bin, ring8.bin automatically:
P20174=http(s)://192.168.0.254
5.5 How to configure URL for Screensaver
This parameter is only applicable to UC923, UC924, UC924E, UC926, UC926E.
You can change the Screensaver server configuration to locate the file:
P20051=http(s)://192.168.0.254/Screensaver.jpg
Note: 1. Screensaver file phone gets from server will cover the screensaver photo1.
2. Only support format .jpg, .bmp.
5.6 How to configure URL for Wallpaper
You can change the Wallpaper server configuration to locate the file:
P20052=http(s)://192.168.0.254/wallpaper.jpg
Note: 1. Wallpaper file phone gets from server will cover the wallpaper6.
2. Only support format .jpg, .bmp.

17
6. Upgrade Firmware
Version number and support files list:
Note:
When the phone which version is 1.0.3.71 or older upgrade to 1.0.3.73, phone will
upgrade img_9xx.bin then automatically upgrade fw9xx.rom. fw9xx.rom is all-in-one
firmware file. After upgrading to the 1.0.3.73 firmware, in the next time, phone will only
need upgrade one file fw9xx.rom.
6.1 Configuring HTTP Server
Htek IP Phone supports using FTP, TFTP, HTTP and HTTPS protocols to obtain the
address of provision server. Default way is HTTP. For how to configure a HTTP server, as
follows:
You can download a free HTTP server from http://httpd.apache.org/ or use Microsoft IIS
web server. Then setup HTTP server.
For more information on how to configure TFTP, FTP and HTTPS servers, please refer to
Upgrade through TFTP in page 63, Upgrade through FTP in page 66 and Upgrade
through HTTPS in page 67.
6.2 How to Configuring HTTP Server
Login webpage, “Management” -> “Auto Provision” ->”Firmware Upgrade” -> “Upgrade
Mode” needs to be set to HTTP. “Firmware Server Path” needs to be set to be a valid URL
of a HTTP server, and server name can be in either FQDNor IP address format. Below
are examples of some valid URLs.
e.g. firmware.mycompany.com:5688/Htek
1.0.3.58-1.0.3.72
1.0.3.73 or later
boot_9xx.bin
img_9xx.bin
hlpres.tar
Language.tar
ring4.bin
ring5.bin
ring6.bin
ring7.bin
ring8.bin
fw9xx.rom