Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.



Adding the RESTful Application ("REST App") Phone Apps to a device requires that you have the RESTful Application Phone Apps module installed along with a valid license. To purchase the RESTful Application Phones Apps 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.

titleSangoma Phone Notice

If you are using a Sangoma s500 or s700 phone you will not need to purchase the Phone Apps module or End Point Manager Module as these modules will work with Sangoma Phones out of the box with no license purchasing needed.


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

Table of Contents



Make sure you have the following versions installed

  • Phone Apps on version 13.0.9 or newer
  • End Point Manager on version 13.0.39 or newer
  • User Management on version 13.0.57 or newer

Verify Phone Apps is Enabled for the User

  1. Review the User Management Module User Guide for full details on the User Management module which includes the ability to enable Rest API Phone Apps for users.  Below we will cover just the needs for the Rest API Phone Apps user section of User Management that we need to enable for Phone Apps to work.
  2. Navigate to your User Management module on your PBX.

  3. Edit a user that you want to enable for RESTful API Phone Apps access to.
  4. Navigate to the REST API Phone Apps Section
    Image RemovedImage Added

  5. Make sure the user is enabled for REST API. Phone AppsYou can optionally change the default Rate Limit which is how many times they can interact with the REST API server per hour. 1000 request per hour should be sufficient for most users.
    Image Removed
    1. Either set this option to Yes or if set to Inherit verify the Group that the User belongs to has the permissions set to Enabled under Group Permissions of User Management.
      Image Removed
  6. Make sure the User is linked to which extension we want the RestAPI to be used with.
    Image Removed
  7. Verify the user has permissions to all the modules since the Phone Apps use the REST API we need to give this user access to ALL the RestAPIs
    Image Removed
    1. Image Added
  8. You can also pick which phone apps and restrictions from within each app.
    Image Added

  9. Save you changes