TIPTEL 31xx series User manual

Configuration Guide (en)
Version 3.1 from March 24, 2015
tiptel 31xx
Configuration Guide for Tiptel.com SIP Phones 31xx Page 1 / 252
tiptel

Index
1 Preface..........................................................................................................................................................4
1.1 Introduction..........................................................................................................................................4
1.2 Version of the configuration interface..................................................................................................4
1.3 Note......................................................................................................................................................4
1.4 Legend..................................................................................................................................................5
1.5 bbreviations.......................................................................................................................................5
2 Configuration File Format............................................................................................................................6
2.1 Notes.....................................................................................................................................................6
2.2 Inifile Version Header..........................................................................................................................7
3 utoprovisioning........................................................................................................................................10
3.1 Example..............................................................................................................................................10
3.2 uto ction.........................................................................................................................................11
3.3 utoUpload........................................................................................................................................13
3.3.1 Restrictions.................................................................................................................................13
3.3.2 Upload Resource.........................................................................................................................14
3.3.2.1 Firmware............................................................................................................................14
3.3.2.2 Internal XML Phone Book..................................................................................................15
3.3.2.3 Background Images............................................................................................................16
3.3.2.4 Client Certificates (V3.1 or later).......................................................................................17
3.3.2.5 Contact Images...................................................................................................................18
3.3.2.6 Display Language...............................................................................................................19
3.3.2.7 Web Language....................................................................................................................20
3.3.2.8 Ringtones............................................................................................................................21
3.3.2.9 Trusted Certificates.............................................................................................................22
3.3.2.10 Softkeys XML Configuration (V3.0 or later)....................................................................23
3.3.2.11 Licensing (V3.0 or later)...................................................................................................24
3.3.2.11.1 Example....................................................................................................................24
3.3.2.12 VPN (V3.1 or later)..........................................................................................................25
3.3.2.13 ccess Control File...........................................................................................................26
3.3.2.13.1 Example....................................................................................................................26
3.4 ccess control.....................................................................................................................................27
3.4.1 Set the access level.....................................................................................................................27
3.4.2 Valid acces level values..............................................................................................................27
3.4.3 Set the access level for configuration items (V2.0 or later).........................................................28
3.4.4 Examples:...................................................................................................................................28
3.4.5 Set the access level forGUI Language........................................................................................29
3.4.6 Setting access level for SIP Codec Selection..............................................................................30
3.4.7 Set the access level for web pages..............................................................................................31
3.4.8 Set the access level for maintenance (prospective).....................................................................50
3.4.9 Set the access level for resource files (prospective)....................................................................53
3.5 License Keys (V3.0 or later)...............................................................................................................58
4 dditional Features.....................................................................................................................................59
5 Configuration..............................................................................................................................................60
5.1 SIP ccounts......................................................................................................................................60
5.2 DECT-Module..................................................................................................................................101
5.3 Funktion Keys, Selection Keys.........................................................................................................102
5.3.1 General.....................................................................................................................................102
5.3.2 Description of Function keys....................................................................................................102
5.3.2.1 Example............................................................................................................................103
5.3.3 Extention Module.....................................................................................................................104
5.3.4 Phone Funktion Keys................................................................................................................106
Configuration Guide for Tiptel.com SIP Phones 31xx Page 2 / 252

