Download PDF
1.INTRODUCTION FORMAT
URL : https://api.smscountry.com/SMSCwebservice_bulk.aspx
1.1 API Request Parameters from Client
User = SmsCountryUserName
Password = SmsCountryPassword
User=xxxxxx&passwd=xxxxxxxxxxxx&mobilenumber=xxxxxxxxxx&message=xxxxxxxxx&sid=xxxxxxxx
&mtype=N&DR=Y
API Response Parameters from Server
OK:515789649
2.PARAMETER DEFINITION
2.1 Parameter Definition :
The following table gives the list of parameters required for sending message through SMSCountry’s
Gateway using the HTTP API.
Request parameters are as follows :
PARAMETER NAME | PARAMETER VALUE | PARAMETER DESCRIPTION |
User |
Test User |
User name of the account |
Passwd |
Test Password |
Password of the account |
Sid |
SMSCountry(default) |
Sender-id |
Mobilenumber |
Mobile Number |
Destination Mobile Number |
Message |
Test Message |
Message to be sen |
Mtype |
N/OL/R/P/L/F/WP/LS |
Type of message |
DR |
Y/N |
Delivery report required |
SMS_Job_NO |
Message Id |
SMS Submitted Return value |
mno_msg |
mobile-number1-message1~mobile-number2-message2 |
Mobile Number and message pattern for multiple sms API |
2.2 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.
2.3 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.
2.3 SENDER-ID/NAME OF SENDER : Sid
The Sender-Id refers to the Alphanumeric Identity of the Sender. For India Sender id 6 Alpha characters
are accepted for transactional messages. International SMS can have alphanumeric sender-id
(of maximum 11 characters).
Please Note:
1.The Sender-Id should be approved by SMSCountry.
2.You can have multiple sender Ids activated in your account.
3.You can send different API calls with different sender ids provided that the sender id is active for your
account.
4.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.
5.If user does not have a preferred sender id then by default “SMSCntry” will be delivered at end user mobile.
6.You can change your preferred sender id in “My Account” page by login to http://www.smscountry.com
2.4 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.
2.5 MESSAGE : Message
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.
Due to restrictions in the HTTP protocol, the following special characters must be encoded,
as shown below, to avoid collision with reserved HTTP characters
CHARACTER | HEXA-DECIMAL ENCODED STRING |
---|
& |
%26 |
+ |
%2B |
% |
%25 |
# |
%23 |
= |
%3D |
^ |
%5E |
~ |
%7E |
2.6 MESSAGE TYPE : Mtype
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.
MTYPE | DESCRIPTION |
N |
Normal Text Message |
LNG |
Unicode Message(eg: Arabic, Chinese, Greek , etc) |
OL |
Hexa code Message Content |
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 for authentication purpose in
below URL format).
https://api.smscountry.com/SMSCwebservice_bulk.aspx?
User=xxxxxx&passwd=xxxxxxxxxxxx&mobilenumber=xxxxxxxxxx&message=xxxxxxxxx&sid=xxxxxxxx
&mtype=N&DR=Y
An Optional IP validation feature is also available for security of clients who access the gateway via a Global
Static IP.
https://api.smscountry.com/SMSCwebservice_bulk.aspx?
User=xxxxxx&passwd=xxxxxxxxxxxx&mobilenumber=xxxxxxxxxx&message=xxxxxxxxx&sid=xxxxxxxx
&mtype=N&DR=Y
3.2 Bulk Messaging
For sending Bulk SMS messages, the following URL, along with the required parameters,needs to
be accessed–
https://api.smscountry.com/SMSCwebservice_bulk.aspx?
User=xxxxxx&passwd=xxxxxxxxx&mobilenumber=xxxxxxx,xxxxxxx,xxxxxxxxx&message=xxxxxxxxx
&sid=xxxxxxxx&mtype=N&DR=Y
3.3 Sending Multiple Messages to Multiple Mobile numbers (Customized SMS)
For sending different messages to different mobile numbers in a single call, please use below
URL along with required parameters:-
https://api.smscountry.com/SMSCWebservice_MultiMessages.asp?
User=xxxxxx&passwd=xxxxxxxxx&mno_msg=xxxxxxx^yyyyyyyy~xxxxxxx^yyyyyyy&sid=xx
xxxxxx&mtype=N&DR=Y
5 SMS CREDIT BALANCE
For getting SMS credit balance, the following URL, along with the required parameters, needs to be accessed
https://api.smscountry.com/SMSCwebservice_User_GetBal.asp?User=xxx&passwd=xx
The table below describes the response from the gateway
STATUS | RESPONSE |
SMS Balance Received Successfully |
a) Number |
SMS Balance Not Received Successfully |
a) Invalid User Name!! b) Invalid Password!! |
6.SMS containing normal text message
https://api.smscountry.com/SMSCwebservice_bulk.aspx?
User=wworks&passwd=5hdshj3&mobilenumber=9198xxxxxx,97194xxxxxxxx&message=testin
gsmscountry&sid=wworks&mtype=N
6.1 SMS containing Unicode message (UCS-2)
Find below an illustration url for sending a message in Arabic
https://api.smscountry.com/SMSCwebservice_bulk.aspx?
User=wworks&passwd=5hdshj3&mobilenumber=85298xxxxx&message=062A06450020062A0
633062C064A06440643002006280646062C0627062D00200641064A0020062E062F064506290
0200631063306270626064400200627064406470627062A064100&Mtype=OL
6.3 SMS containing 8-bit binary data (e.g. for Ring tone/Logo)
https://api.smscountry.com/SMSCwebservice_bulk.aspx?
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
https://api.smscountry.com/SMSCWebservice_MultiMessages.asp?
user=xxxxx&passwd=yyyyy&mno_msg=919xxxxxxx^Hifirst message.~919xxxxxx^sencond
sms message&DR=Y&mtype=N
*The Mobile Number Prefixes seen in red