Download as pdf or txt
Download as pdf or txt
You are on page 1of 4

Send Voice SMS API

http://<yourdomain>/api/voice/sendvoice.aspx?username=<username>&authkey=<authkey>
&route=<route>&voicefile_id=<voicefile_id>&number=<mobilenumber>

Optional parameters

campaign_name: Name of campaign

callerid: Custom caller id default id +401

isdtmf : If dtmf response required then pass value 1 default is 0

Response Success

{
"status": "success",

"code": "0",

"description": "request executed successfully",

"totalcount": 1,

"transactionid": "1906171723233",

"data": [{
"msgid": "15708023",
"number": "9829160808"
}]
}

Response Error

{
"status": "error",

"code": "1",

"description": "authentication failed. please try again",

"totalcount": null,

"transectionid": "",

"data": null
}
Voice Balance API

http://<yourdomain>/api/voice/balance.aspx?username=<username>&authkey=<authkey>

Response Success

"status": "success",

"code": "0",

"description": "request executed successfully",

"data": {

"promotional": "0.00",

"dynamic": "810440.28"

Response Error

{
"status": "error",
"code": "1",
"description": "authentication failed. please try again",
"data": null
}

Response Codes

0 Request executed successfully


1 Authentication failed. please try again
2 Some system error occurred, please try again.
3 Api is not in correct format, please put all field in correct sequence.
Voice Delivery API

http://<yourdomain>/api/voice/reportvoice.aspx?username=<username>&authkey=<authkey>&transac
tionid=<transactionid>

Response Success

"status": "success",

"code": "0",

"description": "request executed successfully",

"transactionid": "4641750",

"data": [{

"msgid": "15694463",

"number": "9999999999",

"status": "ANSWERED",

"start_time": "6/16/2019 10:19:48 AM",

"connect_time": "6/16/2019 10:20:15 AM",

"end_time": "6/16/2019 10:20:19 AM",

"duration": "4",

"dtmf_press": "False",

"dtmf_digit": ""

}]

Response Error

"status": "error",
"code": "3",
"description": "api is not in correct format, please put all field in correct sequence.",
"transactionid ": null,
"data": null
}
Response Codes

0 Request executed successfully


1 Authentication failed. please try again
2 Some error occurred, please try again.
3 Api is not in correct format, please put all field in correct sequence.
4 No record found for given transaction id

You might also like