You are on page 1of 12

HTTP API Specification

Version 1.0
January 10, 2014

All Rights Reserved: www.dlstechnologies.co.in

in .sendsmsbulk.jsp?user=xxxxx&password=xxxxx&mobiles=9900000000&sms=T /sendsms.dlstechnologies.jsp?user=xxxxx&password=xxxxx&mobiles=9900000000&sms=T /sendsms. The maximum number that can be sent in a signal request is 300. mobiles This field has all the Mobile numbers that are separated by a comma.co. Version For multiple mobile number with comma(.1 otherwise you will not able to send to multiple number Here is the list of return values when the HTTP request is made : Successfully Sent : <smslist> <sms> <smsclientid>0</smsclientid> <messageid>2005967104</messageid> </sms> </smslist> Invalid Username or Password : <smslist> <error> <smsclientid>0</smsclientid> <error-code>-10002</error-code> <error-description>Invalid Username Or Password</errordescription> <error-action>1</error-action> action> </error> </smslist> All Rights Reserved: www. pass version greater than 1.) separated. Please don’t send more that 300 numbers.in/sendsms.jsp?user=xxxxx&password=xxxxx&mobiles=9900000000&sms=Test& senderid=xxxx&version=3 The parameters that are going to be passed and their description are given in the table given below: Parameter name Parameter Description User This contains the username of the user password This contains the password of the user senderid This field holds the header that will be displayed on the mobile phone sms This is message which will not contain more than160 characters.Pushing Short/Long SMS messages For sending messages use the URL given below: http://www.

co.dlstechnologies.Invalid Sender ID : <smslist> <error> <smsclientid>0</smsclientid> <error-code> code>-10005</error-code> <error-description>Invalid Invalid Sender ID</error-description> ID</error <erroraction>1</error-action> </error></smslist When Message is Blank : <smslist> <error> <smsclientid>0</smsclientid> <error-code>-10015</error-code> <error-description>Message description>Message can not be blank</errorblank</error description> <error-action>1</error-action> action> </error> </smslist> When Balance is Zero or Account is Expired : <smslist> <error> <smsclientid>0</smsclientid> <error-code> code>10019</error-code> <error-description>Inactive description>Inactive user</error-description> <error-action>1</error n>1</erroraction> </error> </smslist> When Mobile numbers are duplicate : <smslist> <error> <smsclientid>0</smsclientid> <error-code> code>10018</error-code> <error-description>Duplicate description>Duplicate Mobile</error-description> <mobileno>+919990000000</mobile-no> <error erroraction>1</error-action> </error> <smslist> All Rights Reserved: www.in .

When Mobile numbers are more than available balance : Example : Balance is 2 and uploaded mobile numbers are 3. <smslist> <sms> <smsclientid>2</smsclientid> <messageid>-1</messageid> </sms> <sms> <smsclientid>1</smsclientid> <messageid>2005967246</messageid> d>2005967246</messageid> </sms> </smslist> <sms> <smsclientid>0</smsclientid> <messageid>2005967245</messageid> </sms> </smslist> All Rights Reserved: www.in .dlstechnologies. Response : It will send the First number 2 Numbers and drop the last One.co.

in/sendsms.Pushing Unicode messages For sending Unicode messages use the URL given below: http://www. Unicode=1 This will pass the Normal English message.jsp?user=xxx&password=xxxx&mobiles=9900000000&sms=Tes t & senderid=xxx&groupname=test&version=3 The parameters that are going to be passed and their description are given in the table given below: Parameter name Parameter Description gruopname Group Name is to be entered correctly.jsp?user=xxx&password=xxxx&mobiles=9900000000&sms=Tes /sendsms. Arabic etc. It is case sensitive. Gujarati. It will not work with sub groups.jsp?user=xxx&password=xxxx& /sendsms.co.jsp?user=xxx&password=xxxx&mobiles=9900000000&sms=Tes mobiles=9900000000&sms=Tes t & senderid=xxxx&unicode=1&version=3 The parameters that are going to be passed and their description are given in the table given below: Parameter name Parameter Description Unicode=0 This will pass the message in Hindi.in/sendsms.in .dlstechnologies.sendsmsbulk. Pushing messages on Group For sending messages on group use the URL given below: http://www.sendsmsbulk. Greek. Return values when the HTTP request is made : When Group name is Invalid or does not : <smslist> <error> <smsclientid>0</smsclientid> <error-code>-10006</error-code> <error-description>Enter description>Enter mobile no or Select group</errorgroup</error description> <error-action>1</error-action> action> </error> </smslist> All Rights Reserved: www.

co.dlstechnologies.Scheduling Messages For scheduling messages use the URL given below: http://www.jsp?user=UserName&password=Password Parameter name Parameter Description User This contains the username of the user password This contains the password of the user Return values when the HTTP request is made : For Success : <sms> <accountexpdate>04/02/2014</accountexpdate> <balanceexpdate>04/02/2014</balanceexpdate> /balanceexpdate> <credit>100</credit> </sms> For Error : <sms> <error>Invalid username or password</error> </sms> All Rights Reserved: www.jsp?user=xxxx&password=xxxx&mobiles=9900000000&sms=Tes t& senderid=xxxx&scheduletime yyyy-mm mm-dd hh:mm:ss=test&version=3 Parameter name Parameter Description scheduletime Enter the schedule in yyyy-mm-dd yyyy hh:mm:ss format Checking Credits For checking credits use the URL given below: http://www.sendsmsbulk.jsp?user=UserName&password=Passwor /smscredit.jsp?user=xxxx&password=xxxx&mobiles=9900000000&sms=Tes /sendsms.in/smscredit.in .sendsmsbulk.in/sendsms.