5.3.5 Description of Selection Keys...................................................................................................107
5.3.5.1 Example............................................................................................................................107
5.3.6 Phone Selection Keys...............................................................................................................108
5.3.7 Control Keys (V2.0 or later).....................................................................................................109
5.4 System settings.................................................................................................................................119
5.4.1 utoprovisioning......................................................................................................................119
5.4.2 Debug.......................................................................................................................................127
5.4.3 Jitter..........................................................................................................................................128
5.4.4 Local Time................................................................................................................................131
5.4.4.1 Time Zone Table...............................................................................................................138
5.4.5 N T..........................................................................................................................................141
5.4.6 Network Settings......................................................................................................................143
5.4.7 Other System settings...............................................................................................................149
5.4.7.1 SIP Options.......................................................................................................................151
5.5 User Settings.....................................................................................................................................162
5.5.1 PBX Sync / ction URL...........................................................................................................162
5.5.2 lert Info..................................................................................................................................177
5.5.3 lphablending..........................................................................................................................178
5.5.4 Call ForwardingUnconditional (CFU)......................................................................................182
5.5.5 uto Redial...............................................................................................................................184
5.5.6 Busy Forward (CFB)................................................................................................................185
5.5.7 DND.........................................................................................................................................187
5.5.8 Features....................................................................................................................................188
5.5.9 Keylock Exception Numbers....................................................................................................196
5.5.10 Language................................................................................................................................197
5.5.11 Internal call lists......................................................................................................................199
5.5.12 Telephone register..................................................................................................................200
5.5.12.1 Settings for internal telephone register............................................................................200
5.5.12.2 Services...........................................................................................................................202
5.5.12.3 Settings for external XML telephone register.................................................................203
5.5.13 Phone Settings........................................................................................................................205
5.5.14 Phone Volume........................................................................................................................215
5.5.15 Pound Send.............................................................................................................................218
5.5.16 Call Forwarding On No Response (CFNR)............................................................................219
5.5.17 Custom Tone Settings.............................................................................................................222
5.5.18 User ccess............................................................................................................................229
5.5.19 Webserver...............................................................................................................................231
5.5.20 Other settings..........................................................................................................................233
5.6 Door station (V3.1 or later)...............................................................................................................234
5.7 Internal Voicemail (V3.0 or later, license required)..........................................................................241
6 History of this document...........................................................................................................................250
Configuration Guide for Tiptel.com SIP Phones 31xx Page 3 / 252

Preface
1 Preface
1.1 Introduction
This SIP IP Phone Configuration Guide provides information on the configuration interface of the IP phones,
Models 31xx.
1.2 Version of the configuration interface
Current version of this configuration interface: 1.00.001
1.3 Note
•all token and values are case sensitive
•all values UTF-8
•invalid characters for all values: any character from 0x00 to 0x1F
•passwords are stored encrypted. Do not change the enryption method in the _Version section when
restoring a configuration that you have previously saved through the webinterface.
•parameter and groups are generally published in the same order as they stored in the configuration
file of the phone
•# hash starts a commentary only at the beginning of a new line (1st column)
•do not add comments at the end of a line
•some parameter will take effect only after restarting the phone (reboot required)
•missing parameter in the configuration file are left unchanged
•non existing items or illegal values are ignored
•have a look at Service/Trace → Phonelog on configuration trouble (fg.log and cm.log)
•you can download the current version of the configuration file through the web interface
Configuration Guide for Tiptel.com SIP Phones 31xx Page 4 / 252

Preface
1.4 Legend
#n, #a, etc... index, replace according to description
[Section] Section name in a ini file
[Optional] Optional parameter in value, e.g. f1[+f2]/t1_on[-t1_off]: f2 & t1_off are optional
<model>.cfg phone type specific configuration
<mac>.cfg mac specific configuration, according to the mac address of the phone
path/to/cfg manue pathwalk to configuration site (Web UI and Phone IU)
→ param name of configuration parameter in Web UI and Phone UI
Config:blank user ressource file, e.g. Config: myRingtone.wav
System:blank system ressource file, e.g. System: lps.jpg
1.5 Abbreviations
PI Application Programming Interface
GUI Graphic User Interface
M C Media Access Control
SIP Session Initiation Protocol
UI User Interface
URL Uniform Resource Locator, in this document the same as URI
URI Uniform Resource Identifier RFC's 1630, 3986
XML eXtensible Markup Language
Configuration Guide for Tiptel.com SIP Phones 31xx Page 5 / 252

Configuration File Format
2 Configuration File Format
We use the INI-file format for configuration files (see Wikipedia for further information).
2.1 Notes
•sections with leading underscore in their name are for identification and managing configuration
files. Some of these sections will only work with utoprovisioning
•we support multiple key names in these sections, e.g. to etstablish file uploads
•keys within sections without leading underscore are handled as configuration values
•sections and keys can be arranged as desired. In case of duplicate keys, the last wins.
Configuration Guide for Tiptel.com SIP Phones 31xx Page 6 / 252

