Skip to content

Contacts#

Default contacts.xml#

contacts.xml
1
2
3
<?xml version="1.0" encoding="utf-8"?>
  <contacts version="1.6.0">
  </contacts>

Commented File-structure#

contacts.xml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?xml version="1.0" encoding="utf-8"?>
  <!-- List of all local contacts and contacts with extensions
       type: list -->
  <contacts version="1.6.0">
    <!-- a local contact
         parameters:
           uuid: primary key
               type: string -->
    <contact uuid="47297d7a-bb53-4d65-b77f-65fb584cc8f5">
      <!-- The name of the contact
           type: string -->
      <name>Name of Contact</name>
      <!-- A phone number entry
           type: string -->
      <number>0123456789</number>
      <!-- Contact source
           type: enum
             accepted values:
                local
                mobile
                ldap
                google
                ews
                outlook (since 1.6.0) -->
      <extensionOf>ldap</extensionOf>
      <!-- The contact is starred, if it is a favorite contact
           type: boolean -->
      <starred>true</starred>
      <!-- Whether or not to issue a sip-subscription for the contact          
           type: boolean -->
      <dialogSubscription>true</dialogSubscription>
      <!-- Whether or not to signal presence states of the contact         
           type: boolean -->
      <presenceSubscription>true</presenceSubscription>
      <!-- Type of Number
           type: enum
             accepted values:
                mobile
                work
                home
                fax
                other (custom label, see <customNumberLabel>)
                door (since 1.6.0, enables the door functions below)
                suffix (since 1.6.0, only inside <additionalNumbers>) -->
      <phoneNumberType>home</phoneNumberType>
      <!-- Photo for the contact
           type: string -->
      <uri>http://example.org/contact_icon_user1.jpg</uri>
      <!-- Name of custom number type (only for <phoneNumberType>other</phoneNumberType>)
           type: string -->
      <customNumberLabel>Family</customNumberLabel>
      <!-- Address from which the camera images are obtained, with username and password if necessary.
           type: string -->
      <videoFeed>http://username:password@ip_address/path_to_the_video_stream</videoFeed>
      <!-- MJPEG format, only if you experience display problems
          type: boolean -->
      <useMjpegPlugin>true</useMjpegPlugin>
      <!-- Function code that opens the door (since 1.6.0).
           Only evaluated for <phoneNumberType>door</phoneNumberType>.
           Either a DTMF sequence (digits, * and #), which is sent during
           the call, or an http(s) URL, which is called with a GET request.
           type: string -->
      <doorAction>#9</doorAction>
      <!-- Function code that switches on the door light (since 1.6.0).
           Same format as <doorAction>.
           type: string -->
      <doorLightAction>#8</doorLightAction>
      <!-- Additional phone numbers of the contact (since 1.6.0)
           type: list -->
      <additionalNumbers>
        <labeledPhoneNumber>
          <!-- A phone number entry
               type: string -->
          <number>0123456780</number>
          <!-- Type of Number, see <phoneNumberType> above
               type: enum -->
          <type>work</type>
          <!-- Name of custom number type
               (only for <type>other</type>)
               type: string -->
          <label>Reception</label>
        </labeledPhoneNumber>
      </additionalNumbers>
      <!-- The app also writes imagePath and extensionOfId to a contact.
           They reference the cached avatar file and the synced contact this
           entry extends, and are not intended to be provisioned. -->
    </contact>
  </contacts>