Page 1 OpenStage / OpenScape Desk Phone IP  Provisioning Interface Developer’s Guide Please note that this Guide is protected for  Unify Software and Solutions GmbH & Co. KG. A31003-S2000-R102-16-7620 It is intended for use with HiPath,  OpenScape and Circuit Platforms only.
Page 2 Availability and technical specifications are subject to change without notice. Unify, OpenScape, OpenStage and HiPath are registered trademarks of Unify Software and Solutions GmbH & Co. KG. All other company, brand, product and service names are trademarks or registered trademarks of their respective holders.
Page 3: Table Of Contents
bkIVZ.fm Nur für den internen Gebrauch 1 Getting Started ............7 1.1 Overview .
Page 4 bkIVZ.fm Nur für den internen Gebrauch 3.7.1 Fragmentation of Phone Messages ........69 3.7.2 Fragmentation of Provisioning Service Messages .
Page 5 5.4.6 OpenStage 15 Key Module ........
Page 6 bkIVZ.fm Nur für den internen Gebrauch 5.4.7 Key click ............239 5.5 Locality .
Page 7: Getting Started
Getting Started Overview OpenStage SIP phones and OpenScape Desk Phones IP support the SIP protocol according to RFC 3261 and therefore can operate at any standard-compliant SIP server. Moreover, a multitude of interfaces for control, configuration, and provisioning is available: •...
Page 8: Prerequisites
Getting Started Nur für den internen Gebrauch Prerequisites Prerequisites For developing and operating a provisioning service for OpenStage phones, please ensure that you have the following prerequisites. OpenStage phone or OpenScape Desk Phone IP with appropriate firmware version. Infrastructure: •...
Page 9: Basic Network Infrastructure
1.3.1 Standard Network Structure All components are connected via LAN. The OpenStage IP phones and OpenScape Desk Phones IP receive their basic network configuration from the DHCP server and/or from LLDP- MED. This may include a VLAN ID, if a VLAN infrastructure is required. Further configuration is done via the provisioning service.
Page 10: Firewall And Nat
c01.fm Getting Started Nur für den internen Gebrauch Basic Network Infrastructure 1.3.2 Firewall and NAT If the phones and the provisioning service reside in different networks or subnets, which are separated by a firewall and/or NAT, it may be impossible for the provisioning service to establish a connection with the phones.
Page 11 c01.fm Getting Started Nur für den internen Gebrauch Basic Network Infrastructure Firewall XML messages over Periodic poll over HTTP HTTP/HTTPS Provisioning Service, possibly in combina- tion with a proxy A31003-S2000-R102-16-7620, 02/2016 Provisioning Service, Developer’s Guide...
Page 12: Network Communication
All further communication between the provisioning service and the phone consists of messag- es in XML format, which are transmitted using HTTP v1.1 over TLS (HTTPS). OpenStage phones and OpenScape Desk Phone IP expect the interface on port > 18443 to be TLS-encrypted (HTTPS). Therefore, the provisioning server needs to configure SSL/TLS on this listener port.
Page 13: Http Sessions
HTTP Sessions As some interactions may consist of several subsequent HTTPS request/response messages, it must be possible to establish HTTP sessions. For this purpose, OpenStage phones and OpenScape Desk Phone IP support HTTP cookies. To end a session, the provisioning server sends a special clean-up message to the phone. In some error cases, e.
Page 14: Http/Https Messages
c01.fm Getting Started Nur für den internen Gebrauch Network Communication 1.4.4 HTTP/HTTPS Messages Generally, two types of HTTP/HTTPS messages are used by the provisioning interface: XML messages for phone control and data exchange, and HTML messages for initiating an interac- tion by the provisioning service.
Page 15 c01.fm Getting Started Nur für den internen Gebrauch Network Communication Contact-me Message Example POST /contact_dls.html/ContactDLS HTTP/1.1 Content-type: application/x-www-form-urlencoded; charset=utf-8 User-Agent: Jakarta Commons-HttpClient/2.0final Host: 192.168.1.103:8088 Content-Length: 14 ContactMe=true Phone Response to Contact-me Example The phone sends a corresponding HTTP response. The HTTP status is 204 (no content). The HTTP Content-type is text/html.
Page 16: Dhcp
Basic Network Configuration DHCP The use of DHCP for network configuration is highly recommended. To enable an OpenStage phone or OpenScape Desk Phone IP to contact the provisioning service immediately on start- up, the appropriate contact address must be provided beforehand. This can be done by DHCP.
Page 17: Extended Configuration
The following description demonstrates by example how a ISC DHCP server can be configured in order to build up a working infrastructure for OpenStage phones or OpenScape Desk Phone The configuration example has been tested with ISC DHCP server version 3 running on Debian Linux (package: dhcp3-server).
Page 18 In the example, the vendor-classes class is divided into sub- classes automatically for each vendor-class-identifier option that is received from the clients. As OpenStage phones or OpenScape Desk Phone IP send the value OptiIpPhone, the specifications for these phones are defined in the corresponding sub-class.
Page 19 # Set up an option space to contain the vendor-encapsulated options option space OpenStage; option OpenStage.vendor code 1 = string; option OpenStage.vlanid code 2 = unsigned integer 32; option OpenStage.dls code 3 = string; # Each vendor-class-identifier will constitute a class class "vendor-classes"...
Page 20: Basic Communication Procedures
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Basic Message Flow Basic Communication Procedures This chapter describes the interaction between the phone and the provisioning server in detail. Depending on the situation and the intended task, the interaction will be started by the phone or by the provisioning service.
Page 21 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Basic Message Flow Phone Provisioning Service HTTPS Request Initial message, declaring the reason for contact, which is one of the follow- ing: – Startup (=registration with the provisioning service) – Configuration changes –...
Page 22: Provisioning Service Driven Interaction
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Basic Message Flow 3.1.2 Provisioning Service Driven Interaction 3.1.2.1 No Firewall A typical reason for contacting the phone is the modification of one or more configuration set- tings. The message flow might proceed as follows: In an initial HTTP request, the provisioning service sends a contact-me message to the phone.
Page 23 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Basic Message Flow Phone Provisioning Service HTTP Request Contact-me message (HTML) HTTP Response Acknowledged (HTML) HTTPS Request Basic data items HTTPS Response Provisioning service sends data items which shall be changed HTTPS Request Phone accepts the modifi- cation request...
Page 24 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Basic Message Flow 3.1.2.2 Provisioning Service Located Behind A Firewall When the provisioning service is located behind a firewall, or in a DMZ, it may have no possi- bility to send a contact-me message to the phone. To enable provisioning service driven inter- actions despite this limitation, the phone can be configured so that it periodically polls the pro- visioning service, or a special proxy, for new messages.
Page 25 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Basic Message Flow In this message flow, the phone polls the provisioning service or proxy, and the provisioning service resp. proxy has a new message for the phone: Phone Provisioning Service / proxy HTTP Request Polls the provisioning ser-...
Page 26: Configuration Data
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Configuration Data Configuration Data Configuration and control data is communicated in data items which act as containers for the parameters proper. Most of the simpler items are defined by the name attribute and the content of the element.
Page 27: Phone Message Structure
Phone Message Structure Examples <Item name="e164">49897223290</Item> - E.164 number of the phone <Item name="device-type">OpenStage 60</Item> - type of phone <Item index="1" name="ldap-server-address">ldap.mycompany.com</Item> - DNS name (or IP address) of the first LDAP server to be queried <Item name="reg-addr">192.168.1.117</Item> - IP address of the SIP server...
Page 28: Message Element
As it is part of a complex interaction between phone and provisioning service, it is recommended to establish an HTTP session by using cookies. If so, OpenStage phones will present a valid session-cookie along with this message. Further specifications can be given via the attributes action and status, and, if applicable, via fragment (see next table).
Page 29 If the list of items is fractioned, and the current mes- final sage contains the last fragment, this value is used. For examples, see Section 3.5.1.2, "XML Data Exchange" and Section 3.5.2.2, "XML Data Ex- change (up to OpenStage V2R1)". A31003-S2000-R102-16-7620, 02/2016 Provisioning Service, Developer’s Guide...
Page 30: Provisioning Service Message Structure
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Message Structure Provisioning Service Message Structure 3.4.1 Initiation Before issuing XML messages to the phone, the provisioning service must announce to the phone that it desires an interaction with it. For details, see Section 1.4.4.2, "Contact-me Messages".
Page 31 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Message Structure Content Value Description In complex interactions, this is the final message indicating the ter- CleanUp mination of the whole interaction cycle. It indicates to the phone that the TLS connection can be cleared. The HTTPS session will also be closed.
Page 32: Phone Driven Interactions
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Phone Driven Interactions Phone Driven Interactions Three different kinds of activities initiated by phones can be distinguished: Register with the provisioning service after startup, either initial startup, subsequent resets or a factory reset. Please ensure to provide the phone with the contact address of the provisioning >...
Page 33 At startup, the phone sends a set of data to the provisioning service. See the following ex- ample: <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message nonce="ab15234de14f15a667c6f8d"> <ReasonForContact>start-up</ReasonForContact> <ItemList> <Item name="device-type">OpenStage 60</Item> <Item name="related-device-type">OpenStage 60</Item> <Item name="software-type">Siemens SIP</Item> <Item name="related-software-type">Siemens SIP</Item> <Item name="contact-me-uri"> http://192.168.3.33:8085/contact_dls.html/ContactDLS </Item> <Item name="mac-addr">00:01:E3:00:A9:F3</Item> <Item name="configuration-changed-flag">false</Item>...
Page 34 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Phone Driven Interactions When the provisioning service has received the message from the phone, it sends an ap- propriate response, including the nonce value received by the phone, and a session cookie.
Page 35 </Message> </DLSMessage> 3.5.1.3 Items Sent On Startup and Configuration Change The following table describes the items typically sent by an OpenStage SIP phone or Open- Scape Desk Phone IP on startup, or when the configuration has changed: Item Name Values Description Phone variant.
Page 36 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Phone Driven Interactions Item Name Values Description Indicates whether any configuration pa- configuration- true rameter has been changed since the last changed-flag false data exchange between phone and provi- sioning service. If set to true, the provi- sioning service should update its data- base.
Page 37: Local Changes In Phone Configuration
Accordingly, the ReasonForContact is now set to local-changes. For OpenStage phones with firmware version V2R2 onwards, the message flow is simpler, as the phone includes the changed data in its first message.
Page 38 Nur für den internen Gebrauch Phone Driven Interactions 3.5.2.2 XML Data Exchange (up to OpenStage V2R1) The following example shows XML data sent from a phone to the provisioning service after a local configuration change. Note the value of configuration-changed-flag: <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"...
Page 39 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Phone Driven Interactions 3.5.2.3 Message Flow Phone Provisioning Service HTTPS Request Reason for contact: local-changes <Changed data items> HTTPS Response CleanUp A31003-S2000-R102-16-7620, 02/2016 Provisioning Service, Developer’s Guide...
Page 40 Nur für den internen Gebrauch Phone Driven Interactions 3.5.2.4 XML Data Exchange (OpenStage V2R2 onwards) The following example shows XML data sent from a phone with to the provisioning service after a local configuration change. Note the values of configuration-changed-flag, configuration-attached-flag, and configuration-attached-number: <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"...
Page 41: Provisioning Service Driven Interaction
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction Provisioning Service Driven Interaction To initiate an interaction with the phone, the provisioning service must send an HTML-based contact-me message to the phone’s contact-me URI. In turn the phone will send a response with solicited as a ReasonForContact.
Page 42: Read Phone Settings
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction </ItemList> </Message> </DLSMessage> 3.6.3 Read Phone Settings Besides the ReadAllItems option, it is also possible to request a particular set of data items from the phone. For this purpose, the provisioning service sends a message with Action set to ReadItems.
Page 43 Messages"). The phone sends basic configuration items. <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message nonce="2253A404241C11D774122654989181BC" maxItems="-1"> <ReasonForContact>solicited</ReasonForContact> <ItemList> <Item name="device-type">OpenStage 80</Item> <Item name="related-device-type">OpenStage 80</Item> <Item status="failed" name="gigabit-ethernet"></Item> <Item name="software-type">Siemens SIP</Item> <Item name="related-software-type">Siemens SIP</Item> <Item name="software-version">V1 R5.6.53</Item> <Item name="related-software-version">V1 R5.6.53</Item> <Item name="contact-me-uri"> http://192.168.233.195:8085/contact_dls.html/ContactDLS</Item>...
Page 44 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction The provisioning service sends a list of the desired data items. <DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message nonce="2253A404241C11D774122654989181BC"> <Action>ReadItems</Action> <ItemList> <Item name="device-type"/> <Item name="related-device-type"/> <Item name="software-type"/> <Item name="software-version"/> <Item name="contact-me-uri"/>...
Page 45 In the response, the phone returns the requested data items. <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message fragment="final" maxItems="-1" nonce="EB2C4CDF45D86E548CCD6F6612B26112"> <ReasonForContact status="accepted" action="ReadItems"> reply-to </ReasonForContact> <ItemList> <Item name="device-type">OpenStage 60</Item> <Item name="related-device-type">OpenStage 60</Item> <Item name="software-type">Siemens SIP</Item> <Item name="software-version">V1 R4.7.0</Item> <Item name="contact-me-uri">http://192.168.1.4:8085/ contact_dls.html/ContactDLS</Item> <Item name="mac-addr">00:01:E3:25:EA:13</Item> <Item name="e164">49897223290</Item> <Item name="ipaddress">192.168.1.4</Item> <Item name="reg-addr">192.168.1.117</Item>...
Page 46: Modify Phone Settings
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.4 Modify Phone Settings To modify settings on the phone, that is, to write data items to the phone, the provisioning ser- vice sends a message with Action set to WriteItems. The items in question are sent to the phone in a similar fashion as described for reading data items (see Section 3.6.3.2, "XML Data Exchange").
Page 47 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction Phone Provisioning Service HTTPS Response Action: WriteItems <data items to write> HTTPS Request Reason for contact: reply-to Status: Accepted HTTPS Response Action: ReadItems <data items to read (without val- ues)>...
Page 48 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.4.2 XML Data Exchange As steps 1-3 are described already in Section 3.6.3, "Read Phone Settings", only the subse- quent steps are demonstrated here. The provisioning service sends a list of the desired data items. <DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"...
Page 49 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction The provisioning service requests the data items to be modified in order to check whether they have been set correctly. <DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message nonce="0A8D39A3253E92715EFA5F5F63C25FFB"> <Action>ReadItems</Action> <ItemList>...
Page 50: Restart Phone
Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.5 Restart Phone OpenStage phones and OpenScape Desk Phones IP can be rebooted via the provisioning in- terface. 3.6.5.1 Message Flow Phone Provisioning Service HTTP Request Contact-me (HTML)
Page 51: Factory Reset
As this is a variant of the phone restart, the message flow is as described in Section 3.4.5, "Re- start Phone". Two additional parameters are needed to initiate a factory reset: • restart-password: For executing a factory reset, OpenStage phones and OpenScape Desk Phone IP require a special password, whatever interface is used. The value is 124816. •...
Page 52: File Provisioning
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.7 File Provisioning The provisioning interface allows for deploying all kinds of files supported by the phone in ques- tion, such as ringtones, music on hold, or LDAP templates. While the provisioning service initiates the transfer of files to the phone, the phone obtains the data from an FTP server or an HTTPS server.
Page 53 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.7.2 XML Data Exchange For Single File Deployment As the other elements of the message flow are already described in Section 3.6.3, "Read Phone Settings", only the relevant sections (step 4 and 5) are illustrated by an example. In the following example, the phone is provided with a new ringtone, which is available as .wav file.
Page 54 The response from the phone may look like the following: <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message maxItems="-1" nonce="4F6A1034A46B463F8D008DA09314040A"> <ReasonForContact>status</ReasonForContact> <ItemList> <Item name="device-type">OpenStage 60</Item> <Item name="related-device-type">OpenStage 60</Item> <Item status="failed" name="gigabit-ethernet"/> <Item name="software-type">Siemens SIP</Item> <Item name="related-software-type">Siemens SIP</Item> <Item name="software-version">V1 R4.9.0</Item> <Item name="related-software-version">V1 R4.9.0</Item> <Item name="contact-me-uri">...
Page 55 <Message nonce="E5BFC5E2FBCE6CD3D20DC9AD975C0355"> <Action>FileDeployment</Action> <ItemList> <Item name="file-server" index="1">192.168.1.150</Item> <Item name="file-path" index="1">/media/</Item> <Item name="file-name" index="1"> Logo for OpenStage 80.png </Item> <Item name="file-type" index="1">LOGO</Item> <Item name="file-pwd" index="1">dlsftp5</Item> <Item name="file-port" index="1">21</Item> <Item name="file-username" index="1">dls</Item> <Item name="file-action" index="1">deploy</Item> <Item name="file-server" index="2">192.168.1.150</Item> <Item name="file-path" index="2">/media/</Item>...
Page 56: Firmware Deployment
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.8 Firmware Deployment The deployment of firmware for the phone is very similar to the regular file deployment, as de- scribed in Section 3.6.7, "File Provisioning". The type of Action is different, the item is named file-sw-type is used instead of file-type, and the items file-sw-version and file- priority are added.
Page 57 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.8.2 XML Data Exchange As the other elements of the message flow are already described in Section 3.6.3, "Read Phone Settings", only the relevant section (step 4) is illustrated by an example. In the example, FTP is used;...
Page 58: Certificate Deployment
Provisioning Service Driven Interaction 3.6.9 Certificate Deployment To enable secure connections and data transmission, OpenStage phones and OpenScape Desk Phone IP need appropriate certificates. These can be deployed using the provisioning service. Certificates can be used for the following functional areas: •...
Page 59 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.9.1 Message Flow Phone Provisioning Service HTTP Request Contact-me (HTML) HTTP Response Acknowledged (HTML) HTTPS Request: Reason for contact: solicited <Basic data items> HTTPS Response: Action: WriteItems <Certificate>...
Page 60 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.9.2 XML Data Exchange The following example shows the deployment of a WBM server certificate, which is needed for secure communication between the phone’s web server and a web browser. As steps 1 to 3 are already described in Section 3.6.3, "Read Phone Settings", only the specific steps are shown.
Page 61 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction The phone sends the certificate it has extracted from the PKCS#12 data, without the pri- vate key and the optional CA certificate. <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Message nonce="C9E1C9A2BAA1644559FF110C7299BBC6" maxItems="-1" fragment="final">...
Page 62: Secure Mode And Bootstrapping
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.10 Secure Mode and Bootstrapping Workpoint Interface supports Secure Mode, where mutual authentication based on individual digital signatures takes place. The mode without mutual authentication is called Default Mode. Bootstrapping means the interface security between device and provisioning service is raised from Default Mode to Secure Mode.
Page 63 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.10.1 Message Flow: Secure Mode, No PIN The preconditions are: – Device is not registered, but configured in provisioning service as Secure Mode with no PIN required Phone Provisioning Service HTTP Request...
Page 64 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.10.2 XML Data Exchange: Secure Mode, No PIN As step 1 start-up is described already in Section 3.5.1.2, "XML Data Exchange", only the subsequent steps are demonstrated here. As the device is configured to Secure Mode without PIN, the provisioning service sends a request to switch to Secure Mode (bootstrapping) including certificates and secure-port number.
Page 65 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction Individual client certificate and provisioning server CA certificate(s) have been stored, all further requests from this device perform mutual authentication on port 18444. When bootstrapping process has finished with success, requests from device via Default Mode port (18443) are blocked now.
Page 66 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction Phone Provisioning Service HTTPS Request (to dls-secure- port) Reason for contact: reply-to <item including bootstrapping- tan> HTTPS Response Action: ReadAllItems HTTPS Request (to dls-secure- port) Reason for contact: reply-to <all items>...
Page 67 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction 3.6.10.4 XML Data Exchange: Secure Mode, With PIN As step 1 start-up is described already in Section 3.5.1.2, "XML Data Exchange", only the subsequent steps are demonstrated here. As the device is configured to Secure Mode with PIN, the provisioning service sends a re- quest to switch to Secure Mode (bootstrapping) including all items needed packed, en- crypted and Base64-encoded into the single data item ’secure-mode-data’.
Page 68 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Provisioning Service Driven Interaction With the next contact of device, the provisioning service verifies the client certificate and because of the PIN a readItems for getting the bootstrapping TAN is sent to the device. <DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS"...
Page 69: Message Fragmentation
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Message Fragmentation Message Fragmentation Messages are limited to a length of 50 kB. Larger messages will be split into fragments. On the phone side, the threshold is defined by the maxItems attribute of the Message element. When the number of data items to be contained in a message exceeds the number given here, or the message reaches the 50 kB limit, the message is split up.
Page 70 <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message maxItems="-1" nonce="B0151B36FE9CEEA0F667FF3A208AC994" fragment="next"> <ReasonForContact action="ReadItems" status="accepted"> reply-to </ReasonForContact> <ItemList> <Item name="device-type">OpenStage 60</Item> <Item name="related-device-type">OpenStage 60</Item> </ItemList> </Message> </WorkpointMessage> The provisioning service requests the next fraction of data from the phone. <DLSMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message nonce="B0151B36FE9CEEA0F667FF3A208AC994">...
Page 71: Fragmentation Of Provisioning Service Messages
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Message Fragmentation 3.7.2 Fragmentation of Provisioning Service Messages 3.7.2.1 Message Flow In the following message flow example, the provisioning service sends data which is divided up in 2 fractions. Please note that this is not a full interaction, but only the relevant section of an interaction driven by the provisioning service.
Page 72: Contact-Me During Busy State
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Message Fragmentation 3.7.3 Contact-Me during Busy State 3.7.3.1 Message Flow When the phone is asked by the provisioning service to write a data item whilst the phone is busy in a call, the phone rejects the WriteItems with a ’Busy’ status response but supports the use of the 'send-solicited' item in the CleanUp message to reconnect automatically to the pro- visioning service when the call ends.
Page 73 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Message Fragmentation Phone Provisioning Service HTTPS Request: Reason for contact: solicited <Basic data items> HTTPS Response Action: WriteItems <data items to write> HTTPS Request Reason for contact: reply-to Status: Busy HTTPS Response CleanUp Item: send-solicited Time passes.
Page 74 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Message Fragmentation Phone Provisioning Service HTTPS Request 1: Reason for contact: solicited <Basic data items> HTTPS Response 1 Action: WriteItems <data items to write> HTTPS Request 1 Reason for contact: reply-to Status: Busy HTTPS Response 1 CleanUp...
Page 75 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Message Fragmentation Phone Provisioning Service HTTPS Response 3 CleaUp Item: send-solicited Time passes. Phone switches from ’busy’ to ’idle’-state. HTTPS Request: Reason for contact: solicited <Basic data items> HTTPS Response 1 Action: WriteItems <data items to write>...
Page 76 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Message Fragmentation 3.7.3.2 XML Data Exchange For details, see Section 3.6.4, "Modify Phone Settings". 1. The phone sends a response with ’busy’ state. <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-instance"> <Message nonce="957AE6C2E40C0E916B7CD5636480F171" maxItems="-1" fragment="final">...
Page 77: Error Handling
The phone initiates a connection to the provisioning service. <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message nonce="104EBC8C863E0C5CA384D4D924C4B220" maxItems="-1"> <ReasonForContact>solicited</ReasonForContact> <ItemList> <Item name="device-type">OpenStage 80</Item> <Item name="related-device-type">OpenStage 80</Item> <Item status="failed" name="gigabit-ethernet"></Item> <Item name="software-type">Siemens SIP</Item> <Item name="related-software-type">Siemens SIP</Item> <Item name="software-version">V1 R5.6.53</Item> <Item name="related-software-version">V1 R5.6.53</Item> <Item name="contact-me-uri">...
Page 78 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Error Handling The provisioning service attempts to write an item that is unknown at the phone. <DLSMessage xmlns="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.siemens.com/DLS"> <Message nonce="7FAA6353A4887BBFA14B78370FE99144"> <Action>WriteItems</Action> <ItemList> <Item name="socketed-headset-mode">0</Item> </ItemList> </Message> </DLSMessage> The phone responds with the status item indicating the unknown item. <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS"...
Page 79: Example 2: Configuration Items Failed To Be Set At Phone
The phone initiates a connection to the provisioning service. <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message nonce="104EBC8C863E0C5CA384D4D924C4B220" maxItems="-1"> <ReasonForContact>solicited</ReasonForContact> <ItemList> <Item name="device-type">OpenStage 80</Item> <Item name="related-device-type">OpenStage 80</Item> <Item status="failed" name="gigabit-ethernet"></Item> <Item name="software-type">Siemens SIP</Item> <Item name="related-software-type">Siemens SIP</Item> <Item name="software-version">V1 R5.6.53</Item> <Item name="related-software-version">V1 R5.6.53</Item> <Item name="contact-me-uri">http://192.168.233.195:8085/ contact_dls.html/ContactDLS</Item>...
Page 80 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Error Handling The provisioning service attempts to write several settings. <DLSMessage xmlns="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.siemens.com/DLS"> <Message nonce="104EBC8C863E0C5CA384D4D924C4B220"> <Action>WriteItems</Action> <ItemList> <Item name="Canonical-dialing-international-prefix">0 </Item> <Item name="Canonical-dialing-operator-code">0</Item> <Item name="Canonical-dialing-emergency-number">999,555</Item> <Item name="Canonical-dialing-local-country-code">44 </Item> <Item name="Canonical-dialing-extension-initial-digits">1</Item> <Item name="Canonical-dialing-external-access">9</Item> <Item name="Canonical-dialing-local-node">943</Item>...
Page 81 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Error Handling name="Canonical-lookup-international-code">+44561</Item> <Item index="6" name="Canonical-lookup-local-code">561 </Item> </ItemList> </Message> </DLSMessage> The phone responds with item status "failed" for any items it could not save. <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message nonce="BFBD54B05B45E13F9E7E773F65CE3956" maxItems="-1" fragment="final">...
Page 82: Example 3: Item Is Read Only
The phone initiates a connection to the provisioning service. <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message nonce="71E7F7FF699CE4467956071307E7478F" maxItems="-1"> <ReasonForContact>solicited</ReasonForContact> <ItemList> <Item name="device-type">OpenStage 80</Item> <Item name="related-device-type">OpenStage 80</Item> <Item status="failed" name="gigabit-ethernet"></Item> <Item name="software-type">Siemens SIP</Item> <Item name="related-software-type">Siemens SIP</Item> <Item name="software-version">V1 R5.6.53</Item> <Item name="related-software-version">V1 R5.6.53</Item> <Item name="contact-me-uri">...
Page 83: Example 4: Pin Entry Exceeds Max. Retries
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Error Handling The phone responds with item status "read-only". <WorkpointMessage xsi:schemaLocation="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.siemens.com/DLS"> <Message nonce="930873879B353894AAB792E175847F39" maxItems="-1" fragment="final"> <ReasonForContact status="accepted" action="WriteItems"> reply-to</ReasonForContact> <ItemList> <Item status="read only" name="device-type"></Item> </ItemList> </Message> </WorkpointMessage> Provisioning service terminates interaction with a CleanUp. <DLSMessage xmlns="http://www.siemens.com/DLS"...
Page 84 c03.fm Basic Communication Procedures Nur für den internen Gebrauch Error Handling Provisioning service terminates interaction with a CleanUp. The session is not aborted by the phones CleanUp message; this is done by the CleanUp message from the provisioning service. <DLSMessage xmlns="http://www.siemens.com/DLS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"...
Page 85: Tracing And Debugging
c03.fm Basic Communication Procedures Nur für den internen Gebrauch Tracing and Debugging Tracing and Debugging Besides the error handling capabilities described above, the phone provides detailed tracing information about the communication between phone and provisioning service. To enable this functionality via the WBM, proceed as follows: •...
Page 86: Phone Parameters - Administration
Section 6, "Phone Parameters - Provisioning". If not otherwise stated, the Items are available on all phone variants, that is, OpenStage 15/20/ 40/60/80 and OpenScape Desk Phone IP 35/55G.
Page 87 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Applications To determine what to do with an application, that is, create, modify, or delete it, the XML-app- action item is used. For each indexed application, an individual action can be defined. As the creation of an application is treated as a modification/update, two values are possible, delete and update.
Page 88 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Applications 4.1.1.1 Add application For regular (not Xpressions, not XMLPhonebook) applications, the XML-app-special-instance item must be set to 0 (see Section 4.1.1, "XML applications"). The XML-app-control-key is mandatory when using the WPI. WBM Name Item name Type...
Page 89 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Applications WBM Name Item name Type Values Description Auto start Boolean Determines whether the XML-app- true/false Default: false application is automati- auto-start cally started in the back- <index> ground or only when first selected.
Page 90 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Applications WBM Name Item name Type Values Description Tab 1 Display Text. Default: NULL Name to be displayed on XML-app- Name Max. 20 the first internal tab. tab1- charac- display- ters.
Page 91 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Applications WBM Name Item name Type Values Description Enumer- 0=no mode key; Specifies which mode key XML-app- ation 1=CallView mode starts the application. The control-key key (not support following mode keys can <index>...
Page 92 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Applications 4.1.1.2 Modify Application Regarding the provisioning interface, the modification of an application is the same procedure as the creation. The XML-app-action item must be set to update, as in the following snip- pet: <Item name="XML-app-action"...
Page 93: Bluetooth
Enables or disables the enable- true/false interface Default: true Bluetooth interface. Read bluetooth- only if locked by provi- interface sioning service. Available for OpenStage 60/80. Network 4.3.1 General IP configuration WBM Name Item name Type Values Description Protocol Mode Enumer-...
Page 94 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Network WBM Name Item name Type Values Description VLAN ID Integer 0 to 4095 VLAN ID for the phone. vlan-id Default: NULL Only writable when not al- ready defined by DHCP. DNS domain Text Text...
Page 95: Ipv4 Configuration
ARP requests in 5 second intervals. Addi- tionally, it will send dis- covery messages periodi- cally to obtain a new DHCP lease. Available with OpenStage V2R1. IP address IP address IP address for the phone. ipaddress address...
Page 96: Ipv6 Configuration (V3)
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Network WBM Name Item name Type Values Description Route 1 mask Subnet Subnet mask Subnet mask for specific mask1 mask Default: NULL route 1. Route 2 IP ad- IP address Specific route 2.
Page 97: Update Service
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Network WBM Name Item name Type Values Description Route 1 Dest. IP address Destination IPv6 address ipv6-route1- address Default: NULL for the first static route. destination Route 1 Prefix Integer 0 to 128 Prefix length for the first ipv6-route1-...
Page 98 Contact gap Integer Default: 300 Minimum time interval in dls-contact- seconds that must elapse interval between responses to contact-me requests. Not supported on OpenStage phones. Revert to default Boolean Enable or disable default goto-de- true/false security Default: false security. fault-mode...
Page 99 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Network Detailed Description of Mode Value Description 0 = Default The phone uses HTTPS with a built-in default certificate for connections to the provisioning service 1 = Secure Phone uses HTTPS with a non-PIN protected certificate downloaded during no PIN bootstrap for connections to provisioning service but a PIN was not required for bootstrap and thus the TAN is null...
Page 100 By setting this parameter to true, the phone indicates that the current item list contains the changed configura- tion parameters. Supported with OpenStage V2R2. Integer Sequential number which is in- configuration- creased with every startup mes- changed-number sage or configuration change message from the phone.
Page 101 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Network Item name Type Values Description String Provisioning service provides secure-mode- phones with encrypted data re- data quired for Secure Mode (boot- strapping = PIN). Integer Portnumber Portnumber to reach provisioning dls-secure- Default: 18444 service in Secure Mode (boot-...
Page 102: Qos
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Network 4.3.5 With firmware version V3, MLPP capabilities has been added; however, the associ- > ated parameters are not relevant for this document. WBM Name Item name Type Values Description Layer 2 Boolean Enable or disable QoS...
Page 103: Port Configuration
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Network WBM Name Item name Type Values Description Layer 3 signalling l3qos- Enumer- Sets the layer 3 CoS 0=BE; ation (Class of Service) value signalling 10=AF11; for signaling. 12=AF12; 14=AF13; 18=AF21;...
Page 104 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Network WBM Name Item name Type Values Description Backup proxy Integer Port number Port of the backup proxy backup-port Default: 5060 server. RTP base Integer Port number Base port number used rtp-base- Default: 5010 for negotiating the RTP...
Page 105 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Network WBM Name Item name Type Values Description LAN port speed Enumer- Speed of the ethernet port port1 0=Automatic; ation 1=10 Mbit/s Half connected to the LAN Duplex; switch. 2=10Mbit/s Full Duplex;...
Page 106: Lldp-Med Operation
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Network 4.3.7 LLDP-MED Operation WBM Name Item name Type Values Description Time to live (sec- Enumer- 40 / 60 / 80 / In order to keep the lldp- onds) ation 100 / 110 / 120 / stored LLDP information timetolive...
Page 107: System
Default: false Display identity. Web name Text Default: Based Default DNS hostname hostname on phone type for the phone. and MAC ad- Available with OpenStage dress DNS name con- Enumer- 0=no DDNS host- Determines how the DNS automatic- struction ation name;...
Page 108: Sip Interface
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System 4.4.2 SIP interface WBM Name Item name Type Values Description Outbound Boolean true / false If true, the SIP server will outbound- proxy Default: false resolve the domain in the proxy-user SIP request.
Page 109 SIP server and advertise ANAT support in the SIP header. When set to "Sin- gle IP", ANAT support is disabled. Available with OpenStage Media IP Mode sip-media-IP- 0="IPv4"; Defines which IP version 1="IPv6"; is to be used for voice mode 2="IPv4_IPv6";...
Page 110: Registration
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System 4.4.3 Registration WBM Name Item name Type Values Description SIP server IP ad- IP address or IP address or host name reg-addr address dress or hostname. of the SIP proxy server. host- Default: NULL name.
Page 111 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Server type Enumer- Type of server the phone server-type 0=Other; ation will register to, or is regis- 1=OpenScape Voice; tered at. Default: 0 Realm Default: NULL Protection domain for au-...
Page 112: Snmp
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System 4.4.4 SNMP WBM Name Item name Type Values Description Trap sending Boolean Enables or disables the snmp-traps- true/false enabled Default: false sending of a TRAP mes- active sage to the SNMP manager.
Page 113 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Diagnostic desti- IP ad- IP address or IP address or hostname diagnostic- nation dress or hostname. of the SNMP manager re- trap-addr host- Default: NULL ceiving diagnostic...
Page 114: Features
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System 4.4.5 Features 4.4.5.1 Configuration WBM Name Item name Type Values Description Emergency num- Text Default: NULL If the phone is locked, a emergency-e164 clickable area for making an emergency call is cre- ated.
Page 115 Hot/warm destination is line dialed immediately (hot 3=Warm phone phone) or after a configurable delay (warm phone) when the user goes off-hook. Available with OpenStage Hot/warm desti- Text Call number. Number to be dialed hot-line-warm- nation when Hot phone or Warm line-digits phone is enabled.
Page 116 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Server features Boolean Must be set to true for server-based- true/false Default: using server based Call features Forwarding. When phone false based DND and phone based call forwarding are to be used, it must be set to false.
Page 117 If set to 2 (=ON) and an FPK is pressed for 2 sec- onds, it enters program- ming mode. Other values are not ac- tive and reserved for fu- ture use. Relevant for OpenStage 15/40/60/80. Available with OpenStage V2R2. Group pickup Boolean If enabled, an acoustic...
Page 118 No call will be recorded, call-record- false mode="Disabled" and the corresponding auto-start FPK function (Section Boolean call-record- false 4.4.5.3, "Call recording") all-calls is disabled. Available with OpenStage Boolean feature- false V2R2. availability index="24" Recording Boolean Call recording can be call-record- false mode="Manual"...
Page 119 "All calls" lished, and can not be Boolean call-record- true stopped with the FPK all-calls function. Boolean feature- true Available with OpenStage availability V2R2. index="24" Audible Notifica- Boolean The user will not notice call-record- false tion="Off" that a call is being audible- recorded.
Page 120 In the provisioning interface, this number is stored as content of the function-key-def element. The key number is stored in the index attribute, starting from 1 for the first key. The possible key numbers depend on the OpenStage model: •...
Page 121 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System Selected dialing A predefined call number is dialed on key press. WBM Name Item name Type Values Description Key label <n> Unicode Unicode text Label for the key. key-label- text.
Page 122 <index> Mute (OpenStage 15 only) On pressing this key, the microphone is turned off. This programmable key function is available only for OpenStage 15 phones, which have no fixed mute key. A31003-S2000-R102-16-7620 02/2016 Provisioning Service, Developer’s Guide...
Page 123 <index> Release (OpenStage 15 only) On pressing this key, the current call is disconnected. This programmable key function is avail- able only for OpenStage 15 phones, which have no fixed release key. WBM Name Item name Type Values Description Key label <n>...
Page 124 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System Hold The call currently active is put on hold. WBM Name Item name Type Values Description Key label <n> Unicode Default: Hold Label for the key. key-label- text. unicode Max.
Page 125 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System Move blind / Blind transfer A call is transferred without consultation, as soon as the phone goes on-hook or the target phone goes off-hook. WBM Name Item name Type Values Description Key label <n>...
Page 126 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System Deflect On key press, an incoming call is deflected to the specified destination. WBM Name Item name Type Values Description Key label <n> Unicode Default: Label for the key. key-label- text.
Page 127 Conference Max.12 <index> charac- ters. Integer Feature ID which defines function- the function. key-def <index> Headset (OpenStage 40/60/80) Accept an incoming call via headset. WBM Name Item name Type Values Description Key label <n> Unicode Default: Label for the key.
Page 128 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System Do Not Disturb If this feature is activated, incoming calls will not be indicated to the user. WBM Name Item name Type Values Description Key label <n> Unicode Default: DND Label for the key.
Page 129 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System Cancel callbacks With this this function, the user can cancel all callback requests on the server.. WBM Name Item name Type Values Description Key label <n> Unicode Default: Cancel Label for the key.
Page 130 That is, a line can be registered and handled only by one single phone at a given time. For further information, please refer to http://wiki.unify.com/images/a/a3/White_Paper_MAA.pdf The following parameters can be configured individually for each line handled by the phone WBM Name...
Page 131 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Ring on/off Boolean When set to true, line-ring true/false Default: true the line will ring on <index> an incoming call, and a popup will ap- pear on the display.
Page 132 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description User Identifier Text Default: NULL User id for authenti- line-sip- cated access to the user-id SIP server. Password Text Default: NULL Password for au- line-sip-pwd thenticated access to the SIP server.
Page 133 Text line-mlo-pos sition Inter-line notifica- Boolean line-int- true/false tion allowed Default: allow Show phone screen (OpenStage 15 and OpenStage 40 only) Switches back to call view. WBM Name Item name Type Values Description Key label <n> Unicode Default: Show Label for the key.
Page 134 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System Call waiting toggle Enables or disables the Call waiting feature. If enabled, calls from a third party are allowed during an active call. WBM Name Item name Type Values Description Key label <n>...
Page 135 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System Line preview Enables the preview mode, which allows the user to preview a line before using it. Relevant for OpenScape Voice only. WBM Name Item name Type Values Description Key label <n>...
Page 136 Moreover, additional signalling infor- mation from OpenScape Voice is not required. To indicate a new call to the user, a zip tone is played through the headset when the call is ac- cepted. Available for OpenStage 40/60/80. WBM Name Item name Type...
Page 137 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description DTMF digits String Default: NULL This code will be sent to stimulus- the SIP server as a DTMF DTMF- signal. As a precondition, sequence an audio path which is <index>...
Page 138 Offers the possibility to monitor another phone, and to pick up calls for the monitored phone. For the pickup function (OpenStage V2R1 onwards), the appropriate code must be provided (see blf-code in Section 4.4.5.8, "Addressing (V3) / Services (up to V2R2)").
Page 139 This function is available with firmware version V2. > With OpenStage V2R2, push support is available. If activated, the LED is controllable by a com- bination of an HTTP push request and an XML document. For further information, see the XML Applications Developer’s Guide.
Page 140 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Key label <n> Text Default: Lo- Label for the key. key-label- unicode cal appli- <index> cation Integer Feature ID which defines function-key- the function.
Page 141 Default: controllable by a combi- support nation of an HTTP push <index> false request and an XML doc- ument. For further infor- mation, see the XML Ap- plications Developer’s Guide. Available with OpenStage V2R2. A31003-S2000-R102-16-7620, 02/2016 Provisioning Service, Developer’s Guide...
Page 142 <index> key. This value must be unique for all keys in- volved. Available with OpenStage V2R2. Built-in forwarding Toggles phone-based call forwarding. To enable phone-based call forwarding, the server-based-features item must be set > to false; for further information, please see the parameter description in Section 4.4.5.1, "Configuration".
Page 143 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System 2nd alert (V3) This function allows monitoring and accepting a second incoming call. When a call is ringing while the user is dialing, the LED will light up. As soon as the user presses the key, information about the incoming call is presented, and the user can accept the call.
Page 144 Phone Parameters - Administration Nur für den internen Gebrauch System Personal Directory This key function opens a menu which enables the user to start the local phonebook. (Prior Start Phonebook OpenStage 40 only) WBM Name Item name Type Values Description Key label <n>...
Page 145 Integer Feature ID which defines function- the function. key-def <index> Video call (V3R3) This key function allows activating video calls. Available only on OpenStage 60/80 and Open- Scape DP IP 55G. WBM Name Item name Type Values Description Key label <n>...
Page 146 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System Corporate Directory (V3R3) This key function allows activating corporate directory. WBM Name Item name Type Values Description Key label <n> Unicode Default: Corpo- Label for the key. key-label- text. unicode rate Max.
Page 147 "unspecified", built-in forwarding will be disabled. • Built-in forwarding WBM Name Item name Type Value Description Built-in forward- Integer Feature ID which defines function-key- the function. Available with OpenStage index="4002" V2R0 onwards. A31003-S2000-R102-16-7620, 02/2016 Provisioning Service, Developer’s Guide...
Page 148 The phone’s built-in forwarding is not dis- abled. Available with OpenStage V2R0 onwards. For the function specific parameters, please refer to Section 4.4.5.3, "Server feature". A31003-S2000-R102-16-7620 02/2016 Provisioning Service, Developer’s Guide...
Page 149 Integer Feature ID which defines function-key- the function. Available with OpenStage index="4002" V2R0 onwards. If this function is assigned to the key, key-functionality determines the key’s behaviour; please refer to Section 4.4.5.4, "Key functionality". For the function specific parameters, please refer to Section 4.4.5.3, "Server feature".
Page 150 Phone Parameters - Administration Nur für den internen Gebrauch System For a description, please refer to Section 4.4.5.3, "Show phone screen (OpenStage 15 and OpenStage 40 only)". • Hold WBM Name Item name Type Values Description Hold Integer Feature ID which defines function-key- the function.
Page 151 • Built-in release WBM Name Item name Type Values Description Built-in release Integer Feature ID which defines function-key- the function. Available with OpenStage index="4001" V2R0 onwards. • Server feature WBM Name Item name Type Values Description Server feature Integer Feature ID which defines function-key- the function.
Page 152 Integer Feature ID which defines function-key- screen the function. Available with OpenStage index="4001" V2R2 onwards. For a description, please refer to Section 4.4.5.3, "Show phone screen (OpenStage 15 and OpenStage 40 only)". • Consultation WBM Name Item name Type Values...
Page 153 Phone Parameters - Administration Nur für den internen Gebrauch System Voice Dial / Voice Recognition Key (OpenStage 60/80) • Server feature WBM Name Item name Type Values Description Server feature Integer Feature ID which defines function-key- the function. Available with OpenStage index="4003"...
Page 154 WBM Name Item name Type Values Description Consultation Integer Feature ID which defines function-key- the function. Available with OpenStage index="4003" V2R2 onwards. For a description, please refer to Section 4.4.5.3, "Consultation". • Conference WBM Name Item name Type Values Description...
Page 155 Show phone Integer Feature ID which defines function-key- screen the function. Available with OpenStage index="4009" V2R2 onwards. For a description, please refer to Section 4.4.5.3, "Show phone screen (OpenStage 15 and OpenStage 40 only)". A31003-S2000-R102-16-7620, 02/2016 Provisioning Service, Developer’s Guide...
Page 156 Item name Type Values Description Consult and Integer Feature ID which defines function-key- transfer the function. Available with OpenStage index="4009" V2R2 onwards. For a description, please refer to Section 4.4.5.3, "Consultation". • Conference WBM Name Item name Type Values Description...
Page 157 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System Forwarding Key (OpenScape Desk Phone IP 55G) • Forwarding WBM Name Item name Type Values Description Forwarding Integer Feature ID which defines function-key- the function. index="4010" A31003-S2000-R102-16-7620, 02/2016 Provisioning Service, Developer’s Guide...
Page 158 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System 4.4.5.5 Key Module 1 The settings are the same as those for programmable keys on the phone (see Section 4.4.5.3, "Free Programmable Keys (FPK)"). 4.4.5.6 Key Module 2 The settings are the same as those for programmable keys on the phone (see Section 4.4.5.3, "Free Programmable Keys (FPK)").
Page 159 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System 4.4.5.7 Keyset operation WBM Name Item name Type Values Description Rollover ring Enumer- 0=no ring; Determines how an in- line-rollover- ation 1=alert ring; coming call on a different type line is indicated during an 2=standard ring;...
Page 160 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Terminating line Enumer- Decides which terminat- terminating- 0="ringing preference ation line" ing line, i. e. line with an line- incoming call, is selected preference 1="ringing PLP"...
Page 161 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Line action mode line-key- Enumer- Determines the conse- 0="hold" ation quence for an established operating-mode 1="release" Default: 0 connection when the line key is pressed.
Page 162 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Preselect mode Enumer- 0=single but- Determines the phone’s line-button- ation behaviour when a call is mode 1=preselection active, and another call is Default: 0 ringing.
Page 163 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Preview timer Integer Relevant for OpenScape preview-timer 2/ 3/ 4/ 6/ 8/ Voice only. 10/ 15/ 20/ 30/ Determines the timespan 40/ 50/ 60 Default: 8 in seconds during which the line preview will re-...
Page 164 BLF pickup code blf-code Text Default: NULL Code sent to the SIP server for BLF call pickup. Available with OpenStage V2R1 onwards. 4.4.5.9 Call completion (V3) WBM Name Item name Type Values Description...
Page 165 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Allow after call Enumer- Specifies how long (in ccss-retain- 0=1; (seconds) ation seconds) to retain server time 1=2; provided information re- 2=3; quired to request a call 3=4;...
Page 166 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Callback Boolean Enables or disables the callback-busy- true/false Default: true possibility to request a allow callback. Call pickup Boolean Enables or disables the feature- true/false Default: true...
Page 167 (Computer Telephony In- availability terface). <index=32> Bluetooth Boolean Enables or disables Blue- enable- true/false Default: true tooth. bluetooth- Available for OpenStage interface 60/80. Web based Boolean Enables or disables the enable-WBM true/false mang. Default: true WBM (Web Based Man- agement).
Page 168: Security
With software version OpenStage V2R2 onwards, the authentication policy for file transfer (see Section 4.5, "File Transfer") via HTTPS and for the "Send URL" function (see Section 4.4.5.3, "Send URL") can be configured. When "None" is selected, no certificate check is performed.
Page 169 0=None; transfer ation level for the HTTPS authentication 1=Trusted; server to be used for file -policy 2=Full transfer. Available with OpenStage V2R2. Secure send URL send-url- Enumer- Sets the authentication 0=None; ation level for the HTTPS authentication 1=Trusted; server to be used for the...
Page 170 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System 4.4.6.3 SDES Config (V3) Some configurations described in the following table require specific combinations > of configuration items, indices, and values. In cases where one configuration can easily be derived from a similar configuration, like "SHA1-32 disabled, SHA1-80 en- abled"...
Page 171 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description SHA1-80 ranking Boolean SHA1-32 is enabled for srtp- true = disabled; SRTP encryption. encryption- SHA1-32 ranking allowed = enabled <index=1> Boolean SHA1-80 is disabled for srtp- false SRTP encryption.
Page 172 0=Disable; ation access for the CCE 3=Enable; (CommsChannel Extend- er). This affects the oper- ation of the OpenStage Manager, local CTI ac- cess, and HPT access. When "Disable all" is se- lected, both TCP and UDP are disabled. With "Enable all", there are no restrictions.
Page 173 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Serial port Enumer- 0=Password re- When "Passwd required" serial-port- ation quired; (=interactive_login) is se- mode 1=No Password; lected, the serial port re- quires a password for ac- 2=Unavailable Default: 1...
Page 174 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System WBM Name Item name Type Values Description Archive when at Enumer- 0=send immedi- Automatic archiving of slog- ation new security log entries archive-on- will occur when the per- percentage 1=10%;...
Page 175 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch System 4.4.6.6 Faults (V3) This function is not available with WPI. > A31003-S2000-R102-16-7620, 02/2016 Provisioning Service, Developer’s Guide...
Page 176: File Transfer
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch File Transfer File Transfer Due to the organization of the file transfer parameters in the provisioning interface, the presen- tation will differ from the other sections. However, the WBM names which correspond to the pa- rameters will be retained in order to make them more findable.
Page 177: File Provisioning Data
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch File Transfer WBM Name Item name Type Values Description Filename Text Default: NULL Name of the file to be de- file-name ployed. 4.5.2 File Provisioning Data Item name Type Values Description Text See Section 4.5.3,...
Page 178: Specifications For Media Files And Ldap Templates
JPEG/.jpg (OpenStage Custom background image LOGO 60/80) for the telephony interface. PNG/.png (OpenStage Ideal size for OpenStage 40: 60/80) width: 144px; height: 32 px. BMP/.bmp (black/white, Ideal size for OpenStage 60: for OpenStage 40) width: 240 px; height: 70 px.
Page 179 Ideal resolution for Open- Stage 60: 320x640 Ideal resolution for Open- Stage 80: 640x480 OpenStage 60/80 only. Ringer file WAV/.wav Custom Ringtones. RINGTONE MIDI/.mid The file size for a ringer file MP3/.mp3 (OpenStage...
Page 180: Local Functions
Phone Parameters - Administration Nur für den internen Gebrauch Local functions Local functions 4.6.1 Directory settings These settings are relevant for OpenStage 15/20/40/60/80 and OpenScape Desk > Phone IP 35/55G. WBM Name Item name Type Values Description LDAP Server ad-...
Page 181: Messages Settings
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Local functions WBM Name Item name Type Values Description User name Text Default: NULL User name for authenti- ldap-user cation with the LDAP server in the LDAP bind request. Password Text Default: NULL Password used for au- ldap-pwd...
Page 182: Locality
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Local functions WBM Name Item name Type Values Description Alternative label Text Default: NULL Label for new urgent MWI-new- Max. 17 items. urgent-label charac- ters Old items Boolean Determines whether old MWI-old-show true/false Default: true...
Page 183 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Local functions WBM Name Item name Type Values Description Minimum local Text Default: NULL Minimum number of digits Canonical- number length in a local PSTN number. dialing-min- local-number- length Local enterprise Text Default: NULL Number of the company/ Canonical-...
Page 184 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Local functions WBM Name Item name Type Values Description Initial extension Text; com- Default: NULL List of initial digits of all Canonical- digits ma sepa- possible extensions in the dialing- rated if local enterprise network.
Page 185 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Local functions WBM Name Item name Type Values Description External numbers Canonical- Enumer- 0=Local public Defines how dial strings ation form; for external numbers are dialing-dial- 1=National pub- generated. external-form lic form;...
Page 186: Energy Saving
3=3; timespan specified in 4=4; hours, the display back- 5=5; light is switched off. 6=6; Only used for OpenStage 7=7; V2R1 and lower. 8=8; Default: 3 Backlight time Enumer- 1=5s (not used); After the phone has been...
Page 187: Video Call
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Local functions 4.6.6 Video call This function is available with firmware version V3.1. > WBM Name Item name Type Values Description Video on Boolean When set to true, video video-on true/false Default: call is on.
Page 188: Date And Time
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Date and time Date and time WBM Name Item name Type Values Description SNTP IP address sntp-addr IP ad- Default: NULL IP address or hostname dress or of the SNTP server. host- name.
Page 189 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Date and time WBM Name Item name Type Values Description DST zone Enumer- 0=Not set; Specifies the zone for de- daylight- ation 1=Australia 2007 termining the date to au- save-zone-id (ACT, South Aus- tomatically apply/remove tralia, Tasmania,...
Page 190: Speech
Allow "HD" icon Boolean Switches the "HD" icon allow-hd- true/false Default: true displayed if and when the icon-display OpenStage is connected using a high quality (G.722 or better) codec. Packet size Enumer- 0=10 ms; Size of RTP packets in codec- ation 1=20 ms;...
Page 191 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Speech WBM Name Item name Type Values Description G.711 ranking Integer 1 to number of Ranking for each codec. codec-rank G.729 ranking codec types. <index> G.722 ranking Default: 1 for G.722; 2 for G.711;...
Page 192: Audio Settings
The usage of microphone and speaker for speakerphone mode can be controlled by the provi- sioning interface. Both microphone and loudspeaker can be switched on or off separately. By default, both microphone and loudspeaker are switched on. The microphone control is not valid for OpenStage 20E, as this model has no builtin > microphone.
Page 193: General Information
Shows date and time of the last reboot. Backlight type Enumer- Indicates whether the backlight- 0=none ation phone has a backlight, type 1=CCFL and, if applicable, the 2=LED type of backlight. Available with OpenStage V2R2. A31003-S2000-R102-16-7620, 02/2016 Provisioning Service, Developer’s Guide...
Page 194: Security And Policies
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Security and Policies 4.10 Security and Policies The menu structure has changed with firmware version V3. The corresponding sec- > tion in the V2 menu is called "Authentication". 4.10.1 Password 4.10.1.1 Generic Policy (V3) WBM Name...
Page 195 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Security and Policies WBM Name Item name Type Values Description History valid for Integer Default: 180 Defines a period in days pwd-history- (days) during which the history is days valid. Passwords no long- er used are kept in history lists for the user and ad- min passwords to prevent...
Page 196 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Security and Policies WBM Name Item name Type Values Description Current status Enumer- When set to "active", the admin-pwd- 0="active"; ation admin password is avail- status 1="suspended"; able for use. With "sus- 2="disabled"...
Page 197 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Security and Policies WBM Name Item name Type Values Description Current status Enumer- When set to "active", the user-pwd- 0="active"; ation user password is avail- status 1="suspended"; able for use. With "sus- 2="disabled"...
Page 198 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Security and Policies WBM Name Item name Type Values Description Min char Integer 0 to 24 Specifies the minimum pwd-min-no- difference Default: 0 number of characters by differences which a new password must differ from the previ- ous password.
Page 199: Certificates (V3)
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Security and Policies 4.10.2 Certificates (V3) 4.10.2.1 Generic WBM Name Item name Type Values Description OCSP check Boolean When set to true, the ocsp-check- true/false Default: false configured OCSR is re- allowed quested to check if the certificate has been re-...
Page 200 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Security and Policies WBM Name Item name Type Values Description XML applications xml-app- Enumer- Sets the authentication 0=None; ation level for the XML applica- authentication 1=Trusted; tions server. -policy 2=Full Default: 0 A31003-S2000-R102-16-7620 02/2016 Provisioning Service, Developer’s Guide...
Page 201: Ringer Setting
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Ringer Setting 4.11 Ringer Setting 4.11.1 Distinctive This function is available with firmware version V3R3. > The SIP server may provide information which indicates a specific type of call within an incom- ing call.
Page 202 NULL (no file assigned, in this case "ringer-melody[in- dex]" and "ringer-tone[in- dex]" are applicable). All OpenStage/OpenScape Desk phones support WAV and MIDI files; OpenStage 60/80/OSD- PIP55G also support MP3 files. Pattern melody / Integer Selects a ringer melody alert 0=silence;...
Page 203: Map To Specials
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Ringer Setting WBM Name Item name Type Values Description Pattern sequence alert Enumer- 1=1 sec ON, 4 Selects a ringer se- ation sec OFF; quence consisting of mel- <index> (3rd value) 2=1 sec ON, 2 ody patterns and silent sec OFF;...
Page 204: Mobility
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Mobility WBM Name Item name Type Values Description Emergency Text Default: alert- see Internal map-special- emergency ringer-3 Special1 Text Default: NULL see Internal map-special- ringer-4 Special2 Text Default: NULL see Internal map-special- ringer-5 Special3...
Page 205: Diagnostics
4.13.3 Fault trace configuration Error tracing and logging can be configured separately for all services and applications running on the OpenStage phone. The resulting files can be viewed in the WBM web pages over the Download links. WBM Name Item name...
Page 206 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Diagnostics WBM Name Item name Type Values Description Trace timeout Integer 0 to 999 Determines when to stop trace- (minutes) Default: 60 writing to the trace file. timeout When the value is 0, the timeout is disabled.
Page 207 As with "Adminis- Handles the Bluetooth in- ation tration" teractions between exter- index="40" nal Bluetooth devices and the phone. Bluetooth is available only on OpenStage 60/80 phones. Call Log Enumer- As with "Adminis- The Call log application trace-level ation tration"...
Page 208 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Diagnostics WBM Name Item name Type Values Description CSTA service Enumer- As with "Adminis- Any CSTA messages are trace-level ation tration" handled by this service. index="9" Default: 6 CSTA messages are used within the phone by all services as a common call progression and con-...
Page 209 OBEX service Enumer- As with "Adminis- Involved with Bluetooth trace-level ation tration" accesses to the phone. index="21" Bluetooth is available only on OpenStage 60/80 phones. OpenStage client Enumer- As with "Adminis- Provides a means by trace-level management ation tration" which other services with- index="22"...
Page 210 Values Description Phonebook Enumer- As with "Adminis- Responsible for the trace-level ation tration" phonebook application. index="3" Available for OpenStage 60/80, DPIP55 phones. Performance Enumer- As with "Adminis- Aid for measuring the per- trace-level Marks ation tration" formance of the phone.
Page 211 USB stick by index="44" using password. This item is available in the phone GUI. Available for OpenStage 60/80, DPIP55 phones. vCard parser ser- Enumer- As with "Adminis- Handles parsing and trace-level vice ation tration"...
Page 212: Easytrace Profiles
The service is used for certain closed wireless access points. 4.13.4 EasyTrace Profiles This function is not available with WPI. > 4.13.5 Bluetooth Advanced Traces This function is not available for OpenStage Desk Phone IP. > A31003-S2000-R102-16-7620 02/2016 Provisioning Service, Developer’s Guide...
Page 213: Qos Reports
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Diagnostics WBM Name Item name Type Values Description Automatic clear Flag, if dumpfile should bt-hci-del- Boolean true/false before start Default: true be deleted before starting before-start new trace File size (Max. 1 to 6300000 Maximum size of the bt-hci-dump-...
Page 214 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Diagnostics WBM Name Item name Type Values Description Report interval Integer 10 to 3600. Time interval between the qdc-report- (seconds) Value must be an periodical observations. integer multiple of the "Observation interval"...
Page 215: Miscellaneous
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Diagnostics WBM Name Item name Type Values Description Compressing co- Integer 0 to 255 When the number of lost qdc-cc- dec threshold val- Default: 10 packets exceeds this packet-loss- ues - Lost pack- maximum value during threshold ets (per 1000...
Page 216 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Diagnostics 4.13.7.3 Core Dump WBM Name Item name Type Values Description Enable core Boolean If enabled, a core dump core-dump- true/false dump Default: true will be initiated in case of enabled a severe error.
Page 217: Maintenance
c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Maintenance 4.14 Maintenance 4.14.1 Remote trace This area is applicable only when using the web interface. WBM Name Item name Type Values Description Remote Trace Bool If enabled, syslog server remote- true/false Status...
Page 218: Secure Shell
This feature provides the possibility to place a diagnostic call, which starts call related tracing on the phone and on involved OS Voice and collect these traces at OpenStage Voice Trace Manager (OSVTM). With all these traces available, a call can be followed throughout the voice A31003-S2000-R102-16-7620 02/2016 Provisioning Service, Developer’s Guide...
Page 219 c04.fm Phone Parameters - Administration Nur für den internen Gebrauch Maintenance system and a possible problem can be detected faster. As all traces from all involved compo- nents are available at the first level support, the analysis of a possible problem can be started immediately.
Page 220: Phone Parameters - User
"Configuration > Outgoing calls" in the web interface. However, deviations are possible due to changes between firmware versions. If not otherwise stated, the Items are available on all phone variants, that is, OpenStage 15/20/ 40/60/80 and OpenScape Desk Phone IP 35/55G.
Page 221 c05.fm Phone Parameters - User Nur für den internen Gebrauch Date and Time WBM Name Item name Type Values Description Auto time change auto- Boolean Enables or disables auto- true/false Default: false, matic control of daylight daylight- OS40 US/ saving time according to save DPIP35 / the Time zone.
Page 222: Audio
0.36 sec OFF; Default: 2 Ringer Text Default: NULL Name of the ringtone file ringer- to be used (WAV or, on audio-file OpenStage 60/80, Open- Scape DPIP 55G, MP3). Room Character Not applicable. Open listening Enumer- Country-specific setting loudspeaker- 0=Standard ation mode;...
Page 223: Special Ringers
c05.fm Phone Parameters - User Nur für den internen Gebrauch Audio 5.2.2 Special ringers Defines the ringer played for a limited range of special incoming calls where the type of call is signalled to the phone. WBM Name Item name Type Values Description...
Page 224: Configuration
c05.fm Phone Parameters - User Nur für den internen Gebrauch Configuration Configuration 5.3.1 Outgoing calls WBM Name Item name Type Values Description Autodial delay Integer 1 to 9 After this delay, which autodialtimer (seconds) Default: 6 follows the last digit en- tered, a number is di- aled.
Page 225: Incoming Calls
c05.fm Phone Parameters - User Nur für den internen Gebrauch Configuration 5.3.2 Incoming calls 5.3.2.1 Deflecting WBM Name Item name Type Values Description Allow deflection Boolean If enabled, the user can call- true/false Default: true deflect an incoming call. deflection- enabled Default deflect Text...
Page 226 c05.fm Phone Parameters - User Nur für den internen Gebrauch Configuration WBM Name Item name Type Values Description Forward on busy Boolean Allows forwarding in case cfb- true/false allowed Default: false the user is engaged in an- activated other call. Text Default: NULL Forward destination if...
Page 227 c05.fm Phone Parameters - User Nur für den internen Gebrauch Configuration extend the existing Call Forwarding UI. This is a serverbased feature provided by SIP Server with CSTA Phase III / ECMA-269. To use extended call forwarding, Server features and Allow uaCSTA must be switched on (See Section 4.4.5.1, "Configuration").
Page 228 c05.fm Phone Parameters - User Nur für den internen Gebrauch Configuration WBM Name Item name Type Values Description Forwarding on Text Default: NULL Forwarding destination. cfb-ext- busy external address destination URI Forwarding on Boolean Allows forwarding when cfb-int- true/false busy internal is Default: false busy for internal calls.
Page 229 c05.fm Phone Parameters - User Nur für den internen Gebrauch Configuration WBM Name Item name Type Values Description Forwarding un- Boolean See above "Forwarding cfu-ext- true/false conditional exter- Default: false unconditional settings is unchangeable nal settings is un- unchangeable" changeable Forwarding un- Boolean See above "Forwarding...
Page 230 c05.fm Phone Parameters - User Nur für den internen Gebrauch Configuration 5.3.2.4 Handling WBM Name Item name Type Values Description Allow call waiting call- Boolean If set to true, the user true/false Default: true can accept a second in- waiting- coming call in the course enabled of an ongoing call.
Page 231: Connected Calls
c05.fm Phone Parameters - User Nur für den internen Gebrauch Configuration 5.3.3 Connected calls WBM Name Item name Type Values Description Allow call transfer call- Boolean If set to true, call trans- true/false Default: true fer is enabled. transfer- enabled Allow call joining call-join-en- Boolean If set to true, the user...
Page 232: Context Menu
(connected or alerting) or when con- nects without ringing 5.3.4 Context menu This function is available on OpenStage phones. > WBM Name Item name Type Values Description Auto show menu context- Boolean...
Page 233: Keyset
5=5; (sec.) ation which the automatically menu-auto- 10=10; opened context menu will hide-time 20=20; disappear. 30=30; Relevant for OpenStage 60=60; 40/60/80/41 and Open- 120=120; Scape DPIP 55G. No auto Available with firmware hide=0(context menu will stay version V2R1. open) Default: 20, OS40 US: 0 5.3.5...
Page 234 c05.fm Phone Parameters - User Nur für den internen Gebrauch Configuration 5.3.5.2 Overview WBM Name Item name Type Values Description <Key label> Integer 1 to number of Determines the position line-mlo-pos (for the relevant lines of this line in the line over- <index>...
Page 235: Blf
Monitored phone Section 4.4.5.3, "BLF" (read only) Audible alert Section 4.4.5.3, "BLF" Popup on alert Section 4.4.5.3, "BLF" 5.3.7 Bluetooth This function is available on OpenStage phones. > WBM Name Item name Type Values Description Bluetooth device Text. Same format as...
Page 236: Call Logging
c05.fm Phone Parameters - User Nur für den internen Gebrauch Configuration WBM Name Item name Type Values Description Last connected Not applicable device - Device class 5.3.8 Call logging WBM Name Item name Type Values Description Enable call log Boolean Enables or disables the call-log- true/false...
Page 237: Video Call
c05.fm Phone Parameters - User Nur für den internen Gebrauch Phone 5.3.9 Video Call WBM Name Item name Type Values Description Video on Boolean Enables/Disables mak- video-on true/false Default: false ing and accepting video calls. NOTE: This item is user configurable only if “video-allowed”...
Page 238: Screensaver
Description Screensaver en- Boolean Enables or disables the screensaver- true/false abled Default: false screensaver. enabled OpenStage 60/80 / DPIP55 only. Start (minutes) Enumer- 0=0 (no timeout); When there has been no inactivity- ation activity on the phone for timeout 5=5;...
Page 239: Openstage 15 Key Module
Nur für den internen Gebrauch Phone 5.4.6 OpenStage 15 Key Module The settings for the key module 15 are the same as those for programmable keys on the phone (see Section 4.4.5.3, "Free Programmable Keys (FPK)"). For this key module, the key numbers represented by the index attribute are 501 to 518 for the first level, and 1501 to 1518 for the shift level.
Page 240: Locality
c05.fm Phone Parameters - User Nur für den internen Gebrauch Locality Locality WBM Name Item name Type Values Description Country 2 charac- See Section 7.2, Country wherein the country-iso ter string "Country codes" phone resides. Default: GB, OS40 US / DPIP35 / DPIP55: US Language...
Page 241: Diagnostic Information
c05.fm Phone Parameters - User Nur für den internen Gebrauch Diagnostic information Diagnostic information This function is not available with WPI. > A31003-S2000-R102-16-7620, 02/2016 Provisioning Service, Developer’s Guide...
Page 242: Phone Parameters - Provisioning
The value is built up dur- OpenStage 20; ing phone start up, querying the OpenStage 40; hardware variant. OpenStage 60; OpenScape DPIP35 = OpenStage OpenStage 80 20, OpenScape DPIP55 G = Open- Stage 60 A31003-S2000-R102-16-7620 02/2016 Provisioning Service, Developer’s Guide...
Page 243 OpenStage 20; ner. The value is built up during OpenStage 40; phone start up, querying hardware OpenStage 60; variant. OpenStage 80 OpenScape DPIP35 = OpenStage 20, OpenScape DPIP55 G = Open- Stage 60 Boolean Relevant for OpenStage 20/40/60/ gigabit- true/false 80 G / DPIP55G only.
Page 244 Phone Specific, Hardware Related Item name Type Values Description Integer For OpenStage 10/ Number of OpenStage Key km15-modules 20/60/80, the value Modules 15. Sent to the provisioning is always 0. For service in "ReadAllItems" message OpenStage 15/40, response. Value is read only.
Page 245: Files Stored On The Phone
c06.fm Phone Parameters - Provisioning Nur für den internen Gebrauch Files Stored on the Phone Files Stored on the Phone After a file transfer initiated by the provisioning service is completed, the phone gives feedback to indicate if the transfer has been successful. Additionally, when the provisioning service sends a "ReadAllItems"...
Page 246: Network/Dns
c06.fm Phone Parameters - Provisioning Nur für den internen Gebrauch Network/DNS Network/DNS Item name Type Values Description Boolean If activated, the E.164 number is e164-hostname true/false Default: true used as the DNS host name for the phone. 802.1x Security Item name Type Values Description...
Page 247: Usb
c06.fm Phone Parameters - Provisioning Nur für den internen Gebrauch Item name Type Values Description Text Default: NULL (For future) eap-ttls-otp One time password when using 802.1x authentication method EAPTTLS. Text Default: NULL (For future) eap-fast- Shared secret when using 802.1x secret authentication method EAP-FAST.
Page 248: Feature Keys
c06.fm Phone Parameters - Provisioning Nur für den internen Gebrauch Feature Keys Feature Keys Item name Type Values Description Boolean If true, the provisioning service has locked- true/false Default: false locked down the key specified by the function-key index. The assigned function and <index>...
Page 249: Ldap
c06.fm Phone Parameters - Provisioning Nur für den internen Gebrauch LDAP 6.12 LDAP Item name Type Values Description Enumera- Transport Type allows the LDAP in- ldap-transport 0=TCP; tion terface to be encrypted using TLS 1=TLS; Default: 0 (via LDAPS) or unencrypted using TCP LDAP transport 6.13 Certificates...
Page 250 c06.fm Phone Parameters - Provisioning Nur für den internen Gebrauch Certificates Item name Type Values Description PEM file Note: If the XML Created from wbm-server-cer- wbm-server- (single cer- item received from tificate (removing private key certificate- tificate) the provisioning ser- and optional CA certificate).
Page 251 c06.fm Phone Parameters - Provisioning Nur für den internen Gebrauch Certificates Item name Type Values Description PEM file Note: If the XML Current RADIUS server CA certifi- radius-server- (single cer- item received from cate. For 802.1x network access tificate or the provisioning ser- (using EAP-TLS, PEAP or EAP- certificate...
Page 252 c06.fm Phone Parameters - Provisioning Nur für den internen Gebrauch Certificates Item name Type Values Description PEM file Note: If the XML Provisioning service provides dls-client- (single cer- item received from phones with client certificate for certificate tificate) the provisioning ser- phone Secure Mode vice is empty, this means delete the...
Page 253: Call Log
c06.fm Phone Parameters - Provisioning Nur für den internen Gebrauch Call Log 6.14 Call Log Item name Type Values Description Boolean When the phone receives this pa- clear-calllog true/false Default: false rameter with the value set to true, the call log will be deleted. In case the value should be set to false, the phone will ignore the parameter.
Page 254: Phone Location
c06.fm Phone Parameters - Provisioning Nur für den internen Gebrauch Phone Location 6.16 Phone Location Item name Type Values Description String Civic Address ele- CSV element format according to ng911- ment in a CSV for- LLDP-MED Standard ANSI/TIA- location-ca 1057/ANNEX B: <CAtype>=<location string>, Note: CAtype 0 represents the coun- try in this data item rather than the...
Page 255: Appendix
c07.fm Appendix Nur für den internen Gebrauch XML Schemas Appendix XML Schemas This sections provides the XML schemas to be associated with the message structures de- scribed in Section 3, "Basic Communication Procedures". 7.1.1 Common Message Elements <?xml version="1.0" encoding="UTF-8"?> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"...
Page 256 c07.fm Appendix Nur für den internen Gebrauch XML Schemas <xsd:complexType name="ItemType"> <xsd:simpleContent> <xsd:extension base="xsd:string"> <xsd:attribute name="name" type="xsd:string"/> <xsd:attribute name="index" type="xsd:string" use="optional"/> <xsd:attribute name="type" type="xsd:string" use="optional"/> <xsd:attribute name="status" type="xsd:string" use="optional"/> </xsd:extension> </xsd:simpleContent> </xsd:complexType> </xsd:schema> A31003-S2000-R102-16-7620 02/2016 Provisioning Service, Developer’s Guide...
Page 257: Phone Message
c07.fm Appendix Nur für den internen Gebrauch XML Schemas 7.1.2 Phone Message <?xml version="1.0" encoding="UTF-8"?> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:dls="http://www.siemens.com/DLS" targetNamespace="http://www.siemens.com/DLS" elementFormDefault="qualified"> <xsd:annotation> <xsd:documentation xml:lang="en"> DLS upstream schema </xsd:documentation> </xsd:annotation> <xsd:include schemaLocation="common.xsd"/> <xsd:element name="WorkpointMessage" type="dls:WorkpointMessageType" /> <xsd:complexType name="WorkpointMessageType"> <xsd:sequence> <xsd:element name="Message" type="dls:WPMessageType"/> </xsd:sequence>...
Page 258 c07.fm Appendix Nur für den internen Gebrauch XML Schemas <xsd:enumeration value="start-up"/> <xsd:enumeration value="local-changes"/> <xsd:enumeration value="inventory-changes"/> <xsd:enumeration value="status"/> <xsd:enumeration value="solicited"/> <xsd:enumeration value="reply-to"/> <xsd:enumeration value="clean-up"/> <xsd:enumeration value="get-next-fragment"/> </xsd:restriction> </xsd:simpleType> <xsd:simpleType name="StatusType"> <xsd:restriction base="xsd:string"> <xsd:enumeration value="accepted"/> <xsd:enumeration value="failed"/> <xsd:enumeration value="busy"/> </xsd:restriction> </xsd:simpleType> </xsd:schema> A31003-S2000-R102-16-7620 02/2016 Provisioning Service, Developer’s Guide...
Page 259: Provisioning Service Message
c07.fm Appendix Nur für den internen Gebrauch XML Schemas 7.1.3 Provisioning Service Message <?xml version="1.0" encoding="UTF-8"?> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:dls="http://www.siemens.com/DLS" targetNamespace="http://www.siemens.com/DLS" elementFormDefault="qualified"> <xsd:annotation> <xsd:documentation xml:lang="en"> DLS downstream schema </xsd:documentation> </xsd:annotation> <xsd:include schemaLocation="common.xsd"/> <xsd:element name="DLSMessage" type="dls:DLSMessageType"/> <xsd:complexType name="DLSMessageType"> <xsd:sequence> <xsd:element name="Message" type="dls:MessageType"/> </xsd:sequence>...
Page 260: Country Codes
c07.fm Appendix Nur für den internen Gebrauch Country codes Country codes • Argentina - AR • Australia - AU • Austria - AT • Belgium - BE • Brazil - BR • Canada - CA • Chile - CL • China - CN •...
Page 261: Language Codes
c07.fm Appendix Nur für den internen Gebrauch Language Codes • Republic of Korea - KR • Russian Federation - RU • Singapore - SG • Slovakia - SK • South Africa - ZA • South Korea - KR • Spain - ES •...
Page 262 c07.fm Appendix Nur für den internen Gebrauch Language Codes • Greek - el • Hungarian - hu • Indonesian - id • Italian - it • Japanese - ja • Korean - ko • Latvian - lv • Lithuanian - lt •...
Page 263: Locked Configuration Menus
c07.fm Appendix Nur für den internen Gebrauch Locked Configuration Menus Locked Configuration Menus The following functions resp. menus can be locked, so that the user can not modify the settings. 7.4.1 Local Feature/Menu Item name Description Country options Select a country from a list to adapt the phone to locked-config- country specific conditions.
Page 264: Telephony Features
c07.fm Appendix Nur für den internen Gebrauch Locked Configuration Menus 7.4.4 Telephony Features Feature/Menu Item name Description Auto answer Enable auto answer. locked-config- menus-32 Auto answer beep Enable beep on auto answer. locked-config- menus-33 Auto reconnect Enable auto reconnect. locked-config- menus-34 Auto reconnect Enable beep on auto reconnect.
Page 265 c07.fm Appendix Nur für den internen Gebrauch Locked Configuration Menus Feature/Menu Item name Description Do Not Disturb Enable Do Not Disturb (DND). locked-config- menus-19 Message waiting Enables LED indication of new messages in mail- locked-config- menus-20 Hold Ringback Enable ringback for calls on hold. locked-config- menus-21 Conference...
Page 266 Call Log Enabled Enables Call Log locked-config- menus-73 Hold and Hangup Enables the ’Hold and Hangup’ notification (Non- locked-config- Keyset OpenStage only) menus-74 Lower IL alert notifi- Enables the ’Lower Impact Level’ notification locked-config- cation menus-75 Video on Enables the video functionality...
Page 267: Audio Settings
c07.fm Appendix Nur für den internen Gebrauch Locked Configuration Menus Feature/Menu Item name Description Backlight Timeout Controls the screensaver timeout locked-config- Energy Saving menus-79 Display Special ringer- Controls the ringer played for a limited range of locked-config- Internal special incoming calls where the type of call is sig- menus-80 nalled to the phone.
Page 268: Passwords
c07.fm Appendix Nur für den internen Gebrauch Locked Configuration Menus 7.4.7 Passwords Feature/Menu Item name Description Set user password Set/modify the user password. locked-local- function- menus-02 7.4.8 Phone Lock Feature/Menu Item name Description Phone lock Lock the phone. locked-local- function- menus-03 7.4.9 Bluetooth Settings...
Page 269: Glossary
Hypertext Transfer Protocol over Secure Socket Layer. Used for HTTPS XML data exchange between provisioning service and OpenStage phones. Multiple Line Appearance. When operating in MAA mode, a sin- gle phone can handle multiple lines. Personal Idendification Number. Concatenation of password and TAN.

This manual is also suitable for:

Openscape

Unify OpenStage Developer's Manual

1 Getting Started

2 Dhcp

3 Basic Communication Procedures

4 Phone Parameters - Administration

5 Phone Parameters - User

6 Phone Parameters - Provisioning

7 Appendix

Quick Links

Related Manuals for Unify OpenStage

Summary of Contents for Unify OpenStage

This manual is also suitable for:

Table of Contents