SMSS | Superior Global Messaging Tools
HTTP & SMPP

api_pic

SMS-enable your Software hassle-free with our API’s

Submitting messages
HTTP(S) XML POST

The URL used to post XML formatted data is:
API Url: http://148.251.196.36/app/smsapi/index.php?key=< API Key >&type=text&contacts=< Contact No.(s) >&senderid=< Sender ID >&msg=< SMS Text >&time=< Schedule Time > API Key: (Your API Key) Contact No.(s): Contact numbers separated by ‘,'(Comma) sign. Enter N digit mobile numbers e.g. ’27XXXXXX,67XXXXXX,68XXXXXX’ ,Max 1000 Contacts Sender ID: Approved Sender ID. SMS Text: Url-encoded SMS text. Must be limited to 740 characters. $message = urlencode($smstext); Schedule Time: Enter the time in the format YYYY-MM-DD H:I e.g. enter 2013-03-19 14:30 for 19th March 2013, 2:30 pm. Leave BLANK to send the SMS instantly. $time = urlencode($time);

API Key Retrieval
API URL: http://148.251.196.36/app/getkey/< Username >/< Password >/
Username: Your account User ID used to login Password: Account Password that you use to login

Credit Balance
API Url: http://148.251.196.36/app/miscapi/< API Key >/getBalance/true/ API Key: Your API Key

Delivery Reports
API Url: http://148.251.196.36/app/miscapi/< API Key >/getDLR/< SMS Shoot ID > API Key: Your API Key SMS Shoot ID: Enter the SMS ID returned when submitted SMS via API. It will return an array having mobile numbers and their DLR status.

Unicode SMS
API Url: http://148.251.196.36/app/smsapi/index.php?key=< API Key >&type=unicode&contacts=< Contact No.(s) >&senderid=< Sender ID >&msg=< SMS Text >&time=< Schedule Time > API Key: Your API Key Contact No.(s): Contact numbers separated by ‘,'(Comma) sign. Enter N digit mobile numbers e.g. ’27XXXXXX,27XXXXXX,27XXXXXX’;Max 1000 Contacts Sender ID: Approved Sender ID. SMS Text: Url-encoded SMS text,Limited to 340. Must be UTF-8 charset and HTML entity decoded. For example, in PHP $message = urlencode(html_entity_decode($smstext,ENT_QUOTES,”UTF-8″)); Schedule Time: Enter the time in the format YYYY-MM-DD H:I e.g. enter 2013-03-19 14:30 for 19th March 2013, 2:30 pm. Leave BLANK to send the SMS instantly. $time = urlencode($time);

Flash SMS API
API Url: http://148.251.196.36/app/smsapi/index.php?key=< API Key >&type=flash&contacts=< Contact No.(s) >&senderid=< Sender ID >&msg=< SMS Text >&time=< Schedule Time > API Key: Your API Key (54259fa9c0785) Contact No.(s): Contact numbers separated by ‘,'(Comma) sign. Enter N digit mobile numbers e.g. ’69XXXXXX,67XXXXXX,68XXXXXX’; Max 1000 Contacts Sender ID: Approved Sender ID. SMS Text: Url-encoded SMS text. Must be limited to 740 characters. $message = urlencode($smstext); Schedule Time: Enter the time in the format YYYY-MM-DD H:I e.g. enter 2013-03-19 14:30 for 19th March 2013, 2:30 pm. Leave BLANK to send the SMS instantly. $time = urlencode($time);

SMPP
Host = 148.251.196.36
Port = 2775
System id = User_id
Password = Your Password
system-type = smpp
source-addr-ton = 0
source-addr-npi = 1
dest-addr-ton = 0
dest-addr-npi = 1
transceiver-mode = true

XML API
XML Request
The XML API supports utf-8 encoded XML.
Requests should be made using HTTP POST with a Content-Type of text/xml. For performance reasons the maximum request size is 500 messages.URL : <?xml version=’1.0′ encoding=’utf-8?> <message> <key>DEMO</key> <to>+XXXXXXXXXX+XXXXXXXXX+XXXXXXXXX</to> <senderid>BULK SMS</senderid> <text>Hello World!</text> <type>text</type> <datetime>2014-08-27 01:37:06</datetime> </message>

