10 Call History

10.1 Export

POST https://<HOST>:<PORT>/app/monitor/callhistory/export/v0?version=0

To determine the paramters for this request it is recommended to use the "Call History Export Assistant". To do so open the anynode frontend user interface and navigate to Monitor ModeCall HistoryExport.

Required Permissions

  • API

  • Monitoring Mode Read Access

Example

POST http://127.0.0.1:8888/app/monitor/callhistory/export/v0
x-www-form-urlenceded Parameter
filterDateTimePeriod : "THIS_MONTH"
template : "<#macro escape strValue>${strValue?json_string}</#macro>
[
<#list sessions as session>
{
    "Start Date/Time": "<@escape '${session.startDateTime?string["yyyy-MM-dd HH:mm:ss"]}'/>",
    "Source Dial String (Inbound)": "<@escape '${session.inboundSourceDialString!""}'/>",
    "Destination Dial String (Outbound)": "<@escape '${session.outboundDestinationDialString!""}'/>",
    "Session Identifier": "<@escape '${session.sessionIdentifier!""}'/>"
}<#sep>,
</#sep></#list>]"
filterCount : "2"
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
<html>
  <body>There is no connection to the anynode monitor.</body>
</html>

10.2 Get

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

Returns the Call History as JSON.

Required Permissions

  • API

  • Monitoring Mode Read Access

Request Body Structure

The request body is structured as CallHistoryFilter JSON object. A description for its fields is at section 30.14.1. For the JSON schema refer to section 30.14.2.

10.3 Get Message History

GET https://<HOST>:<PORT>/api/messageHistory?version=0

Returns the SIP messages of an entry of the call history.

Required Permissions

  • API

  • Monitoring Mode Read Access

Request parameters

  • filterSystemIdentifier

    The identifier of the system from which the SIP messages should be returned.

  • resultFormat

    Determines in which format the messages will be returned.

    Possible values:

    • pcap

      Returns the messages aus pcap data which can be viewed with a pcap viewer.

    • textFlow

      Returns textual information showing the signaling flow.

    • textMessages

      Returns textual information showing the message details.

    • HTML

      Returns a HTML page that displays the signaling flow and message details.

    • details

      Returns a JSON array containing detailed information about each message.

  • filterSessionIdentifier

    The identifier of the session from which the SIP messages should be returned. This is mandatory.

Example

GET http://127.0.0.1:8888/api/messageHistory?filterSystemIdentifier=950F281609F9AAE64F42364C8B4008D6&resultFormat=details&filterSessionIdentifier=FEDCDE7C266D4A7127A433FA5439FA6F&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "destinationPort": 5060,
    "sourcePort": 0,
    "messageLength": 1055,
    "sourceIpAddress": "127.0.0.1",
    "truncated": false,
    "message": "INVITE sip:40@127.0.0.1 SIP/2.0
Allow: ACK, BYE, CANCEL, INFO, INVITE, NOTIFY, OPTIONS
Call-Id: 1C2B94624801DA1707A82DA5DE441601C81F9DC8A0@127.0.0.1
Contact: <sip:40@127.0.0.1:5062>
Content-Length: 325
Content-Type: application/sdp
Cseq: 1 INVITE
From: <sip:40@127.0.0.1>;tag=237264b7
Max-Forwards: 70
Min-Se: 90
P-Alcatel-Csbu: charging=<sip:40@127.0.0.1>
Record-Route: <sip:127.0.0.1:5062;lr>
Session-Expires: 300;refresher=uas
Supported: timer
To: <sip:40@127.0.0.1>
User-Agent: www.te-systems.de XCAPI V4.0.0.0
Via: SIP/2.0/UDP 127.0.0.1:5062;received=127.0.0.1;branch=z9hG4bK217d15507ddd4ca17c5610582afade5d
X-Bearer-Capability: Speech
X-Xcapi-Uuid: 2B94624801DA1707A82EA5DE441601C8
Content-Length: 325
v=0
o=sip 81921 1 IN IP4 127.0.0.1
s=SIP session
c=IN IP4 127.0.0.1
t=0 0
m=audio 56654 RTP/AVP 8 0 3 18 101
a=rtpmap:8 PCMA/8000
a=rtpmap:0 PCMU/8000
a=rtpmap:3 GSM/8000
a=rtpmap:18 G729/8000
a=fmtp:18 annexb=no
a=rtpmap:101 telephone-event/8000
a=fmtp:101 0-15,32,36
a=sendrecv
a=rtcp:56655 IN IP4 127.0.0.1
",
    "sessionIdentifier": "FEDCDE7C266D4A7127A433FA5439FA6F",
    "protocol": "udp",
    "messageType": "sip",
    "systemIdentifier": "950F281609F9AAE64F42364C8B4008D6",
    "callIndex": 0,
    "time": "UTC 2023-10-25 (Wednesday)",
    "timezoneSeconds": 7200,
    "destinationIpAddress": "127.0.0.1",
    "timestamp": 1698247393356,
    "direction": "received"
  },
  {
    "destinationPort": 5062,
    "sourcePort": 0,
    "messageLength": 545,
    "sourceIpAddress": "127.0.0.1",
    "truncated": false,
    "message": "SIP/2.0 100 Trying
Allow: ACK,BYE,CANCEL,INFO,INVITE,NOTIFY,OPTIONS,REFER,SUBSCRIBE,UPDATE
Allow-Events: message-summary,refer
Call-Id: 1C2B94624801DA1707A82DA5DE441601C81F9DC8A0@127.0.0.1
Cseq: 1 INVITE
From: <sip:40@127.0.0.1>;tag=237264b7
Record-Route: <sip:127.0.0.1:5062;lr>
Server: anynode/4.11.35
Supported: from-change,path,privacy,replaces,timer
To: <sip:40@127.0.0.1>;tag=C360A3C622DEC5765C481B9772829A89
Via: SIP/2.0/UDP 127.0.0.1:5062;received=127.0.0.1;branch=z9hG4bK217d15507ddd4ca17c5610582afade5d
Content-Length: 0
",
    "sessionIdentifier": "FEDCDE7C266D4A7127A433FA5439FA6F",
    "protocol": "udp",
    "messageType": "sip",
    "systemIdentifier": "950F281609F9AAE64F42364C8B4008D6",
    "callIndex": 0,
    "time": "UTC 2023-10-25 (Wednesday)",
    "timezoneSeconds": 7200,
    "destinationIpAddress": "127.0.0.1",
    "timestamp": 1698247393395,
    "direction": "sent"
  }
]

10.4 Export Recorded Session

GET https://<HOST>:<PORT>/app/monitor/callhistory/recording/v0?version=0

Returns the file of a recorded session.

Required Permissions

  • API

  • Tracing

Request parameters

  • file

    The filename of the recoding. The filename consists of the recording id and the file type (i.e. "4C0E930A91081A010DBA8BFF48F10B76.wav). The recording id can be found in the call history.