Local Phonebook - XML format

1. Create a regular settings file and included a <tbook> inside it.

Inside <Settings> tag

<?xml version="1.0" encoding="utf-8" ?>
<settings>
<tbook complete="true" e='2'>
<item context="active" type="">    
	<name>106</name>    
	<number>106</number>  
</item>  
<item context="active" type="friend">    
	<name>Gigaset P710</name>    
	<number>103</number>  
</item> 
<item context="active" type="family">    
	<name>Gigaset P810</name>    
	<number>104</number>  
</item>
<item context="active" type="work">    
	<name>Gigaset P82X</name>    
	<number>102</number>  
</item> 
<item context="active" type="colleagues">    
	<name>Gigaset P850</name>    
	<number>100</number>  
</item>
<item context="active" type="server">    
	<name>Gigaset P850</name>    
	<number>107</number>  
</item>
<item context="active" type="">    
	<name>Gigaset N870 HS1</name>    
	<number>105</number>  
</item>  
<item context="active" type="vip" fav="true" mod="false" index="0">
<name>Nickname</name>
<number>Number</number>
<number_type>mobile</number_type>
<first_name>First Name</first_name>
<last_name>Family Name</last_name>
<title>Title</title>
<organization>Organization</organization>
<email>E-Mail</email> <note>Note</note>
<photo>(Base64 Encoded Photo)</photo>
<action_url>http://action.url:80</action_url>
<group>work</group> </item> 
</tbook>
</settings>

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

Individual XML file whose URL is listed inside <setting-files> tag

<?xml version="1.0" encoding="utf-8"?>
<tbook complete="true" e='2'> 
 <item context="active" type="">    
	<name>106</name>    
	<number>106</number>  
</item>  
<item context="active" type="friend">    
	<name>Gigaset P710</name>    
	<number>103</number>  
</item> 
<item context="active" type="family">    
	<name>Gigaset P810</name>    
	<number>104</number>  
</item>
<item context="active" type="work">    
	<name>Gigaset P82X</name>    
	<number>102</number>  
</item> 
<item context="active" type="colleagues">    
	<name>Gigaset P850</name>    
	<number>100</number>  
</item>
<item context="active" type="server">    
	<name>Gigaset P850</name>    
	<number>107</number>  
</item>
<item context="active" type="">    
	<name>Gigaset N870 HS1</name>    
	<number>105</number>  
</item>  
<item context="active" type="vip" fav="true" mod="false" index="0">
<name>Nickname</name>
<number>Number</number>
<number_type>mobile</number_type>
<first_name>First Name</first_name>
<last_name>Family Name</last_name>
<title>Title</title>
<organization>Organization</organization>
<email>E-Mail</email> <note>Note</note>
<photo>(Base64 Encoded Photo)</photo>
<action_url>http://action.url:80</action_url>
<group>work</group> </item>  
</tbook>

Attribute / Tag	Valid Values	Explanation
<tbook>		The tbook tag defines the directory itself.
e	2	Defines that unicode-values inside xml-escapes (e.g. @) may be greater than 255.
complete	true / false	When 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.
<Item>		Each item tag defines one local directory contact it requires the attributes below to properly function
context	<empty> active line1-line12	Defines the SIP identity (line/account) this contact should be called with. Leaving this empty always chooses the currently active identity.
type	none vip deny MASTER or work colleague family friend	Defines the contact's category for special phone states. Contacts that have set their type to VIP can bypass certain phone blocking states such as DND. Contacts that have set their type to deny are permanently blocked from calling the user. Contacts that have set their type to MASTER are contacts containing more than one number.
index	<number>	Represents the contact's visual position within the list of entries in case of no sorting options. This value must be unique for each item.
fav	true false	Defines whether current contact is a Favorite or not. This affects the list when filtering for favorite contacts.

<first_name>		Specifies the first name of the contact.
<last_name>		Specifies the family name of the contact.
<name>		Specifies the last name of the contact. If also the last_name is provided then the last_name is used.
<number>		Specifies the number of the contact. The minimal required parameter is number, all other parameters are optional. Apart from those available
<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.
<number_type>	<empty> sip mobile fixed home business	Specifies the number type of the contact <number>.
<photo>	Photo, Base64 Encoded	You have to encode a photo first to base64 (For example here online) and paste it to the XML File.
<action_url>	valid URL	Specifies the action URL that is requested when the phone receives or places a call from/to this contact.

Creating and provisioning a contact with more than one number

In order to provision the local directory with contacts that contain more than one number, certain attributes have to be configured in order for the extra numbers to be properly recognized.

Contact with more than one number

<tbook e='2'>
<!--First contact -->
<item context='' type="MASTER" fav="false" mod="true" index="0">
    <name>Contact A</name>
    <number>0123456789</number>
    <number_type>sip</number_type>
    <first_name>First Name</first_name>
    <last_name>Family Name</last_name>
	<title>Title</title>
    <organization>Organization</organization>
    <email>E-Mail</email>
    <note>Note</note>
    <action_url>http://action.url:80</action_url>
    <group>work</group>
</item>
<item context='' type="none" fav="false" mod="false" index="1">
    <number>0123456789</number>
    <number_type>home</number_type>
    <first_name>Member_Alias</first_name> <!--Must be "Member_Alias" --> 
    <last_name>0123456789</last_name> <!--Must be the MASTER <number> -->
</item>
<item context="active" type="vip" fav="false" mod="false" index="2">
    <number>909090</number>
    <number_type>mobile</number_type>
    <first_name>Member_Alias</first_name> <!--Must be "Member_Alias" --> 
   <last_name>0123456789</last_name> <!--Must be the MASTER <number> -->
</item>

<!--Second contact -->
<item context='' type="MASTER" fav="false" mod="true" index="0">
	<name>Contact B</name>
	<number>0049287191</number>
	<number_type>sip</number_type>
</item>
<item context='' type="none" fav="false" mod="false" index="1">
    <number>0049287191</number>
    <number_type>home</number_type>
    <first_name>Member_Alias</first_name> <!--Must be "Member_Alias" -->
	<last_name>0049287191</last_name> <!--Must be the MASTER <number> -->
</item>
<item context="active" type="vip" fav="false" mod="false" index="2">
    <number>909091</number>
    <number_type>mobile</number_type>
    <first_name>Member_Alias</first_name> <!--Must be "Member_Alias" -->
	<last_name>0049287191</last_name> <!--Must be the MASTER <number> -->
</item>
</tbook>

Page tree

Local Phonebook - XML format