Adding the RESTful Application 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.
Verify User has RESTful API Setup
- Review the Wiki on User Management here. Making sure Rest API is enabled and selected for all modules for each user.
Map Applications to Phones
- Log into your Commercial End Point Manager and either create or edit a template for a supported device. In our example we are going to pick Aastra and edit our "Sample" template. For more information on using EPM please see this wiki. For the purpose of this wiki we will assume you know how to use the Commercial EPM and just cover how to add an application to a template.
- You can pick a phone model and setup a few buttons to be XML-API type. Next to the "Value" field will be a drop down of available RESTful Apps for you to choose from.
- When finished make sure to save your template and then map your devices to use this template in the Extension Mapping section.
- 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.
- Locate the RESTful Phone Apps Port.
- From here you can change the port to be something different if you would like. Do not forget to open your firewall for this port if you will have external phones connecting to the PBX and needing access to the RESTful Phone Apps. The phones will use this port when connecting to the phone apps.
Start the process script
After you have licensed Phone Apps you need to start the demon that watches for hints the first time as this can not be started when their was no license. This script will be auto started anytime amportal start is run which includes on boot up.