9 Active Sessions

9.1 Get

POST https://<HOST>:<PORT>/api/activeSessions/get?version=0

Returns the the list of active sessions.

Required Permissions

  • API

  • Monitoring Mode Read Access

Request parameters

  • dateFormat

    Determines the format of dates. Default is XZWO.

    Type: String

    Possible Values:

    • ISO-8601

    • XZWO

Request Body Structure

The request body is structured as ActiveSessionsFilter JSON object. A description for its fields is at section 30.13.1. For the JSON schema refer to section 30.13.2.

Example

POST http://127.0.0.1:8888/api/activeSessions/get?version=1
HTTP Request Body
{
  "numberFilterMode": "startswith",
  "count": 10,
  "numberFilter": "1"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "lastUpdated": "UTC 2024-05-28 06:35:31",
  "activeSessions": [{
    "incoming": {
      "date": "2024-05-28",
      "rtpPacketLossOccurrences": 0,
      "usesRegistration": false,
      "mediaReceiveCodec": "g711ALaw",
      "rtpReceiveTotalPackets": 4749,
      "sipLocalUri": "sip:10@127.0.0.1",
      "sipLocalName": "",
      "mediaSendCodec": "g711ALaw",
      "telRemoteNumber": "10",
      "sipRemoteName": "",
      "sipRemoteUri": "sip:10@127.0.0.1",
      "rtpSendPacketsLost": 0,
      "duration": 96,
      "routeId": "",
      "rtpSendTotalPackets": 4750,
      "connectTime": "06:33:55",
      "transportProtocol": "UDP",
      "startTime": "06:33:55",
      "usedTransportIri": "",
      "rtpPacketsLost": 0,
      "signalingProtocol": "SIP",
      "rtpSendProfile": "rtp",
      "priority": "normal",
      "callState": "connected",
      "usesRouteSupervision": false,
      "telLocalName": "",
      "rtpSendPacketLossOccurrences": 0,
      "rtpReceiveProfile": "rtp",
      "usedRegistrationClientName": "",
      "telRemoteName": "",
      "nodeId": "XCAPI (localhost)",
      "telLocalNumber": "10"
    },
    "outgoing": [{
      "date": "2024-05-28",
      "rtpPacketLossOccurrences": 0,
      "usesRegistration": false,
      "mediaReceiveCodec": "g711ALaw",
      "rtpReceiveTotalPackets": 4750,
      "sipLocalUri": "sip:10@127.0.0.1",
      "sipLocalName": "",
      "mediaSendCodec": "g711ALaw",
      "telRemoteNumber": "10",
      "sipRemoteName": "",
      "sipRemoteUri": "sip:10@localhost:5062",
      "rtpSendPacketsLost": 0,
      "duration": 96,
      "routeId": "",
      "rtpSendTotalPackets": 4749,
      "connectTime": "06:33:55",
      "transportProtocol": "UDP",
      "startTime": "06:33:55",
      "usedTransportIri": "",
      "rtpPacketsLost": 0,
      "signalingProtocol": "SIP",
      "rtpSendProfile": "rtp",
      "priority": "normal",
      "callState": "connected",
      "usesRouteSupervision": false,
      "telLocalName": "",
      "rtpSendPacketLossOccurrences": 0,
      "rtpReceiveProfile": "rtp",
      "usedRegistrationClientName": "",
      "telRemoteName": "",
      "nodeId": "XCAPI (localhost)",
      "telLocalNumber": "10"
    }],
    "sessionId": "100"
  }]
}