XML Response # Parameter Type
1 To MSISDN
2 MessageID String
3 ClientID String
3 ErrNo String
4 ErrDesc String
Description of Response Parameters: To: Phone number message was sent to. MessageID: Unique ID assigned to this message by Clockwork. Every successful message will have a message ID, you will need this ID to match up delivery receipts. ClientID: Your Client ID, passed back for your reference only. This field is only supplied if the Client ID was specified in the request. ErrNo: The API Error Code. This parameter will only be populated if an error occurred sending the message. ErrDesc: A text description of the API error code.  Parameters are explained below. The variables are: 1. Username: Your account username 2. Password: Your account password 3. Type: Indicates the type of message. Values for “type”:- 0: Plain Text GSM 3.38 Character Set 1: Flash Message 2: Unicode 3: Reserved 4: Reserved 5: Plain Text ISO-8859-1 Character Set 6: Unicode Flash 4. 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 5. contact no.(s): Mobile Number to which to Send message to (may or may not include a ‘+’ Sign), multiple mobile numbers can be separated by commas. 6. sender id: This is the Sender field that should appear in the message Max Length of 18 if Only Numeric Max Length of 11 if Alpha numeric. Please note that a source with a ‘+’ sign is treated as alpha numeric and not numeric so the normal constraints on an alphanumeric senders apply to it. (Additional restrictions on this field may be enforced by the SMSC) 7. message: The Short message to send (Can hold Long messages i.e. messages longer than 160 characters for plain text, 140 for flash and 280 for Unicode) Maximum of 740 characters for concatenated SMS  For concatenated messages we will be charging 1 SMS credit for the first 160 characters and the an extra SMS per 153 characters thereafter The above information is required to send the message through the SMSS SMS gateway. If any information is not provided or invalid, the following error code from the server will be displayed: api_”API Key”,”Network”,”Mobile Number” = Message Submitted Successfully 0.6 = Invalid URL Error, this means that one of the parameters was not provided or left blank 0.0 = Invalid value in API Key field 0.5 = Insufficient credits Please Note:  Along with the above errors codes, standard SMPP v3.4 error codes may also be returned where and when applicable.  Please DO NOT RETRY re-sending the message for any other error code (including SMPP v3.4 Error codes). Bulk SMS API Reply Format: (Callback URL) Callback URLs will be used to send messages back to applications via a standard HTTP GET or POST. The reply-path URL is set by you below the API menu option on the web-interace. The URL must begin with http:. HTTPS is accepted but only if encryption is supported. Variables are passed back by the API on message response. The variables returned to the URL are: MO message ID (shoot_id) Destination ISDN (to=) Date and Time [MySQL format, GMT + 0200] (timestamp=) DLR , delvery report 1: Delivered to phone, 2: Non-Delivered to Phone, 4: Queued on SMSC, 8: Delivered to SMSC, 16: Non-Delivered to SMSC.  Example: If you provide this URL http://www.yourdomain.com/sms/sms.asp then we will do a POST or GET as follows: http://www.yourdomain.com/sms/sms.asp?shootid=&to=&time=&dlr= If while servicing the request the SMPP Server goes down, the HTTP API will retry a fixed number (with a gap of 10 milliseconds between every 2 retries) of times to reconnect to the SMPP server and submit the message. In case the SMPP server does not come up before the fixed number of attempts are exhausted, the batch will be aborted at that destination and a message will be returned in following format:- <Error_Code>|<destination>:<message_id>,<Error_Code>| <destination>:<message_id>,0.6 destination_at_which_batch_aborted> The third and final situation which can arise is when the credits are exhausted in the middle of a request being serviced. When such a situation occurs we will abort the batch on the destination at which we got the “Insufficient_Credit” error, and a response in the following format will be returned to the client:- <Error_Code>|<destination>:<message_id>,<Error_Code>| <destination>:<message_id>,0.5<destination_at_which_batch_aborted> CAUTION: While sending messages with type=0 there are some special characters which end up taking the space of more than one character after final encoding and while sending to the SMSC. The following is the list of such known characters:- Please do note that the above list is not exhaustive and hence before sending any special characters do test to see if they are supported and if they are then the no of characters of the short message field they tend to use up.  Appendix GSM 03.38 Character set SMSS | Superior Global Messaging ISO-8859-1 Character set SMSS | Superior Global Messaging Code values 00–1F, 7F, and 80–9F are not assigned to characters by ISO/IEC 8859-1.