Get Test Call Configuration

The /sipTestCall/show URL displays the default test call configuration, or the current test call's configuration if the session ID is specified in the URL .

URL

/api/v1/sipTestCall/show

/api/v1/sipTestCall/show?sessionId=<ID>

HTTP Method

GET

Request JSON Attributes

None.

HTTP Responses

■

200 OK with the below body.

■

404 Not Found if session ID doesn't exist.

If the response is 200, a body is returned with the following:

Attribute	Type	Description
callingNumber	String	URI of the calling number.
calledNumber	String	URI of the called number.
destAddress	String	Destination IP address.
transportType	Enum	Transport protocol ("UDP", "TCP", or "TLS").
outInterface	Integer	Outgoing SIP Interface (by ID).
destIpGroup	String	Destination IP Group name.
playDtmfString	String	DTMF digits to play (e.g., 1636).
playToneIndex	Integer	Prerecorded tone (by index) to play from the PRT file (instead of DTMF digits).
timeout	Integer	Maximum duration (in seconds) of the call after which it automatically ends.
keepResultTimeout	Integer	Duration (in seconds) to keep the test call results after the call ends if you didn’t retrieve it with the getStatus API endpoint.

If the response is 4xx, a body is returned with the following:

Attribute	Type	Description
errorDescription	String	Detailed description of the error (e.g., "Session ID does not exist" ).

Example

■

Request:

GET /api/v1/sipTestCall/show?sessionId=577121441 HTTP/1.1
Host: 10.4.219.229

■

Response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "calledNumber": "200",
    "callingNumber": "100",
    "destAddress": "",
    "outInterface": -1,
    "transportType": "UDP",
    "destIpGroup": "2",
    "playDtmfString": "3212333",
    "playToneIndex": 0,
    "timeout": 720,
    "keepResultTimeout": 720
}