API code for bulk Sms system

server website api sms

HTTP Specification Version 1.84

  1. HTTP URL Link
  2. Sending Text Message
  3. Sending Flash Message
  4. Sending Unicode Message
  5. Sending Binary Message
  6. Sending 2D Barcode Message
  7. Check for credits left
  8. Transfer Credits
  9. SMS Return Code
  10. Delivery Report
  11. Incoming SMSAPI Code for Bulk SMS System
  1. HTTP URL Link

http://www.sms.com.my/websmsapi/ISendSMS.aspx?username=demoezsms&p assword=1234&message=test+message&mobile=60123456789&sender= demoezsms&type=1

Use the URL above as the HTTP Link structure for each parameter.

When using the HTTP URL link, you have to ensure that it is of HTTP Specification Version 1.84. This platform supports HTTP GET/POST. Take note that the parameter name is CASE SENSITIVE if you are using PHP.

It will only allow you to submit single (1) SMS. If you are planning to send to multiple recipients, you need to use the ISendSMSNoDR.aspx. Separate each mobile number with a comma. Take note as well that you will be able to use the Delivery Report function as this platform does not have MsgId response.

Parameter Description
Username You will be provided with a user name before using this service
Password This is a unique string of characters for you to access the system
Message This must be URL Encoded and is the content of your message
Mobile Refers to the intended recipient’s phone number
Sender Refers to your unique ID. If you are using NUMERIC you can have a maximum of 13 characters. For Alphanumeric characters, you can have up to 11 characters. Take note that Sender ID is now blocked in Malaysia and you can only send SMS to other countries.
Type Each number refers to a type of message:
1=Normal Text
2=Normal Text with Flash
3=Unicode (Arabic, Chinese etc.)
4=Unicode with Flash
5=Binary message with UDH like Ringtone
6=Binary message without UDH
seqno (Chars 20) This is actually a parameter. It is used to prevent any duplication of records transmitted from you to our system. Use a unique string of characters or leave blank. Our system will only store your seqno for a maximum of 24 hours. If you receive a 1718 response, it is an error code to inform you of a duplicate record.

Hence, with the above guide, a completed URL should be like the following:

http://www.sms.com.my/websmsapi/ISendSMS.aspx?username=demoezsms&p assword=1234&message=Test+message&mobile=60123456789&Sender=demoezsms&type=1

  1. Sending Text Message

You must use the following HTTP URL in order to send a normal Text Message:

http://www.sms.com.my/websmsapi/ISendSMS.aspx?username=demoezsms&password=1234&message=Test+message&mobile=60123456789&Sender=demoezsms&type=1

Take note that this URL supports HTTP GET/POST.

The parameter name is case sensitive if you are using PHP.

You cannot send SMS to multiple recipients using this URL. It only supports a single SMS submission. If you intend to send to several recipients, you need to use the ISendSMSNoDR.aspx with all the same parameter names. Separate mobile numbers with a comma “,”.

Take note that Delivery Report is not supported here as it does not have the MsgId response function.

Parameter Description
Type = 1 This indicates that the message is a Normal Text Message
  1. Sending Flash Message

A flash SMS message will appear as a Class 0 message on older phones manufactured by Nokia, Siemens, Ericsson, Motorola and others. Once the message is received, no further action will be required as it will appear on the screen automatically. This means the recipient need not have to open the inbox to read the message. In order to send a Flash Message, you need to use the following URL.

http://www.sms.com.my/websmsapi/ISendSMS.aspx?username=demoezsms&p assword=1234&message=Flash+Test+message&mobile=60123456789&Sender=demoezsms&type=2

Similarly, this function supports the HTTP GET/POST function

The parameter is case sensitive when using PHP.

It only supports single SMS submission and not multiple messages. You have to use ISendSMSNoDR.aspx to send to multiple recipients. No Delivery Report is possible as there is no MsgId response.

Parameter Description
Type = 2 This indicates that the message is a Flash Message / Direct Display Message
  1. Sending Unicode Message

Unicode messages usually refers to special characters. This includes Chinese or Arabic characters which are commonly defined by the GSM standards of the network. This type of message is actually normal typed messages. However, they must use the HEX form. To submit this, you need to use the following URL:

http://www.sms.com.my/websmsapi/ISendSMS.aspx?username=demoezsms& password=1234&message=Test+message&mobile=60123462828&Sender=Unicode&type=3

This URL supports HTTP GET/POST which is case-sensitive if using PHP.

You need to use the ISendSMSUnicode.aspx page if you are not converting Unicode to Hexcode. Similarly, it does not support multiple recipients and need the ISendSMSNoDR.aspx in order to do so. Use commas to separate the mobile numbers and it does not come with Delivery Report.

Parameter Description
Type = 3 This indicates that the message is a Unicode Message
  1. Sending Binary Message

Binary messages are richer in terms of content. It could come in the forms of ringtones, operator logos, picture messages or WAP Push content. They usually come with a UDH (User Data Header) which is the default header. To submit a binary message, you need to use the URL as below:

http://www.sms.com.my/websmsapi/ISendSMS.aspx?username=demoezsms&p assword=1234&message=Test+message&mobile=60123456789&Sender=demoezsms&type=5

This URL supports HTTP GET/POST. Ensure that the parameter is case sensitive if you are using PHP.

You need to use the ISendSMSNoDR.aspx to send messages to multiple recipients as this URL only supports single SMS submission.

