Quenbec inc # henri bourassa H3L-3N3 Montreal, QC,Canada Toll free: Mobile

Transcription

1 HTTP PROTOCOL SPECIFICATIONS VERSION 3.0 Contents Http api of canadiansms.com.....what to find in this http api...how to send sms....how to check your credits.....how to download your reports....how to see a specific record report

2 What to find in this api The book you are holding is going to guide you with the procedure and technical specifications required to send sms messages from your website or software using our SmS platform. This book's version is 3.0 and as we enrich our services we will make changes to the content. All our partners will be informed of any new services or changes to the specifications described in this book via or sms, where you will be notified of the URL that can download the newer version. In case you read this book and need assistance don't hesitate to contact our support department at GENERAL TECHNICAL SPECIFICATIONS Sending SmS messages from our platform is easy and can be done with almost any programming language that has access to the internet. Our platform accepts variables in POST or GET method, just like the method you would use in a simple form of a website. In order to connect with our platform you will have to create an account in canadiansms.com For more information please visit the website canadiansms.com

3 How to send sms through our platform The next 4 parts of this chapter will describe the URL that you will send the variables via the POST or GET method, the names of the variables and what each response code of our server means in case you make a mistake or in case you successfully send your variables. 3,1 The URL that you can send your variables in order to as many sms you wan't at a time is: 3,2 Variables and description Variable name Meanings username password mobiles message route The username and the password accessing your web environment The mobiles is in the form and if exist another a comma(,) must be added to the end.the system not accepting duplicates Your message in gsm 7 bit table and and the message can not exceed the 400 characters. Message should be url encoded Options is primary or secondary any other value assuming primary Example: username=yourusername&password=yourpassword&route=primary& message=hello&mobiles= ,

4 3,3 Server response codes and their explanation Error Error1 Error5 Error7 Error8 Description Error your username or password are invalid Missing the telephone field Not enough remaining credits to your account Your message are too small means not excedded the 10 characters Error9 Your message is more than 400 characters success respond In success respond the function send you the report Code of the message ~ telephone number and asostored to your web environment Example : ~

5 How To check your remaining credits This part is to used to to inform the remaining credits to have in your account.the syntax is Example: username=username&password=password 4,2 Variables and description Variable name Username password Meanings The username and the password accessing your web environment Example: username=username&password=password 4,3 Server response codes and their explanation Error Description Error1 Error your username or password are invalid Success respond In success respond this function send you the available credits in your account

6 How to download the report This part is to used to download the submition for the specific date.the syntax is username=username&password=password&date=date 5,2 Variables and description Variable name Meanings Username password date The username and the password accessing your web environment The date must to be entered in the form of year(2 digit-month(2digit)-day(2 digits) example Example: username=username&password=password&date= ,3 Server response codes and their explanation Error Error1 Error10 Error11 Description Error your username or password are invalid The date is not in correct form No records were found on that date Success respond In success respond the function Download the report **You have to remember that the reports table updating every 3 hours