Contacts without presence subscriptions may be loaded locally onto the phone by the phone's user; however, this is not recommended. Most deployments of Digium phones will see the administrator specifying XML lists of contacts to load onto phones. Here, we will discuss the methods to direct the phone to load contacts as well as the contents of the contacts XML files.
Beginning with the DPMA 1.3, Digium phones can support storing phone-added contacts on the Asterisk server. To support server-side storage of contacts that are added, by the user, locally on the phone, the editable option for a phonebook must be set to 1 and an identifier, as set by the id option must be unique for the phonebooks loaded by that phone.
Though it is possible to add server-side contacts from the phone, those contacts are not editable from the phone, deletable from the phone, or configurable with a subscription URI. Digium thus advises that the best practice is to only edit contacts from the server side, not from the phone.
Loading a Contact List
Contacts files that the phone should load are separate files, defined by DPMA or configured in the phone's main configuration XML file. For DPMA, Contacts files are specified for a phone configuration using the phone configuration parameter:
Rapid Dial, or BLF, key subscriptions are set using the phone configuration parameter:
This parameter, whether configured in res_digium_phone.conf for DPMA or in the blf_contact_group setting in XML, must be set to the group_name of the contacts group for which you wish subscriptions to be made. Subscriptions cannot be made to more than one group_name. Subscriptions will not be made if the blf_contact_group parameter is undefined. If you have skipped this step, you will not have blinking lights. The use of Smart BLF capabilities is not independent of this setting; this setting must still be used for deployments using Smart BLF BLF Items lists.
If the Smart BLF capabilities of the phone are being used, whereby a BLF Items sheet is being loaded onto the phone, then each and every contact to be placed on a Rapid Dial key must be explicitly defined. If no BLF Items sheet is loaded onto a phone, as-is the case with phones using firmware prior to 1.4.0, then the order of the contacts in this group is important. In that case, the named contacts here fill in the BLF-keys in the same order as given in the xml, and those contacts are subscribed to, in order.
<phonebooks> <contacts group_name="PBX Directory" editable="0" id="0"> <contact server_uuid="abcdefg123" id="104" prefix="Mr" first_name="Robert" second_name="Davis" last_name="Jones" suffix="III" contact_type="sip" organization="Digium" job_title="Direction Manager" location="East Texas" notes="A rapscallion" account_id="104" subscribe_to="sip:firstname.lastname@example.org" picture="https://server.example.com/photos/myphoto.png" pickup_action="my_pickup_action" > <emails> <email address="email@example.com" label="Work" primary="1" /> </emails> <actions> <action id="primary" dial="104" dial_prefix="800555" label="Extension" name="Office" /> <action id="send_to_vm" dial="104" dial_prefix="" label="Voicemail" name="Dial Voicemail"> <headers> <header key="X-Digium-Call-Feature" value="feature_send_to_vm" /> <header key="Diversion" value="<sip:%_ACCOUNT_USERNAME_%@%_ACCOUNT_SERVER_%:%_ACCOUNT_PORT_%>;reason="send_to_vm"" /> </headers> </action> <action id="my_pickup_action" dial="104" dial_prefix="**" label="Pickup" name="Pickup" /> </actions> </contact> </contacts> <contacts group_name="Default" editable="1" id="Default"> .... </contacts> <contacts group_name="Family Members" editable="1" id="anythingyouwant"> .... </contacts> </phonebooks>
Defines the name of a contacts group. This name is used in the Contacts application to organize contacts by group
Sets whether or not the group can be editable from the phone. If the phone is configured for server-side contacts storage and the editable option is set for a group, a contact may be added to that group from the phone
Unique identifier for a group
|server_uuid||string||Optional. Specifies the uuid of the server to which this contact is attached. If this is a contact on a DPMA-enabled server, this should be the same as the server_uuid of that server. If server_uuid is set for contacts, it must also be set in the DPMA general section. If it is only set in one location (contact or general) instead of both, forwarding of voicemails to contacts is not permitted.|
Sets a unique identifier for the contact, used by blf_item definitions
Sets the prefix title for a contact, e.g. "Mr."
Specifies the first name for a contact
Specifies a second name for a contact
Specifies a final name for a contact
Sets a suffix for a contact, e.g. "Jr."
sip, special, zap, virtual and many more
Specifies the type of contact. SIP contacts can be are subscribed to for device and user presence (when DPMA is in use), so this type should be used for DPMA-configured contacts. Special contacts are subscribed to for device presence only, so this type should be used for all other contacts that require any state awareness. Zap contacts are Switchvox-configured DAHDI-based contacts. Virtual contacts correspond to Switchvox virtual extensions. A full listing of contact_types may be found here - http://developers.digium.com/switchvox/wiki/index.php/Extension_Types
Sets an organization for a contact
Specifies a job title for a contact
Sets a location for a contact, e.g. "Las Vegas"
Allows for provision of notes about a contact
If the contact is associated with a contact local to the system, the PJSIP endpoint name for a contact
If the contact is to have a SIP subscription associated with it, the SIP URI. The SUBSCRIBE will only be made, even if this parameter is populated, if the group_name of this contact's group matches the blf_contact_group phone setting - as defined in res_digium_phone.conf or in the phone's XML config.
|picture||URL||Specifies the location of the picture for the contact|
|pickup_action||string||Specifies the action to be called for call pickup activity cards on the D80.|
Make sure to include definitions for both first_name and last_name in your contacts XML file, even if one of them is to be blank. Failure to do so will lead to irregular sorting inside the phone's Contacts application.
For SIP endpoints that are attached to a DPMA-configured Digium phone, the subscribe_to parameter should point to a special hint automatically created by DPMA. This hint is in the format "auto_hint_<peer>," e.g.:
In this case, it is not necessary to create a dialplan hint, as it is automatically created by DPMA.
For non-DPMA-configured endpoints, no "auto_hint" is created, and subscriptions should be a normal SIP URI that is provided by the target system, e.g..:
or, simply to an extension, where the phone will automatically subscribe to the registered server, e.g.:
Also, when DPMA is not used, it is necessary to create a dialplan hint, e.g.:
Users of DPMA with older versions of Asterisk, or chan_sip instead of chan_pjsip, should note that the callcounter sip.conf parameter is necessary.
mandatory, unique identifier for the action, used by blf_item definitions. One id with the reserved name "primary" should be used for each contact, to designate the primary action, that occurs when no other action is matched.
Magic action ids "intercom," "monitor," "sendtovm" and "dial_vm" will result in special icons displayed for the action.
optional, number, e.g. 1234, or URI like sip:host or sip:user@host, to be passed to the phone application and dialed for this action
optional, number to be prepended before dial, where be passed to the phone application and dialed for this action
optional, identifier for an application to which events or functions are sent. The identifier should be either one of the phone default applications (contacts, voicemail, parking, status, queues) or should be the identifier of a user-loaded custom application.
mandatory, pertinent information about the number for the Contacts application, e.g. SIP Extension, Cell; appears to the left of the number or application within the contact's information screen
mandatory, a name for this action, used as its language key within applications, e.g. custom applications; appears to the right, in square brackets, of the number or application within the contact's information screen
- %_ACCOUNT_USERNAME_% - The username of the account that is performing the action.
- %_ACCOUNT_SERVER_% - The server host of the account that is performing the action.
- %_ACCOUNT_PORT_% - The server port of the account that is performing the action.
- %_ACCOUNT_TRANSPORT_% - The transport used for SIP traffic on the account performing the action.
- %_ACCOUNT_ID_% - The unique account ID.
- %_ACCOUNT_AUTHNAME_% - The authentication string for the account.
- %_ACCOUNT_LINE_LABEL_% - The line label for the account.
- %_ACCOUNT_CALLER_ID_% - The caller ID string for the account.
- %_ACCOUNT_OUTBOUND_PROXY_% - The outbound proxy for the account.
- %_ACCOUNT_OUTBOUND_PORT_% - The outbound port for the account.
- %_ACCOUNT_ALT_SERVER_% - The alternate server for the account.
- %_ACCOUNT_ALT_PORT_% - The alternate port for the account.
- %_ACCOUNT_ALT_TRANSPORT_% - The alternate transport for the account.
Beginning with phone firmware 1.4, the Contacts application works in concert with the Smart BLF functionality provided by the rapid dial keys. As actions are assigned to a contact, those actions are, by default, displayed when viewing the contact's information.
|id||unique id||A unique identifier for this display_rule, e.g. 0, 1, 2, etc.|
|action_id||A valid action as defined in the phone's Contacts file||Sets the action_id for the display rule to act upon|
|phone_state||idle, hold, transfer, incoming/transfer, incoming, connected, dialing, calling, failed||Defines the state of the local phone during which the rule will be acting. If not specified in a rule, all states are matched. Note that this list of states differs from the larger list of states available for BLF key action mappings.|
|target_status||unknown, idle, on_hold, ringing, on_the_phone, on_hold_ringing||Optional. Sets the status of the subscribed to contact that must be matched for this display rule to be in effect|
|show||Boolean||If set to yes, shows a particular action; if set to no, hides the action. To hide an action for all states and only show it for some states, first declare the action to have a false show, then declare it to have a true show for only a particular state or states.|
Digium phones have a Voicemail application that allows the forwarding of voicemails to a Contact. When a user engages the forward function from within the Voicemail application, the user is then presented with a filtered list of contacts to whom forwarding is possible. The filtered list of contacts is defined by the set of contacts that are contained on a server with the same server_uuid as the current phone, that are of the type 'sip', 'zap', or 'virtual,' and that have an account_id that matches the target voicemail box. Further, the receiving contact must also have a phone and line entry in res_digium_phone.conf.
Digium's D80 telephone can display pictures for contacts within its Rapid Dial application and Drawer as well as the picture for the phone's local user within the Navigation drawer. Pictures should be in PNG format, 150 pixels wide, and 200 pixels high. To find the local match the D80 will compare its own account_id from its account configuration to the account_ids of its loaded contacts for a match, and display the appropriate picture. The D80 will download and cache contact pictures and will only perform a new download if the URL of the picture changes.