Dial Test Call
The /sipTestCall/dial URL starts a new test call.
URL
/api/v1/sipTestCall/dial
HTTP Method
POST
Request JSON Attributes
|
Attribute |
Type |
Value |
Description |
||||||
|---|---|---|---|---|---|---|---|---|---|
|
calledNumber |
String |
- |
Defines the URI
of the called number. The value can be up to 61 characters. Note: The parameter is mandatory. |
||||||
|
callingNumber |
String |
- |
Defines the URI of the calling number. The value can be up to 61 characters. Note: The parameter is mandatory. |
||||||
|
destAddress |
String |
- |
Defines the destination address. The value can be up to 50 characters Note: The parameter is mandatory if you don't define the destIpGroup parameter. |
||||||
|
outInterface |
Integer |
- |
Defines the outgoing IP Network interface (by ID). Note: The parameter is applicable only if you also define the destAddress parameter. |
||||||
|
destIpGroup |
String |
|
Defines the destination IP Group (by ID or name). Note:
|
||||||
|
playDtmfString |
String |
- |
Defines the DTMF digits to play (e.g., 1636). The value can be up to 16 digits. The default value is the value of the ini file parameter [TestCallDTMFString]. Note: When the playToneIndex parameter is defined with a non-zero (0) value, the playDtmfString parameter is ignored. |
||||||
|
playToneIndex |
Integer |
- |
Defines a prerecorded tone (by index) from the PRT file installed on the device to play instead of DTMF digits (defined by playDtmfString). The valid value is -1 , or 0 to 80. The value -1 means play the tone defined at index #22 ("acDialTone2") in the PRT file. The value 0 means not configured (i.e., play DTMF digits according to playDtmfString. Note: When the parameter is defined with a non-zero (0) value, the playDtmfString parameter is ignored. |
||||||
|
timeout |
Integer |
- |
Defines the maximum duration (in seconds) of the call (after which it's automatically ended). The default is 20 seconds. |
||||||
|
transportType |
Enum |
|
Defines the transport protocol. If not specified, the value is according to the global ini file parameter [SipTransportType]. Note: The parameter is applicable only if you also define the destAddress parameter. |
||||||
|
UDP |
Transport protocol type is UDP. |
||||||||
|
TCP |
Transport protocol type is TCP. |
||||||||
|
TLS |
Transport protocol type is TLS. |
||||||||
|
keepResultTimeout |
Integer |
- |
Defines how long (in seconds) to keep the results after the call ends if you didn’t retrieve it with the getStatus API endpoint. The default is 20 seconds. |
HTTP Responses
| ■ | 202 Accepted if the call was sent for processing. |
| ■ | 500 Internal Error if the test call failed. |
If the response is 202, a body is returned with the following:
|
Attribute |
Description |
|---|---|
|
sessionId |
A number identifying the specific test call session. |
|
statusURL |
The URL to get the call status using the getStatus API endpoint (e.g., /api/v1/sipTestCall/getStatus?sessionId=577121441). |
|
showURL |
The URL to get call configuration using the show API endpoint (e.g., /api/v1/sipTestCall/show?sessionId=577121441). |
|
dropURL |
The URL to end the test call using the drop API endpoint (e.g., /api/v1/sipTestCall/drop?sessionId=577121441). |
Example
| ■ | Request: |
POST /api/v1/sipTestCall/dial HTTP/1.1
Host: 10.4.219.229
Content-Type: application/json
{
"calledNumber": 200,
"callingNumber": 100,
"destIpGroup": 2
}
| ■ | Response: |
HTTP/1.1 202 Accepted
Content-Type: application/json
{
"sessionId": 577121441,
"statusURL": "api/v1/sipTestCall/getStatus?sessionId=577121441",
"showURL": "api/v1/sipTestCall/show?sessionId=577121441",
"dropURL": "api/v1/sipTestCall/drop?sessionId=577121441"
}