江苏电信企信通API接口说明文档
sendMsg (NetMsgclient client ,int sendType, String recPhone, 普通发送短信String msg,int isNeedReport) 函数 sendMsgWithSrcNum(NetMsgclient client, int sendType, String 模拟主叫发送srcNum, String recPhone, String msg, int isNeedReport) 短信函数 sendProxyMsgMobile(NetMsgclient client ,int sendType,String 天翼招财宝发recPhone,String msg,int isNeedReport,String mobile) 送短信函数 sendProxyMsg( NetMsgclient client, int sendType, String recPhone, String 代理API发送msg, int isNeedReport, String sendNum, String connId ) 短信函数 关闭连接函数 void closeConn()
3.2.1.1. 初始化函数
public
NetMsgclient
initParameters(String
ipAddress,int
port,String
username,String password,ReceiveMsg receiveMsg)
根据API用户名和密码等信息,初始化Socket连接 返回类型 NetMsgclient 参数 ipAddress port username password 数据类型 String String String String 描述 API公网接连IP地址 API访问端口号 用户名 密码 用户继承的receiveMsg ReceiveMsg ReceiveMsg实现类 的实例
3.2.1.2. 认证请求函数
public boolean anthenMsg(NetMsgclient client)throws IOException
第23页
约定 202.102.41.101 9005 江苏电信企信通API接口说明文档
根据用户名和密码登录至企信通API服务端进行认证。 返回类型 boolean 认证成功:true,认证失败:false
3.2.1.3. 普通发送短信函数
登录成功后发送短信的函数,返回类型 String,返回9位数的序列。 public String sendMsg (NetMsgclient client ,int sendType, String recPhone, String msg,int isNeedReport)
返回值类型 String 类型,sendMsg方法返回一个9位数的序列ID,具体为:6位时间(时分秒)+3位序列,用户可以在接收到该序列ID时,可以在序列ID前边增加日期,在getAnswer (AnswerBean answerBean)方法中,可以通过answerBean.getSeqId()获得序列ID,和sendMsg方法返回的seqId来对应。
如果连接出现异常,sendMsg方法会返回16,用户也可以根据判断这个值来调用断开函数closeConn(这样就不使用jar包里自带),然后继续重新连接(参照发送消息流程说明)。
参数 client 数据类型 NetMsgclient 描述 NetMsgclient类的实例 发送类型 0:计费号码发送 1:绑定号码轮询 完整的带区号的小灵通或recPhone String 接受号码 者手机号码 500个字节 汉字最多250个 0:不需要 1:需要 约定 sendType int msg isNeedReport
String int 发送内容 是否需要回执 3.2.1.4. 关闭连接的函数
第23页
江苏电信企信通API接口说明文档
public void closeConn()
调用该函数,即关闭发送短信的连接与接收短信回执的连接,调用断开函数后不要马上重连,需要休眠一段时间,比如1分钟。
3.2.2. ReceiveMsg抽象类
该接口定义的方法如下:
方法名称 void getUpMsg(UpMsgBean pMsgBean) void getReturnMsg(ReturnMsgBean returnMsgBean) void getAnswer(AnswerBean answerBean)
3.2.2.1. 接收下行短信回应的函数
public void getAnswer(AnswerBean answerBean)
参数 数据类型 描述 约定 企信通API会将下行短信返回的序列answerBean AnswerBean 下行短信返回状态ID、状态及msgId送往此函数,用户类 使用时,需要实现该函数,自行处理获取的上行短信
public void getAnswer(AnswerBean answerBean)
使用时,需要继承jar包中的ReceiveMsg类,继承重写该类的getAnswer方法,企信通平台会将发送短信的响应传递到这个方法,用户重写时,将接收到的参数解析然后自行处理即可。
AnswerBean说明:
第23页
功能 接收下行短信返回状态及msgId的函数 接收上行短信的函数 接收下行短信回执的函数 江苏电信企信通API接口说明文档
属性名 seqId status msgId 数据类型 String int String 描述 下行短信序列ID 下行短信响应状态 下行短信的msgId,由企信通平台生成,用来标识一条短信
下行短信发送状态(即AnswerBean类的status属性)定义: 成功 系统错误 帐号错误 密码错误 连接数超过限制 秒发送条目数超过限制 目的号码受限制 网络错误 月发送条目数超过限制 客户端关闭连接 短信网关关闭连接 超时退出 连接数据库错误 连接短信网关错误 非法发送内容 非法发送时间 socket连接已经关闭 发送号码前缀错误
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 23 3.2.2.2. 接收上行短信的函数
第23页
江苏电信企信通API接口说明文档
public void getUpMsg(UpMsgBean pMsgBean)
参数 数据类型 描述 约定 企信通API会将上行短信送往此函数,用pMsgBean UpMsgBean 上行短信类 户使用时,需要实现该函数,自行处理获取的上行短信 使用时,需要继承jar包中的ReceiveMsg类,继承重写该类的getUpMsg方法,企信通平台会将接收到的上行短信传递到这个方法,用户重写时,将接收到的参数解析然后自行处理即可 UpMsgBean说明:
属性名 sequenceId sendNum receiveNum msgRecTime msgContent
3.2.2.3. 接收回执的函数
public void getReturnMsg(ReturnMsgBean returnMsgBean)
参数 数据类型 ReturnMsgBean 描述 约定 企信通API会将回执送往此函数,用户returnMsgBean 短信回执类 使用时,需要实现该函数,自行处理获取的短信回执 数据类型 String String String String String sequenceId 上行短信发送号码 上行短信接收号码 上行短信到达时间 上行短信内容 描述
使用时,需要继承jar包中的ReceiveMsg类,继承重写该类的getReturnMsg方法,企信通平台会将接收到短信的回执传递到这个方法,用户重写时,将接收到的参数解析然后自行处理即可 ReturnMsgBean类说明
第23页