Versions Compared

Old Version 2

changes.mady.by.user Baremans, Eric

Saved on

compared with

New Version 3

changes.mady.by.user Baremans, Eric

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

Expand
titleExample
Code Block
languagexml
<?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>
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.
<nick_name>

Specifies the Nickname of the contact.  The nick_name is not supported any more (Versions  > 10.1.162.1).

If the nick_name is present, and first_name and last_name are empty, the nick_name will be interpreted like this:

What was previously entered in the field is now separated at the last space and stored in first_name/last_name. If there is no space in the name, the name is interpreted as a last name.
I.e., Name: Klaus Maria Brandauer: -> first_name Klaus Maria, last_name: Brandauer
    Name: Helena Bonham Carter:  -> first_name Helena Bonham, last_name: Carter
    Name: Elan -> last_name : Elan
    Name: Musk -> last_name: Musk
This change is not visible until a contact is open for editing. (Since the name is put together on display the same way)    

If a first_name or last_name is set at the same time, the nick_name is discarded.

<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

<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/alias>
An number alias  Not supported any more. The alias was the nick_name copied in each entry of the number field. Please see nick_name for more info.
<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