This document provides help and illustrations for using SMSCountry's SMS gateway via their HTTP API. It defines the required parameters for sending SMS messages, including username, password, sender ID, mobile number, message, and message type. It also describes how to send single, bulk, and customized multiple messages. Delivery reports can be accessed with job IDs or within a date/time range. Dynamic delivery reports can also be configured to send reports to a callback URL.
This document provides help and illustrations for using SMSCountry's SMS gateway via their HTTP API. It defines the required parameters for sending SMS messages, including username, password, sender ID, mobile number, message, and message type. It also describes how to send single, bulk, and customized multiple messages. Delivery reports can be accessed with job IDs or within a date/time range. Dynamic delivery reports can also be configured to send reports to a callback URL.
This document provides help and illustrations for using SMSCountry's SMS gateway via their HTTP API. It defines the required parameters for sending SMS messages, including username, password, sender ID, mobile number, message, and message type. It also describes how to send single, bulk, and customized multiple messages. Delivery reports can be accessed with job IDs or within a date/time range. Dynamic delivery reports can also be configured to send reports to a callback URL.
This document provides help and illustrations for using SMSCountry's SMS gateway via their HTTP API. It defines the required parameters for sending SMS messages, including username, password, sender ID, mobile number, message, and message type. It also describes how to send single, bulk, and customized multiple messages. Delivery reports can be accessed with job IDs or within a date/time range. Dynamic delivery reports can also be configured to send reports to a callback URL.
Copyright:
Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online from Scribd
Download as pdf or txt
You are on page 1/ 8
HTTP API - HELP DOCUMENT
1. INTRODUCTION
This document is to provide help and illustrations to users who wish to
delivery SMS using the SMSCountry SMS Gateway via the HTTP Protocol.
Accessing gateway through HTTP API is one of the best and the quickest ways to deliver SMS messages. The HTTP API can be used to send various types of SMS messages including normal text messages, Unicode messages, ring tones, logos and picture messages.
This document gives a detailed explanation of using the gateway through HTTP API.
2. PARAMETER DEFINITION
The following table gives the list of parameters required for sending message through SMSCountry’s Gateway using the HTTP API.
S.NO PARAMETER PARAMETER VALUE PARAMETER
NAME DESCRIPTION
1 User Test User User name of the
account 2 Passwd Test Password Password of the account
3 Sid SMSCountry(default) Sender –id
4 Mobilenumber Mobile Number Destination Mobile
Number 5 Message Test Message Message to be sent 6 Mtype N/OL/R/P/L/F/WP/LS Type of message 7 DR Y/N Delivery report required 8 SMS_Job_NO Message Id SMS Submitted Return value 9 mno_msg <mobile- Mobile Number and number1>^<message1>~<mobile- message pattern for number2>^<message2> multiple sms API Table 2.1: Parameter Definitions HTTP API - HELP DOCUMENT USERNAME: - USER The user is free to choose his username at the time of registration. The user parameter cannot be more than 17 characters long and can only contain alphabets and numbers, with no blank spaces or special characters.
PASSWORD: - PASSWD The user is free to choose his password at the time of registration. The passwd parameter cannot be more than 20 characters long and can only contain alphabets and numbers, with no blank spaces or special characters.
SENDER-ID / NAME OF SENDER: - SID
The Sender-Id refers to the Alphanumeric Identity of the Sender. For India an alphanumeric sender-id (of maximum 8 characters) is accepted. International SMS can have alphanumeric sender-id (of maximum 11 characters).
Please Note: The Sender-Id should be approved by SMSCountry. You can have multiple sender Ids activated in your account. You can send different API calls with different sender ids provided that the sender id is active for your account. If an API call is made with a sender id not activated in user account then by default his “preferred” sender id will be delivered. If user does not have a preferred sender id then by default “SMSCntry” will be delivered at end user mobile. You can change your preferred sender id in “My Account” page by login to http://www.smscountry.com
MOBILE NUMBER: - MOBILENUMBER
This parameter refers to the destination mobile number(s) to which the message is to be sent. It must include the country code appended before the mobile number (eg: 9198xxxxxxx, 4478xxxxxxxx, 6591xxxxx). Any error in this parameter value would lead to non-delivery of the message. The mobile number should contain only numbers and no symbols like "+", “-“ etc.
MESSAGE: - MSG The msg parameter refers to the actual message that is to be sent to the destination mobile number. The format of the message differs depending on the type of message being sent.
For simple text messages, the message can contain numbers, alphabets, spaces and certain special characters. The message can contain a maximum of 160 characters, including spaces.
In case of Unicode messaging, the message can contain only numbers in
the form of Unicode digits. Further, it can have a maximum of 70 characters i.e. 70 x 4 Unicode digits for each character that means 280 digits.
In case of binary messaging, the message can contain only valid 8-bit data string. The binary message can be a maximum of 140 characters only for each SMS. However, Ring tones, Logos and Pictures that exceed 140 characters can be sent as two / three SMS messages. HTTP API - HELP DOCUMENT
Due to restrictions in the HTTP protocol, the following special characters must be encoded, as shown below, to avoid collision with reserved HTTP characters –
Message Type is to identify the type of message being sent. The default value of message type is N, which refers to Normal text message. SMSCountry’s Gateway classifies the type of messages to be sent on the basis of this parameter and pushes them accordingly.
S.NO MTYPE DESCRIPTION
1 N Normal Text Message
2 OL Unicode Message(eg: Arabic, Chinese, Greek , etc)
3 P Picture Message
4 L LOGO
5 F Flash
6 WP WapPush ( specify the Wap URL in the parameter
WAP_URL ) 7 LS Long SMS (GPRS based) 8 R Ringtone Table 2.3: Message Type Description HTTP API - HELP DOCUMENT
3. MESSAGING
3.1 Sending a Single Message
To send a single message of any type (normal text messages, Unicode messages, ring tones, logos and picture messages), the gateway requires parameters like User and Passwd (as described in the Table 2.1: Parameter Definitions) for authentication purpose in below URL format
Each user can check his / her account status (Credits Purchased, Credits Available, etc.) online by login into SMScountry account using the user name and password
4.2 Delivery Reports
4.2.1 Accessing Delivery Report With Job-Ids
For accessing delivery reports for the SMS messages sent, the following URL, along with the required parameters, needs to be accessed – http://www.smscountry.com/SMSCwebservice_SMS_GetDR.asp? SMS_Job_No=xxx&User=xxxxxx&passwd=xxxxxxxxxxx Response:- mobilenumber-status-donestamp Note:- donestamp is in format MM/DD/YYYY HH:MM:SS AM HTTP API - HELP DOCUMENT 4.2.2 Accessing Delivery Report with Time Duration For accessing delivery report for SMS messages sent during a particular date and time duration, the following URL, along with the required parameters, needs to be accessed – http://www.smscountry.com/smscwebservice_reports.asp? user=xxxx&passwd=xxxx&fromdate=DD/MM/YYYY 00:00:00 &todate=DD/MM/YYYY 23:59:59
We also provide you Dynamic Delivery Reports with Call Back Script Option enabled. With this option, we will send Deliver Reports directly to the URL specified by you.
To get auto delivery response push at your end you need to provide us a URL that shall read below parameters from query string. jobno (ex:- xxxxxx) , mobilenumber (ex:- 91923XXXXXXX) status (ex:- integer value, please refer API doc for status details) DoneTime (ex:-format MM/DD/YYYY HH:MM:SS AM/PM) messagepart (ex:- sms message sent by you)
The table below describes the various types of response from the gateway –
S.NO STATUS RESPONSE
1 SMS message(s) sent a)SMS message(s) sent (If DR=N) b) Unique Number (If DR=Y) 2 SMS message(s) not sent a) Invalid User Name!! b) Your Account not activated. Please contact Webmaster!! c) Invalid Password!! d) Invalid Data e) Insufficient Balance!!! Please Buy SMS Credits f) Invalid mobile number(s) given g)SMS message(s) not sent h) Mobile number has opted not to receive any sms 3 Delivery Report Received a) Mobile_Number-Status-TimeStamp Successfully Description for Status_ 0-Message In Queue 1 - Submitted To Carrier 2 - Un Delivered 3 – Delivered 4 – Expired 8 – Rejected 9 – Message Sent 10 – Opted Out Mobile Number 11 – Invalid Mobile Number
4 Delivery Report not a) Invalid User Name!!
Received b) Invalid Password!! Table 4.1: Delivery Response & Status HTTP API - HELP DOCUMENT
5 SMS CREDIT BALANCE
For getting SMS credit balance, the following URL, along with the required parameters, needs to be accessed – http://www.smscountry.com/SMSCwebservice_User_GetBal.asp?User=xxx&passwd=xx
The table below describes the response from the gateway –
S.NO STATUS RESPONSE
1 SMS Balance Received a) Number Successfully 2 SMS Balance Not Received a) Invalid User Name!! Successfully b) Invalid Password!! Table 5.1: Balance Check Responses
6. ILLUSTRATIVE EXAMPLES
6.1 SMS containing normal text message http://www.smscountry.com/SMSCwebservice.asp?
6.3 SMS containing 8-bit binary data (e.g. for Ring tone/Logo) http://www.smscountry.com/SMSCwebservice.asp? User=wworks&passwd=5hdshj3&mobilenumber=44983xxxxxx&binmess= %06%05%04%15%81%00%00&message=%02J%3Ai%1D%BD%B1%91%19%A5%B9%9D %95%C8%04%00%25%18%C5%12a%06%19av %10%81%98%11%81%16%12%81&sid=wworks&mtype=R
6.4 SMS Containing multiple messages to multiple mobile numbers
Evaluation of Some SMTP Testing, SSL Checkers, Email Delivery, Email Forwarding and WP Email Tools: Evaluation of Some SMTP Testing, SSL Checkers, Email Delivery, Email Forwarding and WordPress Email Tools
Evaluation of Some SMTP Testing, SSL Checkers, Email Delivery, Email Forwarding and WP Email Tools: Evaluation of Some SMTP Testing, SSL Checkers, Email Delivery, Email Forwarding and WordPress Email Tools
