ListExtensions

The ListExtensions command lists configured extensions in the system.

Example HTTP request:

http://192.168.115.131:7780/?command=ListExtensions

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>
  <Extensions>
    <ExtensionSummary>
      <Id>1000</Id>
      <Type>SIP</Type>
    </ExtensionSummary>
    <ExtensionSummary>
      <Id>1001</Id>
      <Type>SIP</Type>
    </ExtensionSummary>
    <ExtensionSummary>
      <Id>1002</Id>
      <Type>SIP</Type>
    </ExtensionSummary>
    <ExtensionSummary>
      <Id>100</Id>
      <Type>SIP</Type>
    </ExtensionSummary>
  </Extensions>
</Response>

The value between the <Id></Id> nodes are extension IDs. They are used in commands referring to the extension: GetConfig, ModifyConfig, RemoveConfig

Request parameters

Parameter name Value Description Mandatory
command string value, ListExtensions Specifies the type of the HTTP API command. 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)		 Returns the status code of the response. For more information 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
Extensions string value Between the ExtensionSummary nodes it contains the ID and the Type parameter of the extension as shown above in the HTTP response example.

More information