GetConfig

As a response to the GetConfig command the Ozeki Phone System returns extension configuration details of a specified extension. In the response XML you can get the configuration details between the Config nodes.

Example HTTP request:

http://192.168.115.131:7780/?command=GetConfig&ExtensionId=1000

Example HTTP response:

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <Config knownType="SIPExtensionInfo">
    <AuthorizationName>1000</AuthorizationName>
    <Password>1000</Password>
    <LastIPAddress>192.168.115.188:5060 (Udp)</LastIPAddress>
    <UserAgentName>Grandstream GXP2000 1.2.5.3</UserAgentName>
    <Enabled>true</Enabled>
    <ID>1000</ID>
    <UserID>user1000</UserID>
  </Config>
  <Code>200</Code>
  <Message>Command successfully executed</Message>
</Response>

Request parameters

Parameter name Value Description Mandatory
command string value, GetConfig Specifies the type of the HTTP API command. Yes
ExtensionId string value,
e.g. 1000		 ID of the extension which configuration will be requested. 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
Config string value Contains the configuration settings of the extension: AuthorizationName, Password, LastIPAddress, UserAgentName (e.g. the brand of the telephone), Enabled (boolean), ID, UserID)

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 get configuration details of. You can find the extension Id in the response, between one of the <Id></Id> nodes.

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

Step 3: Accept the response from Ozeki Phone System. You can read out the configuration details of the extension from the response. You can see an example response above. You can use this configuration XML as template for AddConfig or ModifyConfig commands.

More information