Configuration File Format
2.2 Inifile Version Header
The version header is used to identify the file and to acquire basic information of the data structure. The
version header consists of the following elements:
Parameter —
[_Version]
Type
Web UI N/
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription Type of configuration file
Format String
Default Value inifile
Range inifile: configuration in ini-file format
Note mandatory
Example [_Version]
Type=inifile
Parameter —
[_Version]
Version
Web UI N/
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription Version number of theconfiguration interface
(you can get the current version of the interface by saving
configuration through the webinterface)
Format String
Default Value 1.00.000
Range major.minor.revision [.build]
Note mandatory
Example [_Version]
Version=1.0.0
Configuration Guide for Tiptel.com SIP Phones 31xx Page 7 / 252

Configuration File Format
Parameter —
[_Version]
PWDEncryption
Web UI N/
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription Method of password encryption
Format Enum
Default Value 1
Range 0: not encrypted, 1: encryption method #1
Note mandatory for configuration files containing passwords
You may use encrypted passwords and plain passwords in the
same file, e.g. webserver credentials encrypted (from a saved
configuration) and SIP credentials in plain text.
In this case set PWDEncryption to the same value as stored in
the configuration file
Example [_Version]
PWDEncryption=1
Parameter —
[_Version]
SectionOffset
Web UI N/
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription section offset for all parameter
Format String
Default Value
Range
Note optional, leave blank or do not set
Example [_Version]
SectionOffset=
Configuration Guide for Tiptel.com SIP Phones 31xx Page 8 / 252

Configuration File Format
Parameter —
[_Version]
Timestamp
Web UI N/
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription timestamp for configuration file
Format String
Default Value N/
Range
Note ignore, do not set
Example N/
Configuration Guide for Tiptel.com SIP Phones 31xx Page 9 / 252

utoprovisioning / utoprovisioning
3 Autoprovisioning
utoprovisioning is a method to configure the phone in larger installations, using your own provisioning
server. The provisioning server may create individual configuration files for each phone depending on the
internal server rules and the IP- dress or User gent of the phone. Common files for all phones, e.g.
ringtones, might be located on the provisionig server too.
The utoprovisioning file is an extended configuration file (INI-file format).
3.1 E ample
Configuration Guide for Tiptel.com SIP Phones 31xx Page 10 / 252
# *** version header for identification ***
[_Version]
Type=inifile
Version=1.00.001
PWD ncryption=1
# *** extended commands for Autoprovisioning ***
[_AutoAction]
FactoryReset=no
Reboot=no
[_AutoUpload]
Firmware=http://www.myServer.com/fw/newFirmware.rom
Ringtone=ringring.wav
# *** normal configuration ***
[user/Webserver]
HttpPort=8080

utoprovisioning / uto ction
3.2 AutoAction
The [_ uto ction] section provides the ability to control the behavior of the phone while proceeding
utoprovisionig.
Some of these commands can be executed via HTTP Push XML or HTTP Remote ction-URL too, see
XML-User Guide on our download area.
Parameter —
[_ uto ction]
Reboot
Web UI Service/Upgrade → Reboot
Phone UI Status → Restart
Configuration Files <model>.cfg, <mac>.cfg
Des ription determine the reboot behavior after proceeding the
utoprovisioning file
Format String Enum
Default Value no
Range no, IfRequired, OnCfgChanged, yes
no: no reboot even if some changes requires reboot
IfRequired: reboot if reqired by configuration
OnCfgChanged: reboot if configuration changed
yes: reboot unconditional
Note optional
in some case the phone will reboot every time regardless of
this setting, e.g. firmware update
Example [_ uto ction]
Reboot=no
Configuration Guide for Tiptel.com SIP Phones 31xx Page 11 / 252

