Automatic Teleworker Provisioning

To simplify the deployment of SIP teleworker phones, the MCS can use an API on the MBG to automatically provision SIP Users for SIP extension. This provides the following benefits:

• The default random credentials created on the MiVO 250 for each SIP extension can be passed to the MBG automatically
• The MCS can use randomly generated set-side credentials for teleworker phones
• There is no need to re-type the authorization credentials into MCS and the MBG, removing a repetitive and time consuming task and reducing the risk of mistakes
• The engineer/administrator deploying the teleworker phone does not need to know the SIP authorization credentials at any stage

Enabling the Rest API for Automatic Teleworker Deployment

For the MCS to be able to communicate with the MBG and deploy teleworker SIP Users, it requires some connection information as well as a valid API token from the MBG. This section documents how to configure the MBG to accept API requests and the steps involved in setting up the token exchange. To complete this process, access to the MBG website and the MCS configuration website are required.

Step 1: Create a new web service consumer on the MBG:

• On the MBG 'Administration -> Web services' page, press 'Start' to enable web services then press 'Add a new consumer' and provide the following information:
  • Active = Yes
  • Name = MiVoice Office Application Suite
  • ConsumerID = MiVOAppSuite
  • Permissions:
    • Base/managetoken = Read/Write
    • MBG/v1/icps = Read
    • MBG/v1/devices = Read/Write
• Make a note of the shared secret then save the new consumer.

Step 2: Complete the token request from MCS to MBG:

• On the MCS 'Configuration -> Site Settings -> Phone Systems -> MiVoice Border Gateway' page:
  1. Check the 'Enable Rest API' box.
  2. Press the 'Request Access Token' button to load the 'Request Access Token' form.
  3. Enter the Name, Consumer ID and Shared Secret to match those created on the MBG in step 1
  4. Press the 'Save & Test API Credentials' button to initiate a token request with the MBG server.
• On the MBG 'Administration -> Web services' page:
  1. Locate the 'Temporary tokens' section at the bottom of the page
  2. Press the 'approve' button against the temporary token request.
  3. Highlight and make a copy of the 'Verifier' code (you may need to refresh the page to see the temporary token)
• On the MCS 'Configuration -> Site Settings -> Phone Systems -> MiVoice Border Gateway' page:
  1. Paste or enter the verifier code into the request window
  2. Press the 'Retrieve Final Access Token' button to complete the token request with the MBG server.

If the verifier is correctly entered, the MCS should be able to successfully request an API token from the MBG. This token will allow the MCS to provision SIP Users on the MBG for a period of 12 months. To avoid having to repeat the above process every 12 months, the token's expiry date can be extended on the MBG by pressing the 'Renew' button against the token in the 'Final tokens' section of the web services page.