TIPTEL 31xx series, 31 series Configuration 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
2 Configuration File Format............................................................................................................................6
3 Autoprovisioning........................................................................................................................................10
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 Access Control File........................................................................................................... 26
3.3.2.13.1 Example....................................................................................................................26
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
4 Additional Features..................................................................................................................................... 59
5 Configuration.............................................................................................................................................. 60
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.1 Autoprovisioning......................................................................................................................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 NAT..........................................................................................................................................141
5.4.6 Network Settings...................................................................................................................... 143
5.4.7 Other System settings............................................................................................................... 149
5.4.7.1 SIP Options....................................................................................................................... 151
5.5.1 PBX Sync / Action URL...........................................................................................................162
5.5.2 Alert Info.................................................................................................................................. 177
5.5.3 Alphablending..........................................................................................................................178
5.5.4 Call ForwardingUnconditional (CFU)......................................................................................182
5.5.5 Auto 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 Access............................................................................................................................ 229
5.5.19 Webserver...............................................................................................................................231
5.5.20 Other settings..........................................................................................................................233
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: Alps.jpg
1.5 Abbreviations
API Application Programming Interface GUI Graphic User Interface MAC 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 Autoprovisioning
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/A Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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/A Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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/A Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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/A Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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/A Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description timestamp for configuration file
Format String
Default Value N/A
Range
Note ignore, do not set
Example N/A
Configuration Guide for Tiptel.com SIP Phones 31xx Page 9 / 252
Autoprovisioning / Autoprovisioning
3 Autoprovisioning
Autoprovisioning 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-Adress or User Agent of the phone. Common files for all phones, e.g. ringtones, might be located on the provisionig server too.
The Autoprovisioning file is an extended configuration file (INI-file format).
3.1 Example
Configuration Guide for Tiptel.com SIP Phones 31xx Page 10 / 252
# *** version header for identification ***
[_Version] Type=inifile Version=1.00.001 PWDEncryption=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
Autoprovisioning / AutoAction
3.2 AutoAction
The [_AutoAction] section provides the ability to control the behavior of the phone while proceeding Autoprovisionig.
Some of these commands can be executed via HTTP Push XML or HTTP Remote Action-URL too, see XML-User Guide on our download area.
Parameter —
[_AutoAction] Reboot
Web UI Service/Upgrade → Reboot Phone UI Status → Restart Configuration Files <model>.cfg, <mac>.cfg
Description determine the reboot behavior after proceeding the
Autoprovisioning 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 [_AutoAction]
Reboot=no
Configuration Guide for Tiptel.com SIP Phones 31xx Page 11 / 252
Autoprovisioning / AutoAction
Parameter —
[_AutoAction] FactoryReset
Web UI Service/Upgrade → Factory reset Phone UI Status → Restore to Factory Default Configuration Files <model>.cfg, <mac>.cfg
Description perform factory reset
Factory Reset by Autoprovisioning 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 Autoprovisioning file
Example [_AutoAction]
FactoryReset=no
Configuration Guide for Tiptel.com SIP Phones 31xx Page 12 / 252
Autoprovisioning / AutoUpload
3.3 AutoUpload
The [_AutoUpload] section provides the ability to load more resources into the phone while executing the Autoprovisionig 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:
ressource ext format limit max. file size note
Firmware proprietary 1 file per
Autoprovisioning 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 A-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
Autoprovisioning 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
Autoprovisioning / AutoUpload
3.3.2 Upload Resource
Here you can upload resource files during Autoprovisioning. All 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 —
[_AutoUpload] Firmware
Web UI Service/Upgrade → Firmware Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description Set the URL to upload new firmware
Format URL
Default Value
Range
Note optional
Do not turn power off while updating the phone!
After firmware update the phone will reboot every time regardless of other settings
Example [_AutoUpload]
Firmware=http://www.myServer.com/fw/newFirmware.rom
Configuration Guide for Tiptel.com SIP Phones 31xx Page 14 / 252
Autoprovisioning / AutoUpload
3.3.2.2 Internal XML Phone Book
Parameter —
[_AutoUpload] XMLContacts
Web UI Contacts/Contacts → Import Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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 synchronize regularly, see chapter 5.5.12.3 Settings for external XML telephone register
Example [_AutoUpload]
XMLContacts=http://www.myServer.com/newContacts.xml
Configuration Guide for Tiptel.com SIP Phones 31xx Page 15 / 252
Autoprovisioning / AutoUpload
3.3.2.3 Background Images
Parameter —
[_AutoUpload] BackGroundImage
Web UI Phone/Preferences → Load background
image
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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 [_AutoUpload]
BackGroundImage=http://www.myServer.com/myGrandma.jpg BackGroundImage=http://www.myServer.com/myGrandfather.jpg
Parameter —
[_AutoUpload] BackGroundImage.delete
Web UI Phone/Preferences → Delete background
image
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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 [_AutoUpload]
BackGroundImage.delete=myGrandma.jpg BackGroundImage.delete=myGrandfather.jpg or BackGroundImage.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 16 / 252
Autoprovisioning / AutoUpload
3.3.2.4 Client Certificates (V3.1 or later)
Parameter —
[_AutoUpload] ClientCert
Web UI Security/Client Certs → Import Client
Certificate
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Version V3.1 or later
Description Set the URL to upload new certificate
Format URL
Default Value
Range Supported extensions: crt, pem, cer
Note optional, 1 file allowed
Example [_AutoUpload]
ClientCert=http://www.myServer.com/cert.pem
Parameter —
[_AutoUpload] ClientCert.delete
Web UI Security/Client Certs → Delete Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Version V3.1 or later
Description delete the specified certificate
Format *
Default Value
Range *
Note optional
Example [_AutoUpload]
ClientCert.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 17 / 252
Autoprovisioning / AutoUpload
3.3.2.5 Contact Images
Parameter —
[_AutoUpload] ContactImage
Web UI Contacts/Contact Images → Upload
contact image
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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 [_AutoUpload]
ContactImage=http://www.myServer.com/myGrandma.jpg ContactImage=http://www.myServer.com/myGrandfather.jpg
Parameter —
[_AutoUpload] ContactImage.delete
Web UI Contacts/Contact Images → Delete image Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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 [_AutoUpload]
ContactImage.delete=myGrandma.jpg ContactImage.delete=myGrandfather.jpg or ContactImage.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 18 / 252
Autoprovisioning / AutoUpload
3.3.2.6 Display Language
Parameter —
[_AutoUpload] CSVDisplayLanguage
Web UI Phone/Service/Upgrade → Load display
language file
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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 [_AutoUpload]
CSVDisplayLanguage=http://www.myServer.com/language.en
Parameter —
[_AutoUpload] CSVDisplayLanguage.delete
Web UI Phone/Service/Upgrade → Delete display
language file
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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 [_AutoUpload]
CSVDisplayLanguage.delete=language.en or CSVDisplayLanguage.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 19 / 252
Autoprovisioning / AutoUpload
3.3.2.7 Web Language
Parameter —
[_AutoUpload] CSVWebLanguage
Web UI Phone/Service/Upgrade → Load web
language file
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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 [_AutoUpload]
CSVWebLanguage=http://www.myServer.com/language.en
Parameter —
[_AutoUpload] CSVWebLanguage.delete
Web UI Phone/Service/Upgrade → Delete web
language file
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description 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 [_AutoUpload]
CSVWebLanguage.delete=language.en or CSVWebLanguage.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 20 / 252
Autoprovisioning / AutoUpload
3.3.2.8 Ringtones
Parameter —
[_AutoUpload] Ringtone
Web UI Phone/Ring → Upload ringtone Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description Set the URL to upload new ringtone
Format URL
Default Value
Range Supported extensions: wav
Note optional, multiple use allowed (up to 20 times)
Example [_AutoUpload]
Ringtone=http://www.myServer.com/ringring.wav
Parameter —
[_AutoUpload] Ringtone.delete
Web UI Phone/Ring → Delete ringtone Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description delete the specified ringtone or all ringtones
Format Filename
Default Value
Range Filename or *
Note optional, multiple use allowed (up to 20 times)
Example [_AutoUpload]
Ringtone.delete=ringring.wav or Ringtone.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 21 / 252
Autoprovisioning / AutoUpload
3.3.2.9 Trusted Certificates
Parameter —
[_AutoUpload] TrustedCert
Web UI Security/Trusted Certs → Import Trusted
Certificate
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description Set the URL to upload new certificate
Format URL
Default Value
Range Supported extensions: crt, pem, cer
Note optional, multiple use allowed (up to 100 times)
Example [_AutoUpload]
TrustedCert=http://www.myServer.com/cert.pem
Parameter —
[_AutoUpload] TrustedCert.delete
Web UI Security/Trusted Certs → Delete Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description delete the specified certificate
Format Filename
Default Value
Range Filename or *
Note optional, multiple use allowed (up to 100 times)
Example [_AutoUpload]
TrustedCert.delete=cert.pem or TrustedCert.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 22 / 252
Autoprovisioning / AutoUpload
3.3.2.10 Softkeys XML Configuration (V3.0 or later)
Parameter —
[_AutoUpload] SoftkeysXMLConf
Web UI Phone/Service/Upgrade → Load web
language file
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Version V3.0 or later
Description Set the URL to upload new softkey configuration file
Format URL
Default Value
Range
Note optional
see Tip_xml_api.pdf on our download area for further information
Example [_AutoUpload]
SoftkeysXMLConf=http://www.myServer.com/mySoftkeys.xml
Parameter —
[_AutoUpload] SoftkeysXMLConf.delete
Web UI Phone/Service/Upgrade → Delete web
language file
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Version V3.0 or later
Description delete the specified softkey file or softkey files
Format Filename
Default Value
Range Filename or *
Note optional
Example [_AutoUpload]
SoftkeysXMLConf.delete=softkeys.xml (fix internal filename) or SoftkeysXMLConf.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 23 / 252
Autoprovisioning / AutoUpload
3.3.2.11 Licensing (V3.0 or later)
Parameter —
[_AutoUpload] LicenseKeys
Web UI Service/Licensing → Import License Key Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Version V3.0 or later
Description Upload license keys to unlock optional features
Format URL
Default Value
Range ini file format:
[_Licensing] MAC=KEY MAC: 12-digit MAC address of the phone KEY: purchased key
non corresponding MACs will be ignored
Note optional
Example [_AutoUpload]
LicenseKeys=http://www.myServer.com/licenses.ini
3.3.2.11.1 Example
Configuration Guide for Tiptel.com SIP Phones 31xx Page 24 / 252
# *** version header for identification ***
[_Version] Type=inifile Version=1.00.000
# *** import licenses (only corresponding macs will take effect) ***
[_Licensing] 000CC4300100=
purchased_license_key_for_mac
000CC4300101=
purchased_license_key_for_mac
000CC4300102=
purchased_license_key_for_mac
000CC4300103=
purchased_license_key_for_mac
Autoprovisioning / AutoUpload
3.3.2.12 VPN (V3.1 or later)
Parameter —
[_AutoUpload] VPNConfiguration
Web UI Network/Advanced → Upload
configuration
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Version V3.1 or later
Description Upload VPN Configuration
Format URL
Default Value
Range tar file, see Web / Wiki for further information
Note optional
Example [_AutoUpload]
VPNConfiguration=http://www.myServer.com/cfg.tar
Parameter —
[_AutoUpload] VPNConfiguration.delete
Web UI Network/Advanced → Upload
configuration
Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Version V3.1 or later
Description delete VPN configuration
Format *
Default Value
Range *
Note optional
Example [_AutoUpload]
VPNConfiguration.delete=*
Configuration Guide for Tiptel.com SIP Phones 31xx Page 25 / 252
Autoprovisioning / AutoUpload
3.3.2.13 Access Control File
Parameter —
[_AutoUpload] AccessControl
Web UI Phone/Ring → Upload ringtone Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg
Description Set the URL to upload an access control file
Format URL
Default Value
Range ini file format, same as configuration (including header)
Note optional
see Access Control File for further information
Example [_AutoUpload]
AccessControl=http://www.myServer.com/acctl.ini
3.3.2.13.1 Example
See chapter “Access control“ on page 27 for further information.
Configuration Guide for Tiptel.com SIP Phones 31xx Page 26 / 252
# *** version header for identification ***
[_Version] Type=inifile Version=1.00.000
# ** Webserver settings visible for all user ** # ** configuration requires admin or higher level **
[user/Webserver] HttpPort_perm=01 HttpsPort_perm=01 WebType_perm=01
# ** access to Service/Upgrade requires admin or higher level **
[acctl/WebPageAccess] service-upgrade_perm=1
Autoprovisioning / Access control
3.4 Access control
You can set the access level for configuration settings and certain web pages. We have 3 different access authorities:
for web, push xml and provisioning:
user: the user of the phone
admin: the administrator of the local installation, e.g. the network administrator
provider: the administrator of the SIP-PBX
for phone gui
phone: same as user
Note: Setting changes by phone are executed with the access authorization "phone", regardless of whether
they are password protected or not.
Access level can only be set within <model>.cfg and <mac>.cfg via Autoprovisioning
3.4.1 Set the access level
Access level can be set for visibility and write access.
The access level consists of one or two digits. The first digit stands for visibility and the optional second digit for write access. If only one digit is specified access level for visibility and write are set to the same value. Please note that settings with access level for write less than for visibility are ignored.
0..2[1..2] 1st digit: access level for visibility 2
nd
digit: access level for write access (optional).
The second digit sets the write access to a higher level than read
Each digit indicates the following:
0: all user 1: admin & provider only 2: provider only
3.4.2 Valid acces level values
item=0 – the item is configurable for all user item=1 – the item is configurable for admin & provider item=2 – the item is configurable for provider item=01 – the item is visible for all user and configurable for admin & provider item=02 – the item is visible for all user and configurable for provider item=12 – the item is visible for admin & provider and configurable for provider
Configuration Guide for Tiptel.com SIP Phones 31xx Page 27 / 252
Autoprovisioning / Access control
3.4.3 Set the access level for configuration items (V2.0 or later)
Access level can be set for visibility and write access. Setting the access level will take effect on the internal database, the web interface and the phone gui.
On web pages most configuration settings are stored in tables. On restricted visibility the complete line disappears or the item is disabled by javascript according to the access level. Please note that other parameters are also hidden when they are in the same line.
For most of the configuration use the same path as in the configuration file. Just append „_perm“ to the key name.
3.4.4 Examples:
A lwaysFWD
Parameter —
[user/AlwaysFWD] Target_perm
Web UI N/A Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg,
AccessControl.cfg
Version V2.0 or later
Description Set the access Level for CFU target
Format Enum
Default Value 0
Range 0..2[1..2]
1st digit: access level for visibility 2nd digit: access level for write access (optional)
0: all user 1: admin & provider 2: provider only
Note
Example [user/AlwaysFWD]
Target_perm=0 – parameter is configurable for all user
[user/AlwaysFWD] Target_perm=01 – parameter is configurable for admin &
provider, but visible for all user
Configuration Guide for Tiptel.com SIP Phones 31xx Page 28 / 252
Autoprovisioning / Access control
3.4.5 Set the access level forGUI Language
Parameter —
[user/Lang] Language_perm
Web UI N/A Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg,
AccessControl.cfg
Version V2.0 or later
Description Set the access Level for GUI Langage
Format Enum
Default Value 0
Range 0..2[1..2]
1st digit: access level for visibility 2nd digit: access level for write access (optional)
0: all user 1: admin & provider 2: provider only
Note
Example [user/Lang]
Language_perm=1 – parameter is configurable for admin &
provider
[user/Lang] Language_perm=12 – parameter is configurable for provider,
but visible for admin too
Configuration Guide for Tiptel.com SIP Phones 31xx Page 29 / 252
Autoprovisioning / Access control
3.4.6 Setting access level for SIP Codec Selection
In contrast to the entire configuration, we have a special key to provide access level for SIP codecs
Parameter —
[SIP/sipAccount#a/audioX] ChangeCodec_perm
#a account 0 .. 7
Web UI N/A Phone UI N/A Configuration Files <model>.cfg, <mac>.cfg,
AccessControl.cfg
#a account 1 .. 8
Version V2.0 or later
Description Set the access Level for Codec Selection
Format Enum
Default Value 0
Range 0..2[1..2]
1st digit: access level for visibility 2nd digit: access level for write access (optional)
0: all user 1: admin & provider 2: provider only
Note
Example [SIP/sipAccount0/audioX]
ChangeCodec_perm=02
Configuration Guide for Tiptel.com SIP Phones 31xx Page 30 / 252
Loading...
+ 222 hidden pages