Fetch SIP Ladder

The SIP Ladder REST API provides a JSON-formatted representation of the details of a SIP session (incoming and outgoing messages) between VoiceAI Connect and the external SIP connection. You can use the session details to develop debugging tools to help visualize the SIP call flow between these two entities.

For retrieving the SIP Ladder, your Administrator needs to provide you with the appropriate IAM policy (roles and scopes). For more information, see Managing users.

This feature is applicable only to VoiceAI Connect Enterprise (Version 3.10 and later).

SIP Ladder functionality requires ELK. For installing ELK and related SIP Ladder configuration, contact AudioCodes.

The REST API for fetching the SIP ladder is done over HTTPS and supports the GET HTTPS method request,

The REST API for fetching the SIP ladder is made from the REST client to VoiceAI Connect (server), using the resource URI /api/v1/calls/.

REST API Resource

REST Resource	HTTP Request	Description
`/api/v1/calls/{ConversationID}/sipLadder?format=json`	GET	Fetches the SIP ladder (SIP flow) of the specific call.

Path Parameters

Parameter	Type	Description
`ConversationID`	Number	Identifier of the call to be retrieved.

Request Query Parameters

Parameter	Type	Description
`format`	String	The format of the returned SIP ladder. `json`: (Default) SIP ladder displayed in JSON format. `text`: SIP ladder displayed in text format. Note: Currently, only JSON format is supported.

Parameter

Type

Description

format

String

The format of the returned SIP ladder.

json: (Default) SIP ladder displayed in JSON format.
text: SIP ladder displayed in text format.

Note: Currently, only JSON format is supported.

Authentication

To use this API, define the application with the following policy:

Role: VAIC/CALLS/SIPLADDER/READ

For more information on assigning policies (roles and scopes) to users and applications, see Managing users.

Response Body

JSON object with the call details. The fields are described below and shown in the example at the end of this section.

JSON Branch	JSON Property	Type	Description
diagnosticInfo	`gid`	String	The mapped session between conversationID and Global Session ID (gid).
nodes	`displayName`	String	IP address and port of the remote source or destination of the messages.
nodes	`system`	Boolean	`True` when the node represents the system.
messages	`timestamp`	Standard JSON format	2012-04-23T18:25:43.511Z
messages	`fromNode`	Integer	Index of an element in the "nodes" array.
messages	`toNode`	Integer	Index of an element in the "nodes" array.
messages	`direction`	String	`Incoming` or `Outgoing`.
messages	`transport`	String	Transport type (`UDP`, `TCP`, or `TLS`).
messages	`method`	String	-
messages	`sdp`	Boolean	-
messages	`text`	String	The actual SIP message including SIP headers and SDP.

Response Codes

200: Successful response, which contains call details as a JSON object (see above).
401: Authentication failure (missing OAuth token or invalid token).
404: If the ConversationID could not be mapped to a gid, or no logged entries exist in the database for the conversationID.

Response Example