utoprovisioning / uto ction
Parameter —
[_ uto ction]
FactoryReset
Web UI Service/Upgrade → Factory reset
Phone UI Status → Restore to Factory Default
Configuration Files <model>.cfg, <mac>.cfg
Des ription perform factory reset
Factory Reset by utoprovisioning deletes configuration and
user files.
In contrast Factory Reset through web or by phone will format
the internal configuration flash partition
Format String Enum
Default Value no
Range no, Complete, CfgOnly
no: no factory reset before proceeding configuration file
Complete: delete configuration including user ressources as
background images, user ringtones
CfgOnly: configuration only
Note optional
the phone reboots automatically on factory reset after
proceeding the utoprovisioning file
Example [_ uto ction]
FactoryReset=no
Configuration Guide for Tiptel.com SIP Phones 31xx Page 12 / 252

utoprovisioning / utoUpload
3.3 AutoUpload
The [_ utoUpload] section provides the ability to load more resources into the phone while executing the
utoprovisionig file. You can upload resource files as ringtones, images or you can update the firmware. The
following restrictions apply for uploads:
3.3.1 Restrictions
There are following restrictions apply for uploads:
ressour e ext format limit max. file size note
Firmware proprietary 1 file per
utoprovisioning file
handled by firmware, depends on
the size of the internal flash
Internal Phone
Book
xml 1000 entries 500k
Contact images jpg,
jpeg,
png
jpg,
png
2M folder size, max 100
images
20k
max resulution 480*272 *1)
Bachkround
images
jpg,
jpeg,
png
jpg,
png
2M folder size, max 20
images
200k
max resulution 480*272 *1)
Ringtones wav 16-bit,
8KHz,
mono, G.711
-law
500k folder size, max 20
ringtones
50k
Display language
file
csv csv 500k / max 10 languages 50k
Web language
files
csv csv 1M / max 10 languages 100k
Client certificates crt,
pem,
cer
crt,
pem,
cer
500k folder size / max
100 certificates
5k
Softkeys
XMLConf
xml see xml
user guide
1 file 500k V3.0
License Keys ini 1 file per
utoprovisioning file
depends on the internal memory V3.0
*1) The current firmware doesn't check the resulution of a background image on upload. If you chose an
image with higher resolution the display will show a white background.
Configuration Guide for Tiptel.com SIP Phones 31xx Page 13 / 252

utoprovisioning / utoUpload
3.3.2 Upload Resource
Here you can upload resource files during utoprovisioning. ll uploads are executed after proceeding new
configuration.
Please note that the instructions in this section are not executed if the autoprovisioning file has not changed.
Thus, it is not checked whether a resource has changed, to be loaded with one of the following commands.
3.3.2.1 Firmware
Parameter —
[_ utoUpload]
Firmware
Web UI Service/Upgrade → Firmware
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription Set the URL to upload new firmware
Format URL
Default Value
Range
Note optional
Do not turn power off while updating the phone!
fter firmware update the phone will reboot every time regardless of
other settings
Example [_ utoUpload]
Firmware=http://www.myServer.com/fw/newFirmware.rom
Configuration Guide for Tiptel.com SIP Phones 31xx Page 14 / 252

utoprovisioning / utoUpload
3.3.2.2 Internal XML Phone Book
Parameter —
[_ utoUpload]
XMLContacts
Web UI Contacts/Contacts → Import
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription Set the URL to upload new internal phonebook (XML Format)
Format URL
Default Value
Range
Note optional
see Tip_xml_api.pdf on our download area for further information
or
download the current version of the internal phonekook through the
web interface
Please use the settings for the external telephone register, if you
want to syn hronize regularly, see hapter 5.5.12.3 Settings for
external XML telephone register
Example [_ utoUpload]
XMLContacts=http://www.myServer.com/newContacts.xml
Configuration Guide for Tiptel.com SIP Phones 31xx Page 15 / 252

