Page tree

Versions Compared


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


  1. Review the User Management Module User Guide for full details on the User Management module which includes the ability to enable Rest API users.  Below we will cover just the needs for the Rest API 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 access
  4. Navigate to the REST API Section

  5. Make sure the user is enabled for REST API. 
    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.
  6. Make sure the User is linked to which extension we want the RestAPI to be used with.

  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

  8. You 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.

  9. Save you changes


  1. Log into your commercial End Point Manager (EPM) and either create or edit a template for a supported device. In our example, we are going to pick Sangoma Brand. For the purpose of this wiki, we will assume you know how to use the commercial EPM, and we will only cover how to add an application to a template. For more information on how to use the commercial EPM, please see the End Point Manager wiki.

  2. Click on the template in End Point Manager that you want add Applications for.
  3. Scroll to the bottom of the template and select a model number you want to add a Intercom Button for.
  4. Scroll down the your first available Line Key that is not used

  5. From the Drop Down of button types pick XML-API

  6. You can optionally change the label name to be something different then Parking if you want.  The Label is the name that will be shown on your Phone Screen for that button.

  7. You can now drag the button to be in a different spot. In our example we will drag Button 21 that we just setup as a Intercom button up toward the top to make it button 4 on the phone.  Left click on the button and while holding down your left mouse drag the button to a different spot and release it.
  8. Save the Model using the 

  9. If you go back into the model number it will show Intercom as button 4 now.
  10. We now need to update the phone config.  Our 3 options at the bottom of the template are
    • Save Template- This will only save your changed into the PBX Database but will not write out new config files for the phones that are using this template as mapped in Extension Mapping section of End Pint Manager.
    • and Rebuild Configs- This will save your changes to the PBX Database and will also write out new config file for the phones that are using this template as mapped in Extension Mapping section of End Pint Manager but the phones will need to be rebooted for it to retrieve the changes.
    • and Force Update- Will do both the Rebuild Configs option above but also update any phones that are mapped to use this template and currently registered to the PBX immediately with no need to reboot the phones.



Open the RESTful Phone Apps Port if Using External Phones