RemoveConfig

The RemoveConfig command removes an extension configuration from the system.

Example HTTP request:

http://192.168.115.131:7780/?command=RemoveConfig&ExtensionId=100

Example HTTP response:

<?xml version="1.0"?>
<Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Code>200</Code>
  <Message>Command successfully executed</Message>
</Response>

Request parameters

Parameter name Value Description Mandatory
command string value, RemoveConfig Specifies the type of the HTTP API command. Yes
ExtensionId int value,
e.g. 100		 The extension ID of the extension you want to remove. Yes
These parameters are only required if office user authentication is set in the HTTP API:
Parameter name Value Description
Username string value,
e.g. user1000		 This is the username of an Ozeki Phone System office user.
Password string value,
e.g. mypassword12		 This is the password belonging to the username.

Response parameters

Parameter name Value Description
Code int value
(200, 300, 301, 302, 303, 701)		 Returns the status code of the response. For more infromation go to the status code reference page
Message string value,
e.g. Command successfully executed		 Returns the description of the response code. For more infromation go to the status code reference page

How to use it?

Step 1: There needs to be at least one extension installed to do this. Use ListExtensions command to find the extension ID of the extension you want to remove. You can find the extension Id in the response, between one of the <Id></Id> nodes.

Step 2: Initiate a RemoveConfig command using a HTTP request. You need to know the extension ID of the extension you want to remove (Step 1) and put it in the ExtensionId parameter.

More information