5.7.1 api call status

The /api/call/status function helps you get the current states of active telephone calls. The function returns a list of active calls including parameters.

The function is part of the Phone/Call service and the user must be assigned the Phone/Call Monitoring privilege for authentication if required.

The GET or POST method can be used for this function.

Request parameters:

Parameter	Description
session	Optional call identifier. If the parameter is not included, the function returns statuses of all the active calls.

The reply is in the application/json format and includes a list of active calls (sessions) including their current states. If the session parameter is used, the sessions field includes just one item. If there is no active call, the sessions field is empty.

Parameter	Description
session	Call identifier
direction	Call direction (incoming, outgoing)
state	Call state (connecting, ringing, connected)

Example:

GET /api/call/status
{
  "success" : true,
  "result" : {
    "sessions" : [
      {
        "session" : 1,
        "direction" : "outgoing",
        "state" : "ringing"
      }
    ]
  }