SMS API for Developers !
As an application developer if you intend to add sms functionality in your application. Then you
definately need SMS API code. And most popular and easily to use in Http SMS API code. Using our SMS API Code you can do multiple activities.
Our SMS API's codes can be used for Single Send SMS, Send SMS Using API Key, Schedule SMS, Group SMS, Check Delivery, Balance Check.
We also provide detailed list of possible API Error Code that you might need to understand if your facing any issue during coding and integration of sms service. SMS message are send via secured SSL
Connection only.
TYPES OF HTTP API CODES IN SMS SERVICE
Send Message
Single SMS
REQUEST : https://your-domain-name/api/mt/SendSMS?user=demo&password=demo123&senderid=SMSXIO&channel=Promo&DCS=0
&flashsms=0&number=91989xxxxxxx&text=test message&route=01&peid=123456765434567654&DLTTemplateId=123456765434567654
RESPONSE :
{"ERRORCODE":"000","ERRORMESSAGE":"DONE","JOBID":"20047","MESSAGEDATA":[{"NUMBER":"91989XXXXXXX","MESSAGEID":
"MVHDPSYS7UOS"}]}
Schedule SMS
REQUEST : https://your-domain-name/api/mt/mt/SendSMS?user=demo&password=demo123&senderid=SMSXIO&channel=Promo&DCS=0
&flashsms=0&number=91989xxxxxxx&text=test
message&schedtime=2022/12/31 22:35:00 PM&route=##&peid=##&DLTTemplateId=##
RESPONSE : {"ERRORCODE":"000","ERRORMESSAGE":"DONE","JOBID":"20047","MESSAGEDATA":[{"NUMBER":"91989XXXXXXX","MESSAGEID":
"BQTIW66A2UGLF"}]}
Group SMS
REQUEST : https://your-domain-name/api/mt/sendGroupSms?user=demo&password=demo123&senderid=SMSXIO&channel=Promo&DCS=0
&flashsms=0&number=91989xxxxxxx&text=test message&groupid=###&route=##&peid=##&DLTTemplateId=##
RESPONSE : {"ERRORCODE":"000","ERRORMESSAGE":"DONE","JOBID":"20047","MESSAGEDATA":[
{"NUMBER":"91989XXXXXXX","MESSAGEID": "MVHDPSYS7UOS9HJXIXQLVW"},
{"NUMBER":"91999XXXXXXX","MESSAGEID":"PFIVCLGH20IG6G5R3USHWA"}]}
Send SMS Using API Key
Single SMS
REQUEST : https://your-domain-name/api/mt/SendSMS?APIKey=######&senderid=SMSXIO&channel=Promo&DCS=0&flashsms=0
&number=91989xxxxxxx&text=test message&route=##&peid=##&DLTTemplateId=##
RESPONSE : {"ERRORCODE":"000","ERRORMESSAGE":"DONE","JOBID":"20047","MESSAGEDATA":[{"NUMBER":"91989XXXXXXX","MESSAGEID":
"MVHDPSYS7UOS"}}
Schedule SMS
REQUEST : https://your-domain-name/api/mt/SendSMS?APIKey=######&senderid=SMSXIO&channel=Promo&DCS=0&flashsms=0&
number=91989xxxxxxx&text=test
message&schedtime=2022/12/31 22:35:00 PM&route=##&peid=##&DLTTemplateId=##
RESPONSE :
{"ERRORCODE":"000","ERRORMESSAGE":"DONE","JOBID":"20047","MESSAGEDATA":[{"NUMBER":"91989XXXXXXX","MESSAGEID":
"BQTIW66A2UGL"}]}
Group SMS
REQUEST : https://your-domain-name/api/mt/sendGroupSms?APIKey=######&senderid=SMSXIO&channel=Promo&DCS=0&flashsms=0
&number=91989xxxxxxx&text=test
message&groupid=###&route=##&peid=##&DLTTemplateId=##
RESPONSE :
{"ERRORCODE":"000","ERRORMESSAGE":"DONE","JOBID":"20047","MESSAGEDATA":
[{"NUMBER":"91989XXXXXXX","MESSAGEID":"MVHDPSYS7UOS9HJXIXQLVW"},
{"NUMBER":"91999XXXXXXX","MESSAGEID":"PFIVCLGH20IG6G5R3USHWA"}]}
Check Delivery
Check Delivery API
REQUEST : https://your-domain-name/api/mt/GetDelivery?user=demo&password=demo123&jobid=####
RESPONSE : {"ERRORCODE":"0","ERRORMESSAGE":"DONE","MESSAGEID":NULL,"DELIVERYREPORTS":
[{"MESSAGEID":"MVHDPSYS7UOS9HJXIXQLVW","DELIVERYSTATUS":"DELIVERED","DELIVERYDATE":"2023-01-01T06:17:00"},
{"MESSAGEID":"PFIVCLGH20IG6G5R3USHWA","DELIVERYSTATUS":"DELIVERED","DELIVERYDATE":"2023-01-01T06:17:00"}]}
Check Balance
Check Balance API
REQUEST : https://your-domain-name/api/mt/GetBalance?user=demo&password=demo123
RESPONSE : {"ERRORCODE":"0","ERRORMESSAGE":"DONE","BALANCE":"PROMO:9988|TRANS:0"}
Parameter Information
Parameter Details
|
Account
Parameters
|
Description
|
|
user
|
Your login username
|
|
password
|
Your login password
|
|
APIKey
|
Instead of the username and
password
you can use the API key for authentication of
account
|
|
Message
Parameters
|
Description
|
| senderid |
Approved Sender ID (6 characters string only). |
| channel |
Message channel promotional (Promo) or transactional (Trans) |
| route |
Pass the route id in this parameter to route the
message. |
| DCS |
Data coding value (Default is 0 for normal message, Set
8 for unicode sms) |
| flashsms |
Flash message immediate display (Default is 0 for normal
sms, Set 1 for immediate display) |
| number |
One recipient mobile number here |
| text |
Enter your text sms content here |
|
Message
Parameters
|
Description
|
| schedtime |
Schedule date and time for scheduling message
(DateTime
formate will be 2022/10/06 20:30:00 PM yyyy/mm/dd
hh:mm:ss PM) |
| groupid |
You will get Group ID number from Group Table |
| peid |
DLT Entity PEId: You will find DLT Entity Id from DLT Portal |
| dlttemplateid |
DLT Template Id: You will find DLT Template Id from DLT Portal |
| telemarketerid |
Telemarketer Id: You will find DLT Telemarketer Id from DLT Portal |
| & |
%26 |
| + |
%2B |
| = |
%3D |
| # |
%23 |
| % |
%25 |
| ? |
%3F |
| New Line |
%0A |