{
  "diagnosticInfo": 
    { 
      "gid": "8f63e4:44:11524"
    },
  "nodes": [
    {
      "displayName": "52.156.76.224:5060"
    },
    {
      "displayName": "System",
	"system": true
    },
    {
      "displayName": "10.4.2.23:5070"
    }
  ],
  "messages": [
    {
      "timestamp": "07-08@07:19:38.107",
      "fromNode": 0,
      "toNode": 1,
      "direction": "Incoming",
      "transport": "UDP",
      "method": "INVITE",
      "sdp": true,
      "text": "INVITE sip:+546633234183@uzkbmbwkozad.byoc-rolling1-sip1.audiocodes.io:5060 SIP/2.0\r\nVia: SIP/2.0/UDP 52.156.76.224:5060;branch=z9hG4bK-2632053-1-0\r\nFrom: <sip:sipp@52.156.76.224:5060>;tag=1\r\nTo: sut <sip:+546633234183@20.79.227.48:5060>\r\nCall-ID: 1-2632053@10.4.2.23\r\nCSeq: 1 INVITE\r\nContact: sip:sipp@52.156.76.224:5060\r\nMax-Forwards: 70\r\nSession-Expires: 300;refresher=uac\r\nMin-SE: 90\r\nSubject: Performance Test\r\nContent-Type: application/sdp\r\nContent-Length:   145\r\n\r\nv=0\r\no=user1 53655765 2353687637 IN IP4 52.156.76.224\r\ns=-\r\nc=IN IP4 10.4.2.23\r\nt=0 0\r\nm=audio 6000 RTP/AVP 8\r\na=rtpmap:8 PCMA/8000\r\na=ptime:20\r\n\r\n"
    },
    {
      "timestamp": "07-08@07:19:38.107",
      "fromNode": 1,
      "toNode": 0,
      "direction": "Outgoing",
      "transport": "UDP",
      "method": "100",
      "sdp": false,
      "text": "SIP/2.0 100 Trying\r\nVia: SIP/2.0/UDP 52.156.76.224:5060;branch=z9hG4bK-2632053-1-0\r\nFrom: <sip:sipp@52.156.76.224>;tag=1\r\nTo: sut <sip:+546633234183@20.79.227.48>\r\nCall-ID: 1-2632053@10.4.2.23\r\nCSeq: 1 INVITE\r\nContent-Length: 0\r\n"
    },
    {
      "timestamp": "07-08@07:19:38.263",
      "fromNode": 1,
      "toNode": 2,
      "direction": "Outgoing",
      "transport": "UDP",
      "method": "INVITE",
      "sdp": true,
      "text": "INVITE sip:+546633234183@uzkbmbwkozad.byoc-rolling1-sip1.audiocodes.io SIP/2.0\r\nVia: SIP/2.0/UDP nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io:5060;branch=z9hG4bKac453994062\r\nMax-Forwards: 69\r\nFrom: <sip:+sipp@52.156.76.224>;tag=1c340224338\r\nTo: sut <sip:+546633234183@20.79.227.48>\r\nCall-ID: 96748235178202271938@nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io\r\nCSeq: 1 INVITE\r\nContact: <sip:+sipp@nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io:5060>\r\nSupported: sdp-anat\r\nSession-Expires: 300;refresher=uac\r\nMin-SE: 90\r\nUser-Agent: AudioCodes Live Hub/v.7.40BY-g6673fb53082.260.011\r\nSubject: Performance Test\r\nContent-Type: application/sdp\r\nContent-Length: 151\r\n\r\nv=0\r\no=user1 1013088778 1966355401 IN IP4 20.79.230.247\r\ns=-\r\nc=IN IP4 20.79.230.247\r\nt=0 0\r\nm=audio 6020 RTP/AVP 8\r\na=rtpmap:8 PCMA/8000\r\na=ptime:20\r\n\r\n"
    },
    {
      "timestamp": "07-08@07:19:38.415",
      "fromNode": 2,
      "toNode": 1,
      "direction": "Incoming",
      "transport": "UDP",
      "method": "100",
      "sdp": false,
      "text": "SIP/2.0 100 Trying\r\nVia: SIP/2.0/UDP nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io:5060;branch=z9hG4bKac453994062\r\nFrom: <sip:+sipp@52.156.76.224>;tag=1c340224338\r\nTo: sut <sip:+546633234183@20.79.227.48>;tag=1\r\nCall-ID: 96748235178202271938@nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io\r\nCSeq: 1 INVITE\r\nContact: <sip:10.4.2.23:5070;transport=UDP>\r\nContent-Length: 0\r\n"
    },
    {
      "timestamp": "07-08@07:19:38.415",
      "fromNode": 2,
      "toNode": 1,
      "direction": "Incoming",
      "transport": "UDP",
      "method": "180",
      "sdp": false,
      "text": "SIP/2.0 180 Ringing\r\nVia: SIP/2.0/UDP nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io:5060;branch=z9hG4bKac453994062\r\nFrom: <sip:+sipp@52.156.76.224>;tag=1c340224338\r\nTo: sut <sip:+546633234183@20.79.227.48>;tag=1\r\nCall-ID: 96748235178202271938@nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io\r\nCSeq: 1 INVITE\r\nContact: <sip:10.4.2.23:5070;transport=UDP>\r\nContent-Length: 0\r\n"
    },
    {
      "timestamp": "07-08@07:19:38.416",
      "fromNode": 1,
      "toNode": 0,
      "direction": "Outgoing",
      "transport": "UDP",
      "method": "180",
      "sdp": false,
      "text": "SIP/2.0 180 Ringing\r\nVia: SIP/2.0/UDP 52.156.76.224:5060;branch=z9hG4bK-2632053-1-0\r\nFrom: <sip:sipp@52.156.76.224>;tag=1\r\nTo: sut <sip:+546633234183@20.79.227.48>;tag=1\r\nCall-ID: 1-2632053@10.4.2.23\r\nCSeq: 1 INVITE\r\nContact: <sip:uzkbmbwkozad.byoc-rolling1-sip1.audiocodes.io:5060>\r\nServer: AudioCodes Live Hub/v.7.40BY-g6673fb53082.260.011\r\nContent-Length: 0\r\n"
    },
    {
      "timestamp": "07-08@07:19:41.202",
      "fromNode": 2,
      "toNode": 1,
      "direction": "Incoming",
      "transport": "UDP",
      "method": "200",
      "sdp": true,
      "text": "SIP/2.0 200 OK\r\nVia: SIP/2.0/UDP nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io:5060;branch=z9hG4bKac453994062\r\nFrom: <sip:+sipp@52.156.76.224>;tag=1c340224338\r\nTo: sut <sip:+546633234183@20.79.227.48>;tag=1\r\nCall-ID: 96748235178202271938@nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io\r\nCSeq: 1 INVITE\r\nContact: <sip:10.4.2.23:5070;transport=UDP>\r\nContent-Type: application/sdp\r\nContent-Length:   154\r\n\r\nv=0\r\no=user1 53655765 2353687637 IN IP4 10.4.2.23\r\ns=-\r\nc=IN IP4 10.4.2.23\r\nt=0 0\r\nm=audio 40873 RTP/AVP 8\r\na=rtpmap:8 PCMA/8000\r\na=ptime:20\r\na=sendrecv\r\n\r\n"
    },
    {
      "timestamp": "07-08@07:19:41.202",
      "fromNode": 1,
      "toNode": 0,
      "direction": "Outgoing",
      "transport": "UDP",
      "method": "200",
      "sdp": true,
      "text": "SIP/2.0 200 OK\r\nVia: SIP/2.0/UDP 52.156.76.224:5060;branch=z9hG4bK-2632053-1-0\r\nFrom: <sip:sipp@52.156.76.224>;tag=1\r\nTo: sut <sip:+546633234183@20.79.227.48>;tag=1\r\nCall-ID: 1-2632053@10.4.2.23\r\nCSeq: 1 INVITE\r\nContact: <sip:uzkbmbwkozad.byoc-rolling1-sip1.audiocodes.io:5060>\r\nSupported: sdp-anat\r\nServer: AudioCodes Live Hub/v.7.40BY-g6673fb53082.260.011\r\nContent-Type: application/sdp\r\nContent-Length: 161\r\n\r\nv=0\r\no=user1 593561022 343057319 IN IP4 20.79.230.247\r\ns=-\r\nc=IN IP4 20.79.230.247\r\nt=0 0\r\nm=audio 6016 RTP/AVP 8\r\na=rtpmap:8 PCMA/8000\r\na=ptime:20\r\na=sendrecv\r\n\r\n"
    },
    {
      "timestamp": "07-08@07:19:41.359",
      "fromNode": 0,
      "toNode": 1,
      "direction": "Incoming",
      "transport": "UDP",
      "method": "ACK",
      "sdp": false,
      "text": "ACK sip:+546633234183@uzkbmbwkozad.byoc-rolling1-sip1.audiocodes.io:5060 SIP/2.0\r\nVia: SIP/2.0/UDP 52.156.76.224:5060;branch=z9hG4bK-2632053-1-4\r\nFrom: sipp <sip:sipp@52.156.76.224:5060>;tag=1\r\nTo: sut <sip:+546633234183@20.79.227.48:5060>;tag=1\r\nCall-ID: 1-2632053@10.4.2.23\r\nCSeq: 1 ACK\r\nContact: sip:sipp@52.156.76.224:5060\r\nMax-Forwards: 400\r\nSubject: Performance Test\r\nContent-Length: 0\r\n"
    },
    {
      "timestamp": "07-08@07:19:41.360",
      "fromNode": 1,
      "toNode": 2,
      "direction": "Outgoing",
      "transport": "UDP",
      "method": "ACK",
      "sdp": false,
      "text": "ACK sip:10.4.2.23:5070;transport=UDP SIP/2.0\r\nVia: SIP/2.0/UDP nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io:5060;branch=z9hG4bKac116634656\r\nMax-Forwards: 70\r\nFrom: <sip:+sipp@52.156.76.224>;tag=1c340224338\r\nTo: sut <sip:+546633234183@20.79.227.48>;tag=1\r\nCall-ID: 96748235178202271938@nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io\r\nCSeq: 1 ACK\r\nContact: <sip:sipp@nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io:5060>\r\nUser-Agent: AudioCodes Live Hub/v.7.40BY-g6673fb53082.260.011\r\nSubject: Performance Test\r\nContent-Length: 0\r\n"
    },
    {
      "timestamp": "07-08@07:19:55.365",
      "fromNode": 0,
      "toNode": 1,
      "direction": "Incoming",
      "transport": "UDP",
      "method": "BYE",
      "sdp": false,
      "text": "BYE sip:+546633234183@uzkbmbwkozad.byoc-rolling1-sip1.audiocodes.io:5060 SIP/2.0\r\nVia: SIP/2.0/UDP 52.156.76.224:5060;branch=z9hG4bK-2632053-1-8\r\nFrom: sipp <sip:sipp@52.156.76.224:5060>;tag=1\r\nTo: sut <sip:+546633234183@20.79.227.48:5060>;tag=1\r\nCall-ID: 1-2632053@10.4.2.23\r\nCSeq: 2 BYE\r\nContact: sip:sipp@52.156.76.224:5060\r\nMax-Forwards: 70\r\nSubject: Performance Test\r\nContent-Length: 0\r\n"
    },
    {
      "timestamp": "07-08@07:19:55.366",
      "fromNode": 1,
      "toNode": 2,
      "direction": "Outgoing",
      "transport": "UDP",
      "method": "BYE",
      "sdp": false,
      "text": "BYE sip:10.4.2.23:5070;transport=UDP SIP/2.0\r\nVia: SIP/2.0/UDP nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io:5060;branch=z9hG4bKac1116409327\r\nMax-Forwards: 69\r\nFrom: <sip:+sipp@52.156.76.224>;tag=1c340224338\r\nTo: sut <sip:+546633234183@20.79.227.48>;tag=1\r\nCall-ID: 96748235178202271938@nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io\r\nCSeq: 2 BYE\r\nUser-Agent: AudioCodes Live Hub/v.7.40BY-g6673fb53082.260.011\r\nSubject: Performance Test\r\nContent-Length: 0\r\n"
    },
    {
      "timestamp": "07-08@07:19:55.515",
      "fromNode": 2,
      "toNode": 1,
      "direction": "Incoming",
      "transport": "UDP",
      "method": "200",
      "sdp": false,
      "text": "SIP/2.0 200 OK\r\nVia: SIP/2.0/UDP nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io:5060;branch=z9hG4bKac1116409327\r\nFrom: <sip:+sipp@52.156.76.224>;tag=1c340224338\r\nTo: sut <sip:+546633234183@20.79.227.48>;tag=1\r\nCall-ID: 96748235178202271938@nwarbcoqkrjc.byoc-rolling1-sip1.audiocodes.io\r\nCSeq: 2 BYE\r\nContact: <sip:10.4.2.23:5070;transport=UDP>\r\nContent-Length: 0\r\n"
    },
    {
      "timestamp": "07-08@07:19:55.515",
      "fromNode": 1,
      "toNode": 0,
      "direction": "Outgoing",
      "transport": "UDP",
      "method": "200",
      "sdp": false,
      "text": "SIP/2.0 200 OK\r\nVia: SIP/2.0/UDP 52.156.76.224:5060;branch=z9hG4bK-2632053-1-8\r\nFrom: <sip:sipp@52.156.76.224>;tag=1\r\nTo: sut <sip:+546633234183@20.79.227.48>;tag=1\r\nCall-ID: 1-2632053@10.4.2.23\r\nCSeq: 2 BYE\r\nServer: AudioCodes Live Hub/v.7.40BY-g6673fb53082.260.011\r\nContent-Length: 0\r\n"
    }
  ]
}