Digium Phones provide a Contacts application that integrates speed-dial, device busy-lamp field and user presence. The Contacts application is related to the Status application in that both are concerned with presence. The Status application is concerned only with setting the local user's presence. The Contacts application is concerned with the presence status of other users - those to which it's been programmed to subscribe.
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.
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:
as noted above. Multiple "contact" lines may be used for each phone configuration. For XML configuration, Contacts files are specified using the <contacts> element.
Rapid Dial Keys
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.
Contacts XML skeleton
A basic Contacts XML structure is defined here:
And, a more fleshed-out example looks like:
Defines the name of a contacts group. This name is used in the Contacts application to organize contacts by group
Unique identifier for a group
Contact: Child Element of <contacts>
|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 are subscribed to for device and user presence, 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.|
Email: Child Element of <email>
The e-mail address of the contact
A description of the e-mail address, e.g. "Work" or "Home"
Sets an email as the primary e-mail for a contact. Only one primary email per contact is permissible.
Action: Child Element of <actions>
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.
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
Headers: Child Element of <actions>
Header: Child Element of <headers>
Key value of the header applied to the action
optional, value to be matched with the key, may incorporate wildcard values
Wildcard Variables can be used in Action Headers as part of the "substitute_value" of a Header. The following variables are allowed:
- %_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.
Whereas actions are tied to BLF keys using the Smart BLF capabilities, allowing differing functions depending on the state of the phone and/or of the target phone, Display Rules allow selective display of actions within the Contacts application also depending on the state of the phone and/or of the target phone. A common scenario for this is the display of Intercom or Monitor actions. When a contact is idle, it is reasonable that a user's phone might have an action to Intercom that contact, but might not have an action to Monitor that contact - if the contact isn't on a call, there's no reason to try to barge into a non-existent call. And, while that same contact is on the phone, it is reasonable that a user's phone might have an action to Monitor that contact - if the contact is already on a call, it's not necessarily a good idea to Intercom their phone.
Display Rules are configured using an XML fragment. For DPMA users, the fragment is loaded from the file_directory as specified by the contacts_display_rules phone option. XML configuration users may simply append the display_rules child node to the "contacts" appconfig.
Display Rules XML Example
Display Rules are parsed top down. and act as a black list. Unless an action_id is present here, it will displayed at all times. A way to show an action in only one state is to set it's show=0 then take that same action and show=1 in a specific state.
Display Rules Configuration
|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.