ListActiveCalls

The ListActiveCalls command lists the parameters of active calls. For example the call ID parameters returned can be used in other requests to get further information about the calls in progress or to control these calls. It also contains additional information detailed below on the picture in the response parameters. You can see how to use this command in a HTTP request and what HTTP response you will get from the phone system (Figure 1).

listactivecalls application xml example
Figure 1 - ListActiveCalls Application XML example

Request parameters

Parameter name Value Description Mandatory
command string value,
ListActiveCalls		 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
CallState string value,
e.g. InCall, Hold		 Returns the state of the call. Find out more about callstates.
CallId string value,
e.g. uteom		 Returns the call ID parameters of the active calls.
Source int value,
e.g. 1000		 Returns the telephone number of the caller.
CallerId string value,
e.g. Thomas M.		 Returns the caller ID parameters of the active call.
Destination int value,
e.g. 1001		 Returns the telephone number of the callee.
StartTime date value,
e.g. 2013-07-01T10:49:07.9558+02:00		 Returns the call ID parameters of the active calls.
RingDuration int value,
e.g. 2		 The ring duration of the call in seconds.
TalkDuration int value,
e.g. 956		 The talk ring duration of the call in seconds.
Code int value
(200, 300, 301, 302, 303, 601)		 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

More information