ListExtensions command

This simple command lists all configured extensions that connected to your phone system. The response will contain the Id and the type of the extensions.

Request parameters

Parameter name Example value Description Mandatory
Type Phone Filter by extension type no
Username admin The username of the account. The username and password parameters are used to authenticate the user. yes
Password abc123 Specifies the password. The username and password parameters are used to authenticate the user. yes

Respone parameters

Parameter name Example value Desciption Mandatory
Code 200 Returns the status code of the response. yes
Message Command successfully executed Returns the description of the response code. yes
Extensions Between the ExtensionSummary nodes it contains the ID and the Type parameter of the extension. yes
NotificationName CallConnected Name of the notification request type. no

Example request and response

URL request

http://127.0.0.1:9509/api?command=ListExtensions&Username=HTTP_User_1&Password=qwe123

Response

<?xml version="1.0"?>
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Code>200</Code>
  <Message>Command successfully executed</Message>
  <Extensions>
    <ExtensionSummary>
      <Id>101@localhost</Id>
      <PhoneNumber>101</PhoneNumber>
      <Type>Phone</Type>
      <State>Disconnected</State>
    </ExtensionSummary>
    <ExtensionSummary>
      <Id>106@localhost</Id>
      <PhoneNumber>102</PhoneNumber>
      <Type>IVR extension</Type>
      <State>Connected</State>
    </ExtensionSummary>
    <ExtensionSummary>
      <Id>107@localhost</Id>
      <PhoneNumber>103</PhoneNumber>
      <Type>Echo test</Type>
      <State>Connected</State>
    </ExtensionSummary>
  </Extensions>
</Response>

More information