Custom Phone Applications with Asterisk

Sangoma D-Series phones support loading and running user-created custom JavaScript applications. Fore more information about creating these applications, and the endless possibilities therein, please see the Getting Started page on our Digium Phone API Center website.

...

Custom applications may only be loaded onto phones running firmware version 1.3+. Phone firmware 1.3 is now generally available, For information about setting up your phone for application development, see the Getting Started page.

Custom Applications and DPMA

Custom applications are always defined with an application type of "custom" and are loaded onto phones using the phone type option application, just as a queue or status application would be loaded onto a phone. This application type is supported by DPMA, beginning with DPMA version 1.3.0.

Example

In this example:

• An application named Jason-Fancy-App is declared, it's of the Custom application type

• The internal name of the application is jasonapp

• The filename of the application, as retrieved from the file_url_prefix is jasonsillyapp.zip

• The application will start when the phone boots

• Custom keypairs for 'user=1234', 'permission=lots', 'string=hello world' are passed in

...

Example of custom application accessing custom key value pairs

// Get all settings
var app_config = app.getConfig();
 
// Assign values of the custom keys to variables
var myuser = app_config['settings']['user'];
var mypermission = app_config['settings']['permission'];
var mystring = app_config['settings']['string'];

Interacting with Asterisk

...

When a method has been registered, phone applications can use the pbx.request function to call that method and pass parameters into Asterisk. Here's an example:

pbx.request({
        'method' : 'digium.qwelltest.okay',
        'parameters' : {
            'account_id' : app.getAccountId()
        },
        'onSuccess' : function (p) {
            util.debug(JSON.stringify(p));
            win[0][1].label = p.result.foo.bar;
 
            var now = new Date();
 
            setTimeout(function() {request(win, visiblePredicate);}, 5001 - now.getMilliseconds());
        }.bind(this)
    });

In this example, we pass the method digium.qwelltest.okay with the parameter account_id and a fictitious value derived from app.getAccountID()

...

When a notification is pushed from Asterisk into the phone, the notification can be read from the phone's application by using the digium.event.observe handler, such as:

digium.event.observe({
    'eventName' : 'digium.qwelltest.bacon',
    'callback' : function (params) {
        util.debug(JSON.stringify(params));
    }
});

Custom Applications and XML Provisioning

...

 Appconfig Element Example

url: Child Element of <appconfig>

settings: Child Element of <appconfig>

auto_start: Child Element of <appconfig>

...

Custom applications can be loaded onto Sangoma phones within FreePBX using the "Custom" applications sub-tab of the "Applications" tab of the Sangoma phones FreePBX configuration utility.  For details on this, please see this wiki page.

Frequently Asked Questions (FAQ)

...