SMS API for transactional SMS documentation

How it Works

SMS API URL ConstructHello how you doing http://sms.rivet.solutions:8080/bulksms/bulksms?username=XXXX&password=YYYYY&type=Y&dlr=Z&destination=QQQQQQQQQ&source=RRRR&message=SSSSSSSS

SMS Account Credentials:o test the SMS API, please request SMS API test account, free SMS test account will allow you to test the service and integrate into your system before you to make the purchase.

Table of Contents

API Parameters

Here are some required parameters what we need to insert into api url.

• Username
• Password
• Type
• DLR
• Destination
• Source
• Messsage

Error Codes

Username

Your account Username which is registered with us.

Password

Your account Password which is registered with us.

Type

type: Indicates the type of message. here are the Values for "type":-

• 0: Plain Text (GSM 3.38 Character encoding)
• 1: Flash Message (GSM 3.38 Character encoding)
• 2: Unicode
• 3: Reserved
• 4: WAP Push
• 5: Plain Text (ISO-8859-1 Character encoding)
• 6: Unicode Flash
• 7: Flash Message (ISO-8859-1 Character encoding)

DLR

dlr: Indicates whether the client wants delivery report for this message Range of values for "dlr":-

• 0: No Delivery report required
• 1: Delivery report required

Destination

Mobile Number to which to Send message to (may or may not include a ‘+’ sign), multiple mobile numbers can be separated by commas (note the comma (',') should be URL encoded).

Source

The source address that should appear in the message

• Max Length of 18 if Only Numeric
• Max Length of 11 if Alpha numeric

If you wish plus ('+') should be prefixed to the sender address when the message is displayed on the cell phone, please prefix the plus sign to your sender address while submitting the message (note the plus sign should be URL encoded). Additional restrictions on this field may be enforced by the SMSC.

Message

The message to send (Can be used for 'long' messages, that is, messages longer than 160 characters for plain text, 140 for flash and 280 for Unicode) For concatenated (long) messages we will be counting as one message for every 153 characters for plain text and 268 characters for Unicode, as the rest of the characters will be used by the system for packing extra information for re-assembling the message on the cell phone. In case of WAP Push (type = 4), this is the text that would appear in the message. Also in the latter case, to send non-English characters in the message, you only have to directly URL encode them (using UTF-8 character encoding scheme).

Error Codes

Users may get some errors in codes which are explained below.

• 1701:Success, Message Submitted Successfully,
  In this case you will receive the response 1701||
  The message Id can then be used later to map the delivery reports to this message.
• 1702:Invalid URL Error, This means that one of the parameters was not provided or left blank
• 1703:Invalid value in username or password field
• 1704:Invalid value in "type" field
• 1705:Invalid Message
• 1706:Invalid Destination
• 1707:Invalid Source (Sender)
• 1708:Invalid value for "dlr" field
• 1709:User validation failed
• 1710:Internal Error
• 1025:Insufficient Credit

Note:- _ Along with the above errors codes, standard SMPP v3.4 error codes may also be returned where applicable.

_ Apart from 1709, Please DO NOT RETRY re-sending the message for any other error code (including SMPP v3.4 Error codes).

Bulk SMS API Reply Format: ||,||...