bulk message
Contents
1. Att mobile XSIT 2 HTTP Connector XSIT2 HTTP GATEWAY USER MANUAL 1 Page Att mobile CONTENTS SI No Description Page Version Control This document is version controlled Please update this version management table for any changes E Po 0 E Rum 1 0 2 LL ae updation of this document Mei 2 0 Added new error message black out Nisan 2 1 Added new error message M essage length exceeded Javvaji XSIT2 HTTP GATEWAY USER MANUAL 2 Page Asttmobile INTRODUCTION This document describes the method with which clients communicate with the XSIT2 HTTP messaging platform gateway in order to send MT push messages This document also explains about ESME applications that they need to develop in order to send messages and receive delivery reports from XSIT2 XSIT2 HTTP gateway support HTTP GET and HTTP POST method to accept messages from clients For communicating with the XSIT2 HTTP client has to have a valid account with SIT Mobile QUICK START Account setup Before processing messages from any sender XSIT2 HTTP gateway validates the sender based on 4 parameters Sl No Field Description Il login Login name assigned by SITM obile 2 password Password assigned by SITM obile 3 clientID Client ID assigned by SITM obile 4 accountiD Account ID assigned by SITM obile If you do not have any of the above de2. Att mobile http lt domain gt SendMessage login YourLogin amp password YourPassword amp clientID Your Clientld amp accountID YourAccountld amp seq SegNumber amp destination comma separated destination MSISDN amp text Test message amp source SourceAddress amp wapurl someURL Examples for sending wap message with http and https wapurl http lt domain gt HT TPConnector SendMessage login user amp password pass amp clientID 90 0 amp accountlD 1719 amp destination 944799xxxx 944644xxxx 989900xxxx 980961xxxx amp text WelcomeSIT amp seq 1234567890 amp source 10929787890 amp wapurl http sitmobile com http lt domain gt HT TPConnector SendMessage login user amp password pass amp clientID 90 O amp accountID 1 71 9 amp destination 944799xxxx 944644xxxx 989900xxxx 980961 xxxx amp text securegoogle amp seq 1234567890 amp source 10929787890 amp wapurl https encrypted google com If the client requires WAP push for any destination the client should contact their respective account manager who will verify their account routing FLASH MESSAGE A flash SMS appears directly on the handset screen instead of the inbox It is a useful alternative to normal SMS when you want to catch the attention of user immediately Recipient has the option of saving the message in their inbox or discarding it Format flash SMS http lt domain gt SendMessage login YourLogin amp password YourPassword amp clientID Your Clientld amp accountID YourAc
3. above would take the following format XSIT2 HTTP GATEWAY USER MANUAL 8 Page Att mobile RESP CONC false gt lt SEQ 1234567890 MID 1 1222334343 STA OK gt lt SEQ 1234567890 MID 1 1222335341 STA OK gt lt SEQ 1234567890 MID 1 1222345341 STA OK gt lt RESP gt The order of message identifier in the response corresponds to the order of destination MSISDNs in the bulk message request That is message identifier 11222334343 corresponds to MSISDN 944799xxxx 11222335341 to 944644xxxx and so on XSIT2 HTTP Gateway supports bulk message sending through HTTP GET and POST methods But the number of destination MSISDNs that can be included in the GET request is limited to the one supported by the client s user agent WAP PUSH MESSAGE WAP Push has been incorporated into the specification to allow WAP content to be pushed to the mobile handset with minimum user intervention A WAP Push is basically a specially encoded message which includes a link to some URL WAP Push is specified on top of WDP WAP Datagram Protocol resembled the UDP protocol in the Internet as such it can be delivered over any WDP supported bearer such as GPRS or SMS XSIT2 HTTP Gateway supports WAP push Sl message Client can send a WAP Push request by sending a wapurl with the request The format of WAP Push request XSIT2 HTTP GATEWAY USER MANUAL 9 Page
4. DST Destination is invalid M essage will not get a message id CREDIT OUT Client has gone out of credits during a live Message will not get a message id sending For further sending client has to recharge their account XSIT2 HTTP GATEWAY USER MANUAL 7 Page Att mobile XSIT2 HTTP Gateway supports single MT message push through HTTP GET and POST methods It is always recommended to use HTTP POST BULK MESSAGE XSIT2 HTTP Gateway supports bulk message Client can submit a bulk message request with a single push request Destination numbers can be specified as CSV with the request Format for bulk push http lt domain gt SendMessage login Y ourLogin amp password YourPassword amp clientID YourClie ntld amp accountlDz YourAccountld amp seq SeqNumber amp destinationzcomma separated destination MSISDN amp text Test message amp source SourceAddress Example http lt domain gt HT TPConnector SendMessage login user amp password pass amp clientID 900 amp ac countlD 1719 amp destination 944799xxxx 944644xxxx 989900xxxx 980961xxxx amp text hello amp seq 1234567890 amp source 10929787890 Response Format Once bulk push is made to HTTP gateway it responds with a unique message identifier for each message The sequence number would be the same for all the messages The response format is the same as it is for single MT message push Example The response from HTTP Gateway for the bulk push made
5. HTTP GATEWAY USER MANUAL 5 Page Att mobile lt RESP gt If the destination field contains more than one MSISDN the response will be RESP CONC alse gt lt SEQ 1 MID 1720260 STA OK gt lt SEQ 1 MID 1720261 STA OK gt lt RESP gt For a message with more than 160 character length the message will be sliced into multiple parts by the gateway and the response will contain message id for each part RESP CONC true gt lt SEQ 1 MID 1720246 SLICE 0 STA OK gt lt SEQ 1 MID 1720247 SLICE 1 STA OK gt lt RESP gt If the message is binary the splitting happens at 120 bytes to accommodate the UDH And the behavior is same as that of a normal text message explained above RESP response indicator CONC Specify the concatenation status CONC true means message submitted was a long message XSIT2 HTTP GATEWAY USER MANUAL 6 Page Att mobile Details of the fields are as listed in the table Sl No Field Description 1 SEQ Sequence number of the message sent by the client 2 MID Unique message identifier generated by HTTP Gateway A ES S ST Status of the message OK means it is accepted 4 SLICE Slice id for a concatenated SMS 5 R The result of the message submission Example STA field will be any of the listed values Value Description Comment The message is accepted This message will get a message identifier INV_
6. ce 10929787890 amp data 0FAA0B12FF amp udh 050403158a158a XSIT2 HTTP GATEWAY USER MANUAL 11 Page At mobile ARABIC MESSAGE To send Arabic message through XSIT2 HTTP gateway it needs a parameter ccode which specify the character code of the text The value of ccode should be UCS2 for Arabic message Format of an Arabic message is exactly same as a normal text message but slicing happens if the message length is more than 70 characters The form has to be in UTF 8 encoded format Format Arabic SMS http lt domain gt SendMessage login YourLogin amp password YourPassword amp clientlD Your Clientld amp accountlD YourAccountld amp seq SegNumber amp destination comma separateddestination MSISDN amp source SourceAddress amp text seul luz amp ccode UCS2 Example http lt domain gt HTTPConnector SendMessage login user amp password pass amp clientlD 90 O amp accountID 1719 amp destination 944799xxxx 944644xxxx 989900xxxx 980961 xxxx amp seq 1234567890 amp source 10929787890 amp text sco l z amp ccode UCS2 POST BACK URL CONFIGURATION XSIT2 HTTP Gateway allows clients to receive the Delivery Reports for the MT message sending This would require the client to register their post back URL with the XSIT2 HTTP Gateway Please contact the XSIT2 support team for configuring the post back URL In order to receive the delivery report for the messages the client needs to setup an HTTP server application listening on th
7. countld amp seq SeqNumber amp destination comma separated XSIT2 HTTP GATEWAY USER MANUAL 10 Page Att mobile destination MSISDN amp text Test message amp source SourceAddress amp mclass 0 Example http lt domain gt HT TPConnector SendMessage login user amp password pass amp clientID 90 0 amp accountlD 1719 amp destination 944799xxxx 944644xxxx 989900xxxx 980961xxxx amp text WelcomeSIT amp seq 1234567890 amp source 10929787890 amp mclass 0 BINARY MESSAGE To send binary sms through XSIT2 HTTP gateway the message has to be in hexadecimal format Necessary UDH parameters also should be set with the message For sending binary message the message should be with data parameter and XSIT2 will discard value contained in text field Also it should have an extra field for setting the UDH parameter A long binary message will be split into multiple parts by the HTTP gateway and response will contain message id of each parts Format binary SMS http lt domain gt SendMessage login YourLogin amp password YourPassword amp clientID Your Clientld amp accountID YourAccountld amp seq SeqNumber amp destination comma separated destination MSISDN amp source SourceAddress amp data 0FAA0B12FF amp udh 050403158a158a Example http lt domain gt HTTPConnector SendMessage login user amp password pass amp clientlD 90 0 amp accountlD 1719 amp destination 944799xxxx 944644xxxx 989900xxxx 980961xxxx amp seq 1234567890 amp sour
8. e post back URL specified XSIT2 HTTP GATEWAY USER MANUAL 12 Page Att mobile XSIT2 gateway tries to dispatch the delivery report as and when it is received In case server application at the client side is not running no retry attempts are made for redelivery of the Delivery Report But the client can contact the XSIT2 support team to know the status of previously made MT pushes Format of Delivery Report The Delivery Report pushed by XSIT2 HTTP Gateway to the post back URL would contain the following parameters SI No Parameter Description Status Status value returned by the operator in Delivery Report followed by the subscribed error code Both are separated with a colon Time Time of delivery MessagelD Same as the message id that was send when request was made Destination The destination MSISDN The status value present in Delivery Report follows SMPP version 3 4 protocol specifications Please refer SMPP Protocol version 3 4 Appendix B to know more about the possible error codes XSIT2 HTTP GATEWAY USER MANUAL 13 Page Att mobile Sample script for accepting Delivery Report package com sitmobile import java io IOException import java util HashMap import java util Map import javax servlet RequestDispatcher import javax servlet ServletException import javax servlet http HttpServlet import javax servlet http HttpServletRe
9. ient will contain message ids of each part Domain to connect to the HTTP gateway http httpgateway sitmobile com The application URL may change Please contact SIT Mobile support in case of any difficulty Format Sending a single message http lt domain gt HTTPConnector SendMessage login lt YourLogin gt amp password lt YourPasswo rd gt amp clientID lt YourClientID gt amp accountID lt YourAccountID gt amp destination lt DestinationNumber gt amp text lt YourMessage gt amp seq lt Unique sequence ID gt amp source lt Source gt Example Sending a single message http lt domain HT TPConnector SendMessage login user amp password password amp clientID 1 20 O amp accountID 927 1 9 amp destination 230998877661 1 amp text hello amp seq 1 23 amp source admin When the HTTP Gateway receives an MT push request it responds with a unique message identifier sequence number status and the response message This can be kept by the client for their reference If the message is more than 160 characters XSIT2 HTTP gateway will split the message into multiple parts and each part will get a message id The response send back to the client for these messages will contain multiple lines with the messageid corresponding for each part Response Format For a normal standard SMS with text less than 160 characters response send will be of the following format RESP CONC false gt lt SEQ 1 MID 1720260 STA OK gt XSIT2
10. livery report The clients also have to setup an application listening at the post back URL that accepts some variable parameters from either HTTP GET or HTTP POST request We have provided a sample code for accepting the values send by XSIT2 HTTP Gateway XSIT2 HTTP GATEWAY USER MANUAL 15 Page Att mobile MT Request M essage ID ej XSIT2 HTTP Gateway SMS Sent Status DELIVRD MessageID 919496825331 Time Fri Oct 08 07 40 28 BST 2010 Destination 9 19497274729 Post Back Server 16 Page XSIT2 HTTP GATEWAY USER MANUAL Att mobile ERROR MESSAGES XSIT2 HTTP Gateway provides user readable error messages for invalid http push requests The following table describes the error messages SI No 1 Error message Required parameter cannot be null Please check your credential Please check your balance M essage Sending is not allowed during blackout period M essage length exceeded Received M essage length YYY M aximum Length Allowed XXX Description Sequence number of the message sent by the client When client authentication fails When client goes out of credits When client sending messages during black out time Time period at which SM S sending is banned messages will be restricted in case the client is enabled this feature Client is sending the message and if the message length is more than the allowed character limit for any mes
11. quest import javax servlet http HttpServletResponse public class DRHandler extends HttpServlet private static final long serialVersionUID 11 public void doGet HttpServletRequest req HttpServletResponse resp throws ServletException IOException System out println Getting content from SITMobile Map regMap req getParameterMap if reqMap containsKey Status System out printin STATUS reqMap get Status esas ees l System out printin TIME reqMap get Time RR T A System out printin MessageID reqMap get MessageID CR TR System out println Destination regMap get Destination XSIT2 HTTP GATEWAY USER MANUAL 14 Page Att mobile GENERIC ARCHITECTURE The messaging system allows the client to send SMS and receive Delivery Reports This requires a client application which can send messages to XSIT2 HTTP Gateway The communication between this gateway and the client uses http protocol in both directions XSIT2 has a page Servlet where the clients can submit their MT messages XSIT2 will return a message id with the sequence number client sent This message id can be used by clients for their reference Optionally client can also subscribe for delivery report which will be sent to the client once the operator delivers the message The clients need to register their post back URL with HTTP XSIT2 Gateway if they opt to receive the de
12. sage type it will send this error message to the client XSIT2 HTTP GATEWAY USER MANUAL 17 Page Att mobile GLOSSARY XSIT2 HTTP Gateway A gateway which accepts HTTP messages from another system and use SIT SMPP gateway to process the message HTTP gateway acts as an intermediate between a sender and XSIT2 allowing them to share information by communicating between protocols common to them MT Message A message is sent from an originator to a mobile where the message is either received or if the recipient device is unavailable stored for later delivery A delivery report or failure report is then sent back to the SC These messages may be input to the Service center by other mobile users via a mobile originated short message or by a variety of other sources Bulk Message Bulk Message is a mobile messaging service that allows companies to send high or low volumes of SMS quickly and efficiently to a list of destinations Delivery report Delivery report is generated for each individual message These provide details relating to the delivery status of the message in the operator network XSIT2 HTTP GATEWAY USER MANUAL 18 Page
13. tails please contact SIT Mobile Support XSIT2 HTTP GATEWAY USER MANUAL 3 Page Asttmobile Sending a message To start messaging other than the above four parameters XSIT2 HTTP gateway need few more parameters List of parameters XSIT2 HTTP gateway accepts are listed below Sl No Field Description login Login name assigned by SITM obile il 2 password Password assigned by SITM obile 5 clientID Client ID assigned by SITM obile 4 5 accountiD Account ID assigned by SITM obile Sequence number which client needs to send with each request Should be unique for each message 6 text Actual message to be sent 7 destination Destination M SISDN 8 source Source M SISDN 9 wapurl The URLfor WAP push mclass The message class 191 data Binary data 12 udh UDH value for Binary message Among those listed above login password clientID accountID destination and seq are mandatory And either text or data field should be there If source is missing XSIT2 will add its own source and process the message Destination should not contain any special character For example a number in UK will take the form 441122112211 Submission request with text or data length more than standard short message length will be XSIT2 HTTP GATEWAY USER MANUAL 4 Page Att mobile spitted into multiple parts The response send back to the cl
Download Pdf Manuals
Related Search