Snom Service Hub

Content

Page tree


 

Remote XML Directory

Starting with firmware 10.1.178.0, Snom desk phones also support a remote directory in an XML file, which will be downloaded into the phone's local directory periodically (it has then the same limitations as the internal directory)

On each phone you can configure up to three different XML directories: on the D1xx/D3xx/D7xx/D81x series the phone will download all of them in the same local directory, in the D86x series the phone will show them with a different name in the list of available directories

Below an example of the file you can use, this needs to be an XML file sitting on an HTTP server able to react to HTTP POST requests from the phone

Inside <Settings> tag 
<tbook e='2' version='2.0'>
<contact fav="false" vip="false" blocked="false">
  <first_name>Theo</first_name>
  <last_name>Maier</last_name>
  <numbers>
    <number no="25234984723" type="mobile" outgoing_id="0"/>
  </numbers>
</contact>
<contact fav="false" vip="false" blocked="false">
  <first_name>John</first_name>
  <last_name>Doe</last_name>
  <numbers>
    <number no="1234567890" type="mobile" outgoing_id="0"/>
  </numbers>
</contact>
<contact fav="false" vip="false" blocked="false">
  <first_name>Alice</first_name>
  <last_name>Smith</last_name>
  <numbers>
    <number no="9876543210" type="home" outgoing_id="0"/>
  </numbers>
</contact>
</tbook>

Explanation of Local Directory XML Tags and Attributes

Attribute / TagValid ValuesExplanation
<tbook>
The tbook tag defines the directory itself.
e2Defines that unicode-values inside xml-escapes (e.g. &#64;) may be greater than 255.
completetrue / falseWhen this is provisioned, it indicates that the provided tbook is complete and thus the previous one can be deleted. This is the only way to delete entries from the internal tbook via provisioning.
version2.0Indicates the new XML format
<contact>
Each contact tag defines one local directory contact
attribute: fav
  • true
  • false
Defines whether the current contact is a Favorite or not. This affects the list when filtering for favourite contacts.
attribute: vip
  • true
  • false
Defines whether the current contact is a VIP or not. 
attribute: blocked
  • true
  • false
Defines whether the current contact is a blocked one or not. 
<first_name>
Specifies the first name of the contact.
<last_name>
Specifies the family name of the contact.
<numbers>
Contains all number tags belonging to that contact
<numbers/number>
Contains all number data to one number of a contact. A contact can have multiple numbers. Please look at the XML example above
number attrib: no
Specifies the number of the contact.
number attrib: type
  • sip
  • mobile
  • fixed
  • home
  • business
  • extension
Number type
number attrib: outgoing_id0: active, otherwise identityoutgoing identity

Directory parameters

You would need to set up some parameters on the phone, so it can get the URL to the XML file and retrieve it to save it locally

Each parameter can be using an index that goes from 1 to 3, since there are three of these directories you can set

  • extdir_name: The name of the external directory, it will be displayed in the list if you're using this on D86x phones (optional, if not specified the D86x phone will show a default name for the directory)
  • extdir_url: The URL to the XML file on the HTTP server (mandatory)
  • extdir_interval: Determines, in seconds, how much time should elapse before the phone initiates a external XML directory download. The minimum value is 3600, the maximum is 1209600, and if you set it to "0" it won't re-download the phonebook multiple times, only at provisioning (mandatory)
  • extdir_user: The username if you use basic HTTP authentication on the server (optional)
  • extdir_password: The password if you use basic HTTP authentication on the server (optional)


Settings via web interface

Since the settings above cannot be set up via the Web Interface in any menu, you can use the Settings or Settings List pages of the web interface, as described at the guide How to change a parameter in the Settings page



Further Information


Related articles