Parameter Description
Type = 5 This indicates that the message is a Binary Message
  1. Sending 2D Barcode Message

http://www.sms.com.my/websmsapi/ISendSMS2D.aspx?username=demoezsms&password=1234&message=Test+messahr&mobile=60123456789&Sender=demoezsms&MsgType=xxxxxx

You must use the above URL to send 2D Barcode Messages. This URL supports HTTP GET/POST. If you are using PHP, ensure that you follow the case of the parameter name.

Parameter Description
Username

 

The username you use to connect to our system
Password Your unique password
Message You can use the %barcode% variable in this message. This refers to the barcode number
Mobile Refers to the recipient’s phone number
Sender

 

Refers to your unique ID. If you are using NUMERIC you can have a maximum of 13 characters. For Alphanumeric characters, you can have up to 11 characters. Take note that Sender ID is now blocked in Malaysia and you can only send SMS to other countries.
MsgType Refers to the format of the message

EMS = Refers to the type of phone (eg: Ericsson) that supports EMS
Nokia = Refers to Nokia phones
MMS = message is delivered as WAP Push

textmsg = Where the message is delivered as SMS (normal text)

textlink = Message is delivered as a URL (text format)

sseqno (Chars 20) This refers to the parameter used by the system to avoid duplicated records sent. You can leave this part blank or use your own unique sequence of numbers (ID). The seqno will only be stored for 24 hours in our system to prevent duplication. If any duplicate record is received, an error code of 1718 will be sent.

As such, you should have an URL as below:

http://www.sms.com.my/websmsapi/ISendSMS2D.aspx?username=demoezsms&password=1234&message=My+Barcode+is+ %25barcode%25+&mobile=60123456789&sender=demoezsms&msgtype =mms

  1. Check for Credits Left (remaining)

You can use the following URL which will inform you on your total credits used to date and those still available in your account.

http://www.sms.com.my/websmsapi/creditsLeft.aspx?username=demoezsms& password=1234

Above link will give the total credit used till date and total remaining. Take note that the parameter name is case sensitive if you are using PHP. This URL supports HTTP GET/POST.

  1. Transfer Credits

Use the following URL if you would like to transfer credits to your customers.

http://www.sms.com.my/websmsapi/transfer.aspx?username=demoezsms&password=1234&cust=demoezsms&credit=xxxxx

This URL supports HTTP GET/POST and is case sensitive in PHP.

Parameter Description
Username The unique ID you use to access the system
Password Authenticates your account
cust Your customer’s username
Credit The total amount or credit you wish to transfer to your customer
seqno (Chars 20) This parameter ensures that there are no duplicate records in our server. You can leave it blank or use your own unique sequence ID. If a duplicate record is received, an error code 1718 will be sent. We will store the seqno for only 24 hours to prevent duplication of records.
  1. SMS Return Code

Below are the values used by our server after SMS has been submitted:

Parameter Description
1701:[MSG ID] Message Sent Successfully.
1702 Invalid Username/Password
1703 Internal Server Error
1704 Insufficient Credits
1705 Invalid Mobile Number
1706 Invalid Message / Invalid SenderID
1707 Transfer of Credits Successful
1708 Invalid Account for Credits Transfer
1709 Invalid Credits Value for Credits Transfer
1718 Duplicate record received
  1. Delivery Report

http://[YourServerIP]/yourPage.asp?MsgId=xxxxx&Status=x&Sender=601xxxxxxxx

Use the URL above and send us your Web URL. To do this, log in to your account, then click on HOME and select System Settings. Then, set the ‘Delivery Status API URL’. We will then send the HTTP GET message your server. Refer below for the statuses of SMS. Take note that the parameter name is case sensitive if you use PHP to receive the data.

MsgId = [MSG ID] returned from the ISendSMS.aspx page

Sender = refers to the gateway number used to send the SMS to the recipient.

Status Description
6 Deliver Successful
7 Deliver Failed
8 Expired
9 Unknown
10 Rejected
11,15,16 QInTelco (Only applicable in GSM Gateway)
12,17 Not In Service (Only applicable in GSM Gateway)
13,14 Out Of Coverage (Only applicable in GSM Gateway)
  1. Incoming SMS

Send us your Web URL as below.

hhttp://[YourServerIP]/yourPage.asp?ShortCode=xxxxx&Sender=xxxxxxxxxxx&ContentType=x&Msg=xxxxxxxxxx

To do, set “Incoming SMS API URL” in your Systems Settings under HOME. Our system will then send the HTTP GET message to your server. The parameters (case sensitive if using PHP) can be referred below. Our server will only use 210.5.41.23 or 103.4.7.156 for HTTP Get Request. For authentication purposes, you can add your own parameters into your URL. For example it can be:

http://YourServerIP/yourPage.asp?u=user&p=1234 (by giving us the above URL, your script will receive u=user and p=1234)

Parameter Description
Shortcode This refers to the Gateway or Receiver’s number. Eg: 60123456789
Sender Refers to the mobile number of the sender. Eg: 60198765432
Content Type 1 = Normal Text

2 = Unicode (Arabic, Chinese, etc)

Msg Refers to the incoming SMS message. If you are using Unicode (ContentType = 3), HEXCODE will be used for sending. Eg: 004100420043 (ABC)
Treat Pandemic as opportunity now
Signup to our marketing group