Provisioning the local directory can be done using the XML version 2.0 format


1.  Create a regular settings file and included a <tbook> inside it. Please set the version to 2.0


<?xml version="1.0" encoding="utf-8" ?>
<settings>
<tbook complete="true" e='2' version='2.0'>
  <contact fav="true" vip="true" blocked="false">
    <first_name>Anne</first_name>
    <last_name>Meyer</last_name>
    <title>Dr</title>
    <organization>MSW</organization>
    <email>ann@msw</email>
    <note>a note</note>
    <group>work</group>
    <source_id>A value between 1-12, please see below</source_id>
    <photo>a base64 encoded photo image</photo>
     <numbers>
      <number no="444" type="business" outgoing_id="0">
        <action_url>action-url</action_url>
      </number>
      <number no="445" type="extension" outgoing_id="0">
        <action_url>action-url2</action_url>
      </number>
      <number no="446" type="fixed" outgoing_id="0">
        <action_url>action-url3</action_url>
      </number>
    </numbers>
  </contact>

  <contact fav="false" vip="false" blocked="true">
    <first_name>Paul</first_name>
    <last_name>Meyer</last_name>
    <title>Dr</title>
    <organization>MSW</organization>
    <email>paul@msw</email>
    <note>a note</note>
    <source_id>4</source_id>
    <numbers>
      <number no="334" type="home" outgoing_id="0">
      </number>
      <number no="335" type="sip" outgoing_id="0"/>
    </numbers>
  </contact>
 
</tbook>
</settings>


2. Create a separate xml settings file and included in your list of <settings-files>

<?xml version="1.0" encoding="utf-8"?>
<tbook complete="true" e='2' version='2.0'>
<!--See the above example -->
</tbook>




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 XML version 2 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.

<title>

Specifies the title e.g. "Head of Finances" of the contact.

<organization>

Specifies the organization of the contact.

<email>

Specifies the E-Mail address of the contact.

<note>

Adds a note to the contact that can be viewed in the contact details.

<group>
  • <empty>
  • work
  • colleague
  • family
  • friend

Specifies the group the contact belongs to. This is relevant when any of the sorting methods is applied.

<source_id>

A unique server id

These are the currently possible numbers:

  kTbook = 1,
  kProvisioned = 2,
  kLdap = 3,
  kMetaswitchContacts = 4,
  kMetaswitchExtensions = 5,
  kMetaswitchShortCode = 6,
  kXsiEnterprise = 7,
  kXsiEnterpriseCommon = 8,
  kXsiGroup = 9,
  kXsiGroupCommon = 10,
  kXsiPersonal = 11,
  kXmpp = 12,
<photo>

Only one tag can be present.

<photo> contains a base64 encoded photo string Max.640x480

<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
<numbers/number/action_url>valid URLSpecifies the action URL that is requested when the phone receives or places a call from/to this contact.
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