| Table of Contents | ||
|---|---|---|
|
Digium phones when used with DPMA
SIP Configuration
Configuration of a phone via the Digium Phone module for Asterisk alone is not enough to enable calling between the phone and Asterisk. As with any SIP device that connects to Asterisk, each Digium phone needs a corresponding entry in Asterisk's SIP configuration. Further, use of DPMA assumes that out-of-call MESSAGE support has been enabled, and will require some specific "general" section parameters.
chan_pjsip
For chan_pjsip, a number of different types are configured, notably a transport, an aor, an auth, and an endpoint. The endpoint is the entity referenced in the DPMA for line configuration. A minimum pjsip.conf entry for a Digium phone then would look like:
...
| No Format | ||
|---|---|---|
| ||
[global] type = global default_outbound_endpoint = dpma_endpoint [dpma_endpoint] type=endpoint |
chan_sip
For chan_sip, Asterisk provides two types of entities within SIP: peers and friends. Use of either type is permissible, when configuring a Digium phone; however, use of the peer type means that Asterisk will not correctly match incoming calls where more than one SIP identity is assigned to the same phone (IP address). General practice then means that the friend type is the most flexible - as it matches on the From: username, whereas peer matches on IP and port (unless insecure=port has been set).
...
| Info |
|---|
1.0.0-beta1 versions of res_digium_phone.so require that outofcall_message_context be set to phone_context. Versions after 1.0.0-beta1 default to dpma_message_context. If phone applications and provisioning are not working properly, please check the setting of outofcall_message_context. |
Voicemail Configuration
All Digium Phones are provided with a Msgs hard button which calls the Voicemail application (visible in the list of Applications on the phone as well). When a Digium phone is not connected to the Digium Phone module for Asterisk, the Voicemail application simply dials a SIP URI, as configured, like any other SIP phone. However, if the Digium phone is connected to DPMA and Asterisk is correctly configured, then the Msgs button will instead load a Visual Voicemail application that provides an enhanced user experience.
To configure Asterisk correctly, simply ensure that a mailbox entry in Asterisk's Voicemail configuration (voicemail.conf) matches the mailbox configuration parameter for a Digium Phone in res_digium_phone.conf, e.g.:
voicemail.conf
| No Format | ||
|---|---|---|
| ||
[fancycontext] ; The voicemail context name 100 => 12345,Bob Bobby,[email protected] ; The mailbox, its password, the person's name, and their e-mail address |
res_digium_phones.conf
| No Format | ||
|---|---|---|
| ||
[MyPhone] ; The identifier type=phone ; A phone [email protected] ; Sets mailbox to mailbox 100 in the fancycontext of voicemail.conf ; Other Phone options, not the following fake ones, go here phoneoption=value phoneoption2=othervalue |
Parking
When used in combination with DPMA, Digium phones provide both a parking application as well as one-touch parking. The parking application allows the phone to retrieve a list of all parking lots present on the Asterisk server, along with the calls that are currently parked in each lot. From this list then, a phone may retrieve any parked call. The one-touch parking feature is a softkey on the phone's display that appears when a call is connected. The softkey transfers the connected call (attended or blind) to whatever parking lot extension the phone is configured to use.
...
In blind transfer mode, the default, once a park is completed, the phone will display a text message on its screen, indicating the lot number in which the call was parked, and the phone will hang up. One may then use the phone's Parking application to browse and directly retrieve a parked call.
res_parking.conf
Asterisk enables call parking by default with the res_parking.conf parameters:
| No Format | ||
|---|---|---|
| ||
parkext => 700 ; The extension to dial to park calls parkpos => 701-720 ; The extensions onto which calls are parked context => parkedcalls ; The default parking lot context |
res_digium_phone.conf
The corresponding res_digium_phone.conf configuration parameters are:
| No Format | ||
|---|---|---|
| ||
parking_exten=700 ; The extension to program the phone to dial when a call is parked using the park softkey parking_transfer_type=blind ; The type of parking to perform, blind or attended. |
BLF Subscription to a Parking slot
BLF keys on phones are commonly tied to slots in Parking Lots, such that when a caller is waiting in a particular slot, e.g. 701, the lamp for a BLF tied to that parking slot is lit and the user may press the BLF button to retrieve the parked call from the lot.
...
| Note |
|---|
If parking_exten is not configured for a Digium phone, then DPMA will not enable the one-touch parking feature of the Digium phone. |
Dialplan hint
An example dialplan hint for watching status of a parking slot is:
...
| No Format | ||
|---|---|---|
| ||
include => parkedcalls exten => 701,hint,park:[email protected] |
Contacts subscribe_to URI
An example contacts XML file subscribe_to URI for watching parking slot 701:
| No Format | ||
|---|---|---|
| ||
subscribe_to="sip:[email protected]" |
Handling multiple parking lots
Beginning with the 1.4 release of DPMA, Digium phones can be explicitly told which lots, inside of the Parking application, to present to the user. This is accomplished with the new "parking" phone application type within the DPMA configuration. Presented here is an example of configuring three phones, A, B, and C, to view one (A and B) or multiple (C) lots. Note that the Park softkey must still be mapped to park within a single lot only.
...
Thus, Phone A has a softkey that transfers to 800 and it can see other people parked in the "Sales" lot.
Phone B has a softkey that transfers to 850 and it can see other people parked in the "Support" lot.
Phone C has a softkey that transfers to 800 and it can see people parked in either lot.
Call Recording
When used with DPMA, Digium phones can perform one touch call recording. Enabled in res_digium_phone.conf by the record_own_calls phone configuration parameter, one touch call recording presents a "Record" softkey on the phone's interface whenever the phone is on a call. If activated by the user, Asterisk begins recording both legs of the current call at the server-side and the softkey changes to "Stop Record." Pressing the "Stop Record" softkey directs Asterisk to cease recording the call, and the softkey returns to the "Record" state. Pressing the softkey again at this state will initiate a second, and separate recording session.
Recorded calls are stored by Asterisk in the Cust5 voicemail folder. This folder may be accessed directly by dialing the standard Asterisk voicemail application or by pressing the "Msgs" key on the phone, browsing to the folder list and selecting the "Recordings" folder. The "Recordings" folder, as presented by the Messaging application is mapped directly to the Cust5 folder by DPMA. Recorded calls may be listened to, moved to other folders, or forwarded to other users on the system.
Call Queues Application
Digium phones, when used with DPMA, have a built-in Queues application that allows for interaction with Asterisk's app_queue queue application. The Queues application on the phone is configured in the phone configuration section of res_digium_phone.conf by applying a queue application type to the configuration. The queue application has a number of parameters to control the queue, the member's name, the member's location, permission level, and login/out extensions.
...
| Note |
|---|
In order to view the on call duration for Members when using the Details-level permission, the Queue must be configured with the setinterfacevar=yes option in queues.conf. |
User Presence
When used with DPMA, Digium Phones are capable of seeing both device status and user presence. Device status is simply the device state one can subscribe to over SIP SUBSCRIBE, that maps directly to a hint in the diaplan. User presence is an entirely new concept to Asterisk, and expands upon the usage of dialplan hints, allowing them to represent both device state and user presence at the same time. Digium Phones not connected to DPMA are capable of only Available and DND (Phone returns 486 to Asterisk) status. Digium Phones using DPMA are capable of much more, with a Status application that allows users to change their presence on the server, opening up new methods for call routing based on user-presence, and not merely device presence.
Defining User Presence in Asterisk
The fundamentals of how user presence is represented in Asterisk mirrors the concepts currently used with device state. Device state changes are triggered by device state providers.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
A hint for extension 1111 is mapped to both the PJSIP endpoint 1111 device state provider and the CustomerPresence:1111 user presence provider. Endpoints subscribing to hint 1111 will receive both device state and user presence notifications for extension 1111. exten => 1111,hint,PJSIP/1111,CustomPresence:1111 exten => 1111,1,Dial(PJSIP/1111) |
Manipulating User Presence through Dialplan and AMI
PRESENCE_STATE() Dialplan Function
User presence information is modified through the use of the PRESENCE_STATE() dialplan function. This function allows a custom user presence provider's information to be both read and written via the dialplan and AMI.
Write Syntax
| Code Block |
|---|
PRESENCE_STATE(<presence state provider>)=value[,subtype[,message[,options]]] |
...
| Code Block | ||
|---|---|---|
| ||
e: Both subtype and message fields are base64 encoded. This is necessary for complex strings containing commas and newline characters. When this option is used, the PRESENCE_STATE function knows it must first base64 decode the subtype and message fields before setting them on the CustomPresence provider. |
Read Syntax
| Code Block |
|---|
STATE_VALUE = ${PRESENCE_STATE(<presence state provider>,field[,options])}
|
...
| Code Block | ||
|---|---|---|
| ||
e: Base64 encode the return value when the field argument is subtype or message. |
Dialplan Examples
Dialplan Write Examples
Example1: Set Batman's state to "Away" with the subtype "In the batcave" with the message, "Making a new batch of batarangs".
...
| Code Block |
|---|
Set(PRESENCE_STATE(CustomPresence:Blah)=away,${BASE64_ENCODE(business)},${BASE64_ENCODE(I will visiting clients in the San Diego area.\nI will be returning on Oct 11th.\nCall Josh for emergencies)})
|
PRESENCE_STATE Read Examples
SUBTYPE
No Format ${PRESENCE_STATE(<presence state provider>,subtype)}
...
BASE64_MESSAGE
No Format ${PRESENCE_STATE(<presence state provider>,message,e)}
AMI Examples
Example1: Setting both the user state and message using SetVar action in conjunction with PRESENCE_STATE() dialplan function.
...
| Code Block |
|---|
Action: Getvar ActionID:1234 Variable: PRESENCE_STATE(CustomPresence:Batman,subtype,e) Action: Getvar ActionID:1234 Variable: PRESENCE_STATE(CustomPresence:Batman,message,e) |
User Presence in DPMA
DPMA does all of the user presence manipulation of the CustomPresence providers behind the scenes. Phones subscribe to a set of user extensions to receive both device state and user presence updates. DPMA is in change of defining the hints the phones subscribe to, and mapping those hints to the correct device state and presence state providers. When a phone user updates their user presence, DPMA internally updates that user's CustomPresence provider to reflect the change using the PRESENCE_STATE() dialplan function. This results in any watcher of the hint mapped to that CustomPresence provider receiving an update indicating the new user presence.
DPMA Read Status Diaplan Example
In this example, the User Presence of device 100 is evaluated for the dnd and the xa (Extended Away) status. In the event that either of those statuses is true, the dialplan will route to the "dnd" label. In the even that both are false, the dialplan will route to the "notdnd" label.
...