ModifyConfig

The ModifyConfig command modifies an already existing extension configuration in the system. You cannot modify the extension ID, because it's globally unique in the system when an extension is added.

Example HTTP request:

http://192.168.115.131:7780/?command=ModifyConfig&ExtensionType=SIP&ConfigXML=%26lt%3bConfig+knownType%3d%22SIPExtensionInfo...

Sent XML in the ConfigXML parameter of the request: 

<Config knownType="SIPExtensionInfo">
    <AuthorizationName>100</AuthorizationName>
    <Password>100</Password>
    <Username>100</Username>
    <Enabled>false</Enabled>
    <ID>100</ID>
    <UserID>user1000</UserID>
</Config>

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, AddConfig Specifies the type of the HTTP API command. Yes
ExtensionType string value,
e.g. SIP		 Extension type of the configuration XML to be saved. The available extension types can be requested with ListExtensionTypes command. Yes
ConfigXML string value,
e.g. see above		 Extension configuration to add to the system. This parameter must be in XML format recognised by the system, and need to be URL encoded. It must contain the following type of inputs: AuthorisationName, Password, Username, Enabled, ID, UserID 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, 702, 703)		 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 use this. Use ListExtensions command to find the extension ID of the extension you want to modify. You can find the extension Id in the response, between one of the <Id></Id> nodes.

Step 2: Initiate a ModifyConfig command using a HTTP request. Use the extension ID you get from Step 1 in the ConfigXML parameter.

More information