utoprovisioning / utoUpload
3.3.2.3 Background Images
Parameter —
[_ utoUpload]
BackGroundImage
Web UI Phone/Preferences → Load background
image
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription Set the URL to upload new background image
Format URL
Default Value
Range Supported extensions: jpg, png
Note optional, multiple use allowed (up to 20 times)
Example [_ utoUpload]
BackGroundImage=http://www.myServer.com/myGrandma.jpg
BackGroundImage=http://www.myServer.com/myGrandfather.jpg
Parameter —
[_ utoUpload]
BackGroundImage.delete
Web UI Phone/Preferences → Delete background
image
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription delete the specified background image or all background images
Format Filename
Default Value
Range Filename or *
Note optional, multiple use allowed (up to 20 times)
Example [_ utoUpload]
BackGroundImage.delete=myGrandma.jpg
BackGroundImage.delete=myGrandfather.jpg
or
BackGroundImage.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 16 / 252

utoprovisioning / utoUpload
3.3.2.4 Client Certificates (V3.1 or later)
Parameter —
[_ utoUpload]
ClientCert
Web UI Security/Client Certs → Import Client
Certificate
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Version V3.1 or later
Des ription Set the URL to upload new certificate
Format URL
Default Value
Range Supported extensions: crt, pem, cer
Note optional, 1 file allowed
Example [_ utoUpload]
ClientCert=http://www.myServer.com/cert.pem
Parameter —
[_ utoUpload]
ClientCert.delete
Web UI Security/Client Certs → Delete
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Version V3.1 or later
Des ription delete the specified certificate
Format *
Default Value
Range *
Note optional
Example [_ utoUpload]
ClientCert.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 17 / 252

utoprovisioning / utoUpload
3.3.2.5 Contact Images
Parameter —
[_ utoUpload]
ContactImage
Web UI Contacts/Contact Images → Upload
contact image
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription Set the URL to upload new contact image
Format URL
Default Value
Range Supported extensions: jpg, png
Note optional, multiple use allowed (up to 100 times)
Example [_ utoUpload]
ContactImage=http://www.myServer.com/myGrandma.jpg
ContactImage=http://www.myServer.com/myGrandfather.jpg
Parameter —
[_ utoUpload]
ContactImage.delete
Web UI Contacts/Contact Images → Delete image
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription delete the specified contact image or all contact images
Format Filename
Default Value
Range Filename or *
Note optional, multiple use allowed (up to 100 times)
Example [_ utoUpload]
ContactImage.delete=myGrandma.jpg
ContactImage.delete=myGrandfather.jpg
or
ContactImage.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 18 / 252

utoprovisioning / utoUpload
3.3.2.6 Display Language
Parameter —
[_ utoUpload]
CSVDisplayLanguage
Web UI Phone/Service/Upgrade → Load display
language file
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription Set the URL to upload new language file
Format URL
Default Value
Range
Note optional, multiple use allowed (up to 10 times)
you can acquire an example from our download area for further
information
Example [_ utoUpload]
CSVDisplayLanguage=http://www.myServer.com/language.en
Parameter —
[_ utoUpload]
CSVDisplayLanguage.delete
Web UI Phone/Service/Upgrade → Delete display
language file
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription delete the specified display language file or alldisplay language files
Format Filename
Default Value
Range Filename or *
Note optional, multiple use allowed (up to 10 times)
Example [_ utoUpload]
CSVDisplayLanguage.delete=language.en
or
CSVDisplayLanguage.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 19 / 252

utoprovisioning / utoUpload
3.3.2.7 Web Language
Parameter —
[_ utoUpload]
CSVWebLanguage
Web UI Phone/Service/Upgrade → Load web
language file
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription Set the URL to upload new language file
Format URL
Default Value
Range
Note optional, multiple use allowed (up to 10 times)
you can acquire an example from our download area for further
information
Example [_ utoUpload]
CSVWebLanguage=http://www.myServer.com/language.en
Parameter —
[_ utoUpload]
CSVWebLanguage.delete
Web UI Phone/Service/Upgrade → Delete web
language file
Phone UI N/
Configuration Files <model>.cfg, <mac>.cfg
Des ription delete the specified web language file or web language files
Format Filename
Default Value
Range Filename or *
Note optional, multiple use allowed (up to 10 times)
Example [_ utoUpload]
CSVWebLanguage.delete=language.en
or
CSVWebLanguage.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 20 / 252