江苏电信企信通客户端 API接口说明文档（Java）
（V1.3）
联创亚信科技(南京)有限公司
2013年4月
江苏电信企信通API接口说明文档
文档修改记录 文档版本 V1.0 V1.1 V1.2 V1.3
修改人 马婧 马婧 马婧 刘宾鸿 修改时间 2012-11-9 2012-11-27 2013-1-21 2013-2-4 修改内容 新建 添加字符集和测试部署步骤 添加代理API发送短信函数 添加天翼招财宝发送接口 第23页
江苏电信企信通API接口说明文档
目 录
1. 概述 ......................................................................................................................... 4
1.1. 阅读对象 ...................................................................................................... 4 1.2. 项目背景 .................................................................... 错误！未定义书签。 2. 环境准备 ................................................................................................................. 4
2.1. 开发环境 ...................................................................................................... 4 2.2. 使用该包说明 .............................................................................................. 4 2.3. 定义类 .......................................................................................................... 4 2.4. 词汇定义 ...................................................................................................... 5 3. API接口定义 ......................................................................................................... 5
3.1. 接口说明 ...................................................................................................... 5 3.2. 接口描述 ...................................................................................................... 5
3.2.1. 3.2.2.
NetMsgclient类 ................................................................................. 5 ReceiveMsg抽象类 ........................................................................... 8
4. 代码示例 ............................................................................................................... 12
4.1. 发送下行短信 ............................................................................................ 12
4.1.1. 4.1.2. 4.1.3.
流程说明 .......................................................................................... 12 代码 .................................................................................................. 13 运行结果 .......................................................................................... 16
4.2. 接收上行短信 ............................................................................................ 17
4.2.1. 4.2.2. 4.2.3.
流程说明 .......................................................................................... 17 代码 .................................................................................................. 17 运行结果 .......................................................................................... 20
4.3. 测试代码部署 ............................................................................................ 20 5. 常见问题 ............................................................................................................... 20 6. 其他 ....................................................................................................................... 22
第23页
江苏电信企信通API接口说明文档
1. 概述
1.1.
阅读对象
本文档为JAR包（sendMsg_jdk.jar）的使用说明文档，为系统设计人员或程序开发人员应用该开发包进行二次开发而编写，主要服务对象为与该项目有关的项目管理人员、系统设计人员和系统开发人员。
2. 环境准备
2.1.
开发环境
JDK版本：1.4、1.5、1.6。 操作系统：不限。 中文字符集：GBK、UTF-8
2.2. 使用说明
1、 最新版jar包的修改日期为2012-11-27，根据JDK版本，选择对应的jar
包加入到要引用的工程中。
2、 Windows平台和unix平台都能使用普通版本sendMsg_jdk1.X.jar，字符
集编码为GBK和UTF-8都可以。
3、 使用该包提供的用户接口（类）进行开发。
2.3. 定义类
11个类：MsgConst、 NetMd5 、NetMsgclient、Constants、Parse、ReturnMsgBean、UpMsgBean、AnswerBean、HeartBeatInit、HeartBeatPacket、HeartBeatTask
第23页
江苏电信企信通API接口说明文档
1个抽象类：ReceiveMsg 企信通API：NetMsgclient
2.4. 词汇定义
下行短信：企信通用户发给手机用户的短信，即企信通用户的发送短信。 回应：服务端接收到客户端提交的短信，处理之后返回的消息包，表示短信的处理结果，包括处理状态和msgId。
回执：服务端接收到的短信网关返回的响应包，表示短信的发送结果，包括msgId和下行短信状态等。
上行短信：手机用户发给企信通用户的短信，即企信通用户的接收短信。
3. API接口定义
3.1.
接口说明
本组件包括以下几个应用接口，分别如下：
接口名称 NetMsgclient ReceiveMsg
类型 类 抽象类 功能描述 发送下行信息客户端 接收上行信息处理类 3.2. 接口描述
3.2.1. NetMsgclient类
该接口定义的方法如下：
方法名称 NetMsgclient initParameters(String ipAddress,int port,String username,String password,ReceiveMsg receiveMsg) boolean anthenMsg(NetMsgclient client) 认证请求函数 功能 初始化函数 第23页