Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated for 13

titleThis wiki has been updated for Version 13 of your PBX GUI

Commercial Module

Adding the RESTful Application ("REST App") to a device requires that you have the RESTful Application module installed along with a valid license. To purchase the RESTful Application module, please see this wiki on how to Purchase Commercial Modules. You will also need to make sure you have a valid Commercial End Point Manager module and the Free Commercial RESTful API module installed.

Once all the above requirements are met, you can go through the below setup.

Table of Contents





is Enabled for the User

  1. Review the Wiki on User Management hereModule User Guide for instructions on enabling Rest API for a user. Make sure Rest API is enabled and selected for all modules for each user.  you have enabled the desired Rest Apps for the user.

Map Applications to Phones

  1. Log into your Commercial commercial End Point Manager Manager (EPM) and either create or edit a template for a supported device. In our example, we are going to pick Aastra and edit our "Samplesample" template. For more information on using EPM please see this wiki. For  For the purpose of this wiki, we will assume you know how to use the Commercial commercial EPM, and we will only cover how to add an application to a template.
    Image Removed
    You can pick a phone model and setup a few buttons to be the XML-API type. Next to the "Value" field will be a dropdown menu of available RESTful Apps for you to choose from.
    Image Removed
    When finished make sure to save your template, and then map your For more information on how to use the commercial EPM, please see the End Point Manager wiki.
    Image AddedImage Added

  2. Select a phone model in order to edit its button configuration. In our example we'll pick the 53i.
    Image Added

  3. To program a button for a Rest App:
    1. In the Type drop-down, select XML-API.
    2. In the Value drop-down, select one of the available Rest Apps.
      Image Added

  4. When finished, click the Save Model button.
    Image Added 
  5.  Click the Save Template or the and Rebuild Configs button.
    Image Added 
  6. Finally, be sure to map devices to use this template in the Extension Mapping section.
     Image Added

Open the RESTful Phone Apps Port if Using External Phones

  1. If your phone is external from your PBX, and your PBX is behind a firewall, you will need to open the RESTful Apps port. To do this, go into the System Admin module and click on the Port Management section.
    Image RemovedImage Added

  2. Locate the RESTful Phone Apps Port port.
    Image RemovedImage Added 
  3. From here you Optional: You can change the this port if you would like. If you change it, click the Update Now button to save the changes.
    Image Added

  4. Do not forget to open your firewall for this port if external phones will connect to the PBX and need access to the RESTful Phone Apps. The phones will use this port when connecting to the phone apps.


  1. After you have licensed Phone Apps, you need to start the demon that watches for hints the first time, as this could not be started when there was no license.  This This script will be auto-started any time amportal start is run, which includes on boot up.  

    /etc/init.d/restapps restart 

    Code Block
    [root@mybox ~]# /etc/init.d/restapps restart
    Shutting down REST applications daemon:                    [FAILED]
    Starting REST applications daemon:                         [  OK  ]
    [root@mybox ~]#