in/getDLR. Return values when the HTTP request is made : <response> <responsecode>0</responsecode> responsecode>0</responsecode> <resposedescription>Success</resposedescription> <dlristcount>1</dlristcount> <pendingdrcount>0</pendingdrcount> <drlist> <dr> <messageid>1</messageid> <externalid>0</externalid> <senderid>xxxx< <senderid>xxxx</senderid> <mobileno>xxxxxxxxxx</mobileno> <message>message</message> <submittime>yyyy <submittime>yyyy-mm-dd hh:mm:ss</submittime> All Rights Reserved: www.co. responsetype In which format you want response.dlstechnologies.jsp?userid=username&password=password&messageid=1.2&ext /getDLR. csv and tsv.in .2&d rquantity=X&fromdate=yyyy-mm-dd rquantity=X&fromdate=yyyy hh:mm:ss&todate=yyyy-mmddhh:mm:ss&redownload=yes&responce type=xml Parameter name Parameter Description User This contains the username of the user password This contains the password of the user messageid When you send a message you will get an unique message id from API and you have to use this message id for getting the deliver status for that message.Get Delivery Reports For checking delivery report use the URL given below: http://www.2&ext er nalid=1. Drquantity it means how many delivery status you want from application fromdate From Date & Time Todate Till the date & Time redownload When you request first time for delivery status of message then do not set this parameter. externalid unique sms serial no which you will get in response.sendsmsbulk.jsp?userid=username&password=password&messageid=1. We are supporting xml. If you want to a DR in a second time you must set redownload paramater “yes” otherwise you will not get DR.

<senttime>yyyy-mm-dd hh:mm:ss</senttime> <senttime>yyyy <deliverytime>yyyy deliverytime>yyyy-mm-dd hh:mm:ss</deliverytime> <status>status</status> <undeliveredreason>reason</undeliveredreason> <details>details</deta ils> </dr> </drlist> </response> All Rights Reserved: www.co.dlstechnologies.in .

Return values when the HTTP request is made : <acknowledge> <code>205</code> <description>Acknowledge get</description> </acknowledge> Get Description of Undelivered Messages For getting description use the URL given below: http://www.jsp?userid=username& /getundeliveredreasonanddescription.in/dracknowledgment.jsp?userid=username&password=password&messageid=1.in/getundeliveredreasonanddescription.2&ex /dracknowledgment.jsp?userid=username& /getundeliveredreasonanddescription.jsp?userid=username&password=password Parameter name Parameter Description User This contains the username of the user password This contains the password of the user Return values when the HTTP request is made : <undeliveredreasondescription> <record> <smsstatus>status</smsstatus> <reasonfordelivered>reason</reasonfordelivered> All Rights Reserved: www.sendsmsbulk.dlstechnologies.co.sendsmsbulk.jsp?userid=username&password=password&messageid=1.Send Delivery Acknowledgement For Send Delivery Acknowledgement use the t URL given below: http://www. externalid unique sms serial no which you will get in response.2 Parameter name Parameter Description User This contains the username of the user password This contains the password of the user messageid When you send a message you will get an unique message id from API and you have to use this message id for getting the deliver status for that message.2&ex te rnalid=1.in .

in .co.<descriptionofreasonfordelivered>description</descriptionofreasonfordelivered> </record> </undeliveredreasondescription> All Rights Reserved: www.dlstechnologies.

jsp?userid=username&password=password /getEnvironment.com/sendsms.co.Get Environments for Variable For getting environment use the URL given below: http://www. $Pwd = 'password'.domain. $url="http://www. $ret = file($url). echo $ret[9].domain.com/sendsms. $Text = 'TEST sms'.jsp?user=$ID&password=$Pwd&mobiles=$PhNo&sms=$Text&senderid =sender".jsp?userid=username&password=password Parameter name Parameter Description User This contains the username of the user password This contains the password of the user Return values when the HTTP request is made : <Environment> <variable> <name>name</name> <value>value</value> </variable> </Environment> PHP Sample Script For Integration in PHP use the sciprt given below: <?php $ID = 'username'. ?> All Rights Reserved: www.in .sendsmsbulk.dlstechnologies.in/getEnvironment. $PhNo = '9xxxxxxxxx'.jsp?user=$ID&password=$Pwd&mobiles=$PhNo&sms=$Text&senderid http://www.

dlstechnologies.End of Document --- All Rights Reserved: www.in .XML API Sample Script For XML use the sciprt given below: <?xml version='1.0'?> <smslist> <sms> <user>userid</user> <password>password</password> <message>message content</message> <mobiles>9XXXXXXXXX</mobiles> <senderid>BULKSMS</senderid> <clientsmsid>0</clientsmsid> <unicode>1</unicode> </sms> <sms> ---.co.