电信企信通2.0_API-jar包说明.doc

江苏电信企信通2.0系统 API接口说明 联创科技（南京）有限公司 版本号 日期 编写者 修改内容 1.0 2010-07-06 李波 发送短信方法sendMsg增加连接出错时的返回值。 11个类：MsgConst、 NetMd5 、NetMsgclient、Constants、Parse、ReturnMsgBean、UpMsgBean、AnswerBean、HeartBeatInit、HeartBeatPacket、HeartBeatTask 1个抽象类：ReceiveMsg 企信通API：NetMsgclient 1．API函数介绍 1.初始化函数 ,根据API用户名和密码等信息，初始化Socket连接 返回类型 NetMsgclient 参数 数据类型 描述 约定 ipAddress String API公网接连IP地址 218.94.58.243 port String API访问端口号 9005 username String 用户名 password String 密码 receiveMsg ReceiveMsg 用户继承的ReceiveMsg实现类的实例 public NetMsgclient initParameters(String ipAddress,int port,String username,String password,ReceiveMsg receiveMsg) 2.认证请求函数，根据用户名和密码登录至企信通API服务端进行认证。 返回类型 boolean 认证成功:true,认证失败:false public boolean anthenMsg(NetMsgclient client)throws IOException 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，和sedMsg方法返回的seqId来对应。 如果连接出现异常，sendMsg方法会返回16，用户也可以根据判断这个值来调用断开函数closeConn(这样就不使用jar包里自带)，然后继续重新连接（参照发送消息流程说明）。 参数 数据类型 描述 约定 client NetMsgclient NetMsgclient类的实例 sendType int 发送方式 是否快速发送 1：是，0：否 recPhone String 接受号码 完整的带区号的小灵通或者手机号码 msg String 发送内容 500个字节 汉字最多250个 isNeedReport int 是否需要回执 0:不需要 1：需要 4.关闭连接的函数，NetMsgclient 类的closeConn函数 public void closeConn()说明： 调用该函数，即关闭发送短信的连接与接收短信回执的连接，调用断开函数后不要马上重连，需要休眠一段时间，比如1分钟。 5.接收下行短信返回状态及msgId的函数 public void getAnswer(AnswerBean answerBean)说明 注：此函数是接收上行短信 参数 数据类型 描述 约定 answerBean AnswerBean 下行短信返回状态类 企信通API会将下行短信返回的序列ID、状态及msgId送往此函数，用户使用时，需要实现该函数，自行处理获取的上行短信 public void getAnswer(AnswerBean answerBean) 使用时，需要继承jar包中的ReceiveMsg类，继承重写该类的getAnswer方法，企信通平台会将发送短信的响应传递到这个方法，用户重写时，将接收到的参数解析然后自行处理即可。 AnswerBean说明： 属性名 数据类型 描述 seqId String 下行短信序列ID status int 下行短信响应状态 msgId String 下行短信的msgId，由企信通平台生成，用来标识一条短信 下行短信发送状态（即AnswerBean类的status