ListActiveCalls command

The ListActiveCalls command lists all the calls in progress in the system. The list of active calls also contains numerous information about each call like the Source, Destination, the duration of the talk, etc.

Request parameters

Parameter name Example value Description Mandatory
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

Response parameters

Parameter name Example value Description Mandatory
Code 200 Returns the status code of the response. yes
Message Command successfully executed Returns the description of the response code. yes
ActiveCalls It contains <Call> nodes. In these nodes the details of a call is shown. There are as many pair of nodes as many active calls in progress. The parameters of these nodes are: CallId, Source, CallerId, Destination, CallerDialed, CelleeDialed, StartTime, RingDuration, TalkDuration and CallState. yes
NotificationName CallConnected Name of the notification request type. no

Example request and response

URL request

http://127.0.0.1:9509/api?command=ListActiveCalls&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>
  <ActiveCalls>
    <Call>
      <CallId>1vQHKd</CallId>
      <Source>103</Source>
      <CallerId>103</CallerId>
      <Destination>101</Destination>
      <CallerDialed>101</CallerDialed>
      <CalleeDialed>101</CalleeDialed>
      <StartTime>2019-04-09 10:34:07</StartTime>
      <RingDuration>0.749</RingDuration>
      <TalkDuration>0.000</TalkDuration>
      <CallState>Ringing</CallState>
    </Call>
    <Call>
      <CallId>1zS1b3</CallId>
      <Source>104</Source>
      <CallerId>104</CallerId>
      <Destination>105</Destination>
      <CallerDialed>105</CallerDialed>
      <CalleeDialed>105</CalleeDialed>
      <StartTime>2019-04-09 10:35:32</StartTime>
      <RingDuration>2.351</RingDuration>
      <TalkDuration>3.056</TalkDuration>
      <CallState>InCall</CallState>
    </Call>
  </ActiveCalls>
</Response>

More information