How to setup xml api for RPS

Feature Introduction

1.Redirect Provisioning Server

A Redirect Provisioning Server(RPS) is a intermediate device that offers redirection service between Akuvox’s IP Phone and Auto provisioning server. User’s phone can obtain auto provisioning URL from Akuvox RPS, then download the common.cfg or MAC.cfg file from Auto provisioning server.

2.RPS API Protocol

The API of RPS is built as standard XML-RPC services, you can send XML commands via HTTP POST using content-Type: text/xml to modify the RPS information. User authentication is done via basic authentication using username and password.

3.Service URL

http://58.96.188.87/fcgi/do?id=1

4.User Accounts

To access the RPS, you should have a valid account to make the API commands to be effective, and the account is provided by Akuvox operator. If you have any questions please email to techsupport@akuvox.com

XML-RPC commands

1.redirect.registerDevice

You can register a specific device to the RPS by its MAC ID.

1.1XML-RPC signature

redirect.registerDevice(mac,serverName)

1.2Parameter

1. mac : MAC address you want to register to RPS.
2. serverName: The server name you have already added on RPS which the device should be registered to.

1.3Return values

1.4 Example

Request Notes
1. ”<![CDATA[ ]]>” also can be removed.
2. Four types of valid MAC address format are 0C1105002189, 0C 11 05 00 21 89, 0C-11-05-00-21-89, 0C:11:05:00:21:89.
Positive Answer

Negative Answer

2.redirect.registerDevice[2]

If the device you want to register has already registered before, you can confirm whether to override the previous information by “isOverride” parameter.

2.1XML-RPC signature

redirect.registerDevice(mac,serverName,isOverride)

2.2 Parameter

1. mac: MAC address you want to register to RPS.
2. serverName: The server name you have already added on RPS which the device should be registered to.
3. isOverride:Confirm whether to override the previous registration or not.
(1) 1:Override confirmation
(2) 0:Cancel registration

2.3 Return values

2.4 Example

Request Positive Answer Negative Answer

3.redirect.deRegisterDevice

You can remove a specific device from RPS by deregistering its MAC id.

3.1 XML-RPC signature

redirect.deRegisterDevice(mac)

3.2 Parameter

mac: MAC address you would like to remove from RPS

3.3 Return values

3.4 Example

Request Positive Answer Negative Answer

4. redirect.listDevices

You can list all the devices(MACs) that you have already registered.

4.1 XML-RPC signature

redirect.listDevices()

4.2 Return values

4.3 Example

Request Positive Answer Negative Answer

5. redirect.checkDevice

You can check if a device(MACs) is registered to RPS.

5.1 XML-RPC signature

redirect.checkDevice(mac)

5.2 Parameter

mac: MAC address you want to check.

5.3 Return values

5.4 Example

Request Positive Answer Negative Answer

6.redirect.registerDevices

You can register a list of devices to a different configuration server by MAC IDs.

6.1 XML-RPC signature

redirect.registerDevices(macList,serverName)

6.2 Parameter

1. mac : MAC address you want to register to RPS. 2. serverName: The server name you already added to RPS which the device should be redirected to.

6.3 Return values

6.4 Example

Request Positive Answer Negative Answer

7. redirect.registerDevices[2]

If the MAC addresses you are registering have been registered before, you can confirm whether to override the previous registrations by isOverride parameter.

7.1 XML-RPC signature

redirect.registerDevices(macList,serverName,isOverride)

7.2 Parameter

1. macList: MAC addresses you want to register to RPS.
2. serverName: The server name you already added to RPS which the device should be redirected to.
3. isOverride:Confirm whether to override the previous registration or not.
(1) 1:Override confirmation
(2) 0:Cancel registration

7.3 Return values

7.4 Example

Request Positive Answer Negative Answer

8.redirect.deRegisterDevices

You can remove a list of devices from RPS by deregistering these MAC addresses.

8.1 XML-RPC signature

redirect.deRegisterDevices(macList)

8.2 Parameter

macList: MAC addresses you would like to remove from RPS

8.3 Return values

8.4 Example

Request Positive Answer Negative Answer

9. redirect.addServer

You can add a different server configuration to the RPS.

9.1 XML-RPC signature

redirect.addServer(serverName,serverUrl)

9.2 Parameter

1. serverName: The server name you already added to RPS which the device will be redirected to.
2. serverUrl: The specific URL of your configuration server.

9.3 Return values

9.4 Example

Request Positive Answer Negative Answer

10.redirect.editDevice

You can change the server where the device(s) has registered to another server.

10.1 XML-RPC signature

redirect.editDevice(mac,serverName)

10.2 Parameter

1. mac : The MAC address you would like to edit.
2. serverName: The server name is what you would like to re-register the MAC to.

10.3 Return values

10.4 Example

Request Positive Answer Negative Answer

11.redirect.editDevice[2]

If the MAC address you are registering has been registered before, you can confirm whether to override the previous registration by isOverride parameter.

11.1 XML-RPC signature

redirect.editDevice(mac,serverName,isOverride)

11.2 Parameter

1. mac : The MAC address you would like to edit.
2. serverName: The server name is what you would like to re-register the MAC to.
3. isOverride: Confirm whether to override the previous registration or not.
(1) 1:Override confirmation
(2) 0:Cancel registration

11.3 Return values

11.4 Example

Request Positive Answer Negative Answer