DWG SMS JAVA SDK. public SendSMSResult sendsms(string text, SendSMSParam[] params);

Transcription

1 DWG SMS JAVA SDK SEND SMS API1 public SendSMSResult sendsms(string text, SendSMSParam[] params); API2 public SendSMSResult sendsms(string text, SendSMSParam[] params,int[] ports); API3 public SendSMSResult sendsms(string text, SendSMSParam[] params,smsencodingenum encoding); API4 public SendSMSResult sendsms(string text, SendSMSParam[] params, int[] ports, SMSEncodingEnum encoding); text :The content of SMS, support grammar like #param# params:each element is an Object, which included : number: a digit string no more than 24 bytes text_param: an array of string, each element used to replace #param# in the text user_id: an integer greater than or equal 0. It is used to match send sms result. ports:port array for sending.each port should be an integer range from 0 to 31.if you add this parameter,all ports are available encoding :could be "unicode" or "gsm-7bit".if you do not add it,default is "unicode". String text = "name:#param#" + "format name:#param#" + "eamil:#param#"; SendSMSParam[] params = new SendSMSParam[1]; params[0] = new SendSMSParam();

2 params[0].setnumber(" "); params[0].setuserid(100); List<String> param = new ArrayList<String>(); param.add("micle"); param.add("micle wong"); param.add("123@qq.com"); params[0].settextparam(param); SendSMSResult result = gateway.sendsms(text, params); RETURN: It will return null when exception happens. public class SendSMSResult { // 202, Request has been accepted, will process later. // 400, Request format is not valid. // 413, number over 128 or text over 1500 bytes // 500, other error // Count of SMS waiting for processed. private int smsinqueue; // You can stop this sending task by this ID later. private int taskid; QUERY SMS RESULT Api 1 public QuerySMSResult querysmsresult(string[] numbers, int[] ports,int[] userid); Api 2 public QuerySMSResult querysmsresult(string[] numbers, int[] ports, int[] userid, Date timebefore, Date TimeAfter); numbers:a number array, which should not be over 32 numbers. Each number should not be over 24 bytes. ports: Port array for sending.each port should be an integer range from 0 to 31. If you do set it null,all ports will include. userid: used to match Send Sms Request timebefore: end time,if you do not add it,no end date limit TimeAfter: start time,if you do not add it,no start date limit

3 String[] numlist = new String[30]; int[] userid = new int[30]; for(int i = 0;i<30;i++){ numlist[i] = ; userid[i] = 100; QuerySMSResult result = gateway.querysmsresult(numlist, null, userid); RETURN: public class SendSMSResult{ //400, Request format is not valid. //413, size of number array over 32 // result list private List<QuerySMSResultItem> result; public class QuerySMSResultItem { //port for sending SMS //destination number private String number; //sending time private String time; //status: sending status, which could be,failed//sending//sent_ok//delivered private String status; //count of sms segment. A long SMS would be spitted to several segments to send. private int count; // count of sms segment sent successfully private int succcount; // the first reference id of this SMS, which is used //to match SMS delivery status. Reference id is range //from 0 to 255. So it is just a reference id, it is //recommended to match a SMS result and a delivery private int refid;

4 // match with the send sms request private int userid; QUERY SMS STATUS Api 1 public QuerySMSResult querysmsresult(string[] numbers, int[] ports,int[] userid); Api 2 public QuerySMSResult querysmsresult(string[] numbers, int[] ports, int[] userid, Date timebefore, Date TimeAfter); numbers: A number array, which should not be over 32 numbers. Each number should not be over 24 bytes. ports: Port array for sending. Each port should be an integer range from 0 to 31. timebefore: String like "YYYY-MM-DD HH:MM:SS",query SMS record after this time. TimeAfter: String like "YYYY-MM-DD HH:MM:SS",query SMS record before this time. String[] numlist = new String[30]; for(int i = 0;i<30;i++){ numlist[i] = ; QuerySMSStatusResult result = gateway.querysmsdeliverstatus(numlist,null); RETURN:

5 public class QuerySMSStatusResult { //400, Request format is not valid. //413, size of number array over 32 private List<QuerySMSStatusItem> result; public class QuerySMSStatusItem { private String number; private String time; private String statuscode; private int count; private int succcount; private int refid; private int userid; QUERY SIZE OF QUEUE IN DEVICE public QuerySMSInQueue querysmsinqueue() ; QuerySMSInQueueresult = gateway.querysmsinqueue(); RETURN: public class QuerySMSInQueue{ //500: Other error

6 //count of SMS waiting to be sent private int inqueue; RECEIVE SMS public QueryIncommingSMSResult queryincomingsms(smsstatusenum flag) ; public QueryIncommingSMSResult queryincomingsms(integer incomingsmsid, SMSStatusEnum flag) ; incomingsmsid:wg will return incoming SMS which ID is greater than this value, default is 0.larger than incomingsmsid. if you don't need filter,just set it null. flag:default is "unread", Optional value is, "unread", unread SMS, which will change to read after reading it by this API. "read", read SMS "all", both of unread and read QueryIncommingSMSResult result =gateway.queryincomingsms(smsstatusenum.unread); RETRUN: public class QueryIncommingSMSResult { //count of SMS have been read private int read; //count of SMS have been unread

7 private int unread; //500: Other error private List<QueryIncommingSMSResultItem> smslist public class QueryIncommingSMSResultItem { // ID in DWG s database private int smsid; //port received the SMS //number of sender private String number; // number of SMS center private String smsc; // receiving time private String timestamp; // content of the SMS private String text; SEND USSD public SendUSSDResult sendussd(string text, int[] ports, USSDCommandEnum command) ; text :content to send, should not be over 60 bytes. if command is "send", text should not be empty if command is "cancel", text may be empty. ports :Port array for sending. Each port should be an integer range from 0 to 31. Command :could be "send" or "cancel", default is "send" */

8 String text= "*125#"; int[] ports= { 0, 1, 2, 3, 4, 5, 6, 7, 8 ; gateway.sendussd(text, ports, USSDCommandEnum.SEND); SendUSSDResult result =gateway.sendussd(smsstatusenum.unread); RETRUN: public class SendUSSDResult { //202, Request has been accepted. //400, lack of text while command is "send". private List<SendUSSDResultItem> result; public class SendUSSDResultItem { //port to send USSD //200, sent ok //486, busy, for example, sending SMS //503, not available for sending USSD private int status; RECEIVE USSD public QueryUSSDResult queryussd(int[] ports) ; PARAMETR:

9 ports: Port array for querying USSD reply. Each port should be an integer range from 0 to 31. int[] PORTS = { 0, 1, 2, 3, 4, 5, 6, 7, 8 ; QueryUSSDResult resutl = gateway.queryussd(ports); RETRUN: public class QueryUSSDResult { //400, Request format is not valid. private List<QueryUSSDResultItem> reply; public class QueryUSSDResultItem { //port for receiving USSD reply //USSD reply private String text; STOP SEND TASK public StopSMSResult stopsms(int taskid) ; PARAMETR: taskid:task id, correspond with task_id in the response of send SMS request.

10 * int TASK_ID = 11; StopSMSResult result = gateway.stopsms(task_id); RETRUN: public class StopSMSResult { //200, task has bee stop. //404, task not found QUERY PORTS INFO public QueryPortInfoResult queryportinfo(porttypeenum[] infotype, PARAMETR: int[] ports) ; infotype:an array of string, each element cloud be a string as below, type, imei, imsi, iccid, number,reg ports:port array for query. Each port should be an integer range from 0 to 31.

11 int[] PORTS = { 0, 1, 2, 3, 4, 5, 6, 7 ; PortTypeEnum[] TYPES = { PortTypeEnum.ICCID, PortTypeEnum.IMEI, PortTypeEnum.IMSI, PortTypeEnum.NUMBER, PortTypeEnum.TYPE ; QueryPortInfoResult result = gateway.queryportinfo(types, PORTS); RETRUN: public class QueryPortInfoResult { //400, Request format is not valid. private List<QueryPortInfoResultItem> info; public class QueryPortInfoResultItem { //could be GSM, CDMA, WCDMA, or UNKNOWN when type is not recognized. private String type; //IMEI of this port private String imei; //IMSI of the SIM card on this port private String imsi; //ICCID of the SIM card on this port private String iccid; //the mobile number of this SIM card private String number;