《cbip20 java api参考手册》由会员分享，可在线阅读，更多相关《cbip20 java api参考手册（19页珍藏版）》请在金锄头文库上搜索。
1、 CBIP2.0 Java API 参考手册CBIP2.0 Java API参考手册2012年03月30日文档修改记录编号修改内容类型更新人更新时间目录目录1API总体介绍41.1作用与目标41.2功能清单51.3程序包说明51.4JDK版本52接口列表52.1主动发送接口（短信、彩信、彩信资源）52.2被动发送接口（短信、彩信）62.3接收Response接口62.4接收Report、Deliver接口73使用说明73.1API与Server的交互过程73.2API使用说明83.3彩信发送的两种方式103.4获取API连接状态113.5初始化参数114协议对象列表124.1上行短信对象（Cb
2、ipDeliver）124.2状态报告对象（CbipReport）134.3下行短信对象（CbipSubmit）134.4下行短信、彩信响应对象（CbipSubmitResp）144.5下行彩信对象（CbipSubmitMms）144.6彩信资源对象（CbipContentMms）164.7彩信资源响应对象（CbipContentMmsResp）174.8CbipResourceContent174.9CbipIndividual175示例175.1短信主动发送175.2短信被动发送185.3彩信主动发送185.4彩信被动发送185.5彩信资源发送以及带彩信资源彩信的发送191 API总体介绍
3、1.1 作用与目标该API是无线天利移动信息技术股份有限公司（以下简称无线天利）对CBIP2.0协议的标准实现，采用的是Java语言。CBIP2.0是无线天利短彩信服务平台翼信通2.0系列产品对外公开的Socket接口协议，该协议允许向基于翼信通2.0系列产品建设的系统发送短信、彩信、WapPush消息，实现应用对接。该协议可以用任何开发语言实现。该API的目的是方便机构客户侧的业务系统的调用，从而快速接入翼信通2.x系列产品。接入需要实现短信、彩信、WapPush的单发、群发，并对单发、群发进行一些发送控制实现，如定时发送、组包发送、优先级、状态报告接收、上行接收等。1.2 功能清单Java
4、 API是对CBIP2.0协议的Java语言实现，他具有以下功能：l 完全实现了CBIP2.0协议（CBIP2.0协议请参考附件）；l 提供登录、连接服务端的接口；l 提供短信发送接口，分主动和被动调用；l 提供彩信发送接口，分主动和被动调用；l 提供短信、彩信的状态报告接收接口；l 提供短信、彩信的上行接收接口；l 提供彩信资源发送接口；1.3 程序包说明l lxt2_client_api-2.1.0.0-SNAPSHOT.jar。CBIP2.0的Java实现核心包。l lib/。依赖的第三方包，注意是否和自身环境已经有的包存在冲突。1.4 JDK版本使用的jdk版本：jdk 1.6及以上。
5、2 接口列表2.1 主动发送接口（短信、彩信、彩信资源）/* * 主动数据发送接口，可以发送短信（CbipSubmit）、彩信（CbipSubmitMms）、彩信资* 源（CbipContentMms） */public interface IActiveSubmitSender /* * 同步彩信资源发送 * 该方法为同步方法，多线程同时调用会加锁 * param submit 彩信资源对象 * return 彩信资源发送响应数据 */ IApiSubmitResp sendMMSContent(IApiSubmit submit); /* * 下行数据主动发送 * param submit
6、 下行数据对象（非彩信资源对象） */ public void sendSubmit(IApiSubmit submit);2.2 被动发送接口（短信、彩信）/* * 被动数据发送接口，可以发送短信（CbipSubmit）、彩信（CbipSubmitMms）、不能单* 独发送彩信资源（CbipContentMms），彩信资源可作为和CbipSubmitMms一起发送 */public interface IPassiveSubmitSender /* * 下行数据获取 * return 下行数据(不包含彩信资源数据) */public IApiSubmit getSubmit();2.3 接收
7、Response接口/* * 下行短信、彩信数据，服务端返回的response接收接口，属于异步接收。彩信资源* Response获取是同步的，发送后直接获取。 * 供用户实现后回调 */epublic interface IRespReceiver /* * Resp消息接收响应 * param submit 下行数据，当response返回时如果下行数据过已被清理，则为null * param response 下行数据响应（服务器返回数据） */ void receive(IApiSubmit submit, IApiSubmitResp response);2.4 接收Report、D
8、eliver接口/* * 上行数据（Deliver）和状态报告（Report）接收接口 * 主要为用户实现后数据回调 */public interface IReceiver /* * 接收数据 * param data 通信平台发送来的数据 */void receive(P data);3 使用说明3.1 API与Server的交互过程通信交互过程中均采用异步方式，即任一个网元在收到请求消息后应立即回送响应消息。用户上行信息时，交互应答如图3.1-1所示：合作方业务系统用户终端2、运营商上行1、用户发送上行移动运营商移动信息化服务平台3、运营商上行响应4、CbipDeliver5、CbipD
9、eliverResp运营商协议CBIP2.0协议图 3.1-1 CBIP用户上行交互应答示意图合作方业务系统下行信息时，交互应答如图3.1-2所示：合作方业务系统10、CbipReportResp6、用户返回状态5、用户收到下行1、CbipSubmit2、CbipSubmitResp、Standard_Submit_Resp3、运营商下行4、运营商下行响应7、运营商状态报告8、运营商状态报告响应9、CbipReport运营商协议CBIP2.0协议用户终端移动运营商移动信息化服务平台图3.1-2 CBIP合作方业务下行交互应答示意图3.2 API使用说明API对于连接管理进行了封装，开发者不用显
10、式的对连接进行管理。只要启动了客户端引擎就能够自动向服务端发起连接请求，从而建立连接。API可以使用的接口主要是接口列表所示内容，调用接口所涉及的协议对象参见协议对象列表。下行发送采用主动和被动两种机制。主动就是实例化一个短信，或者彩信，或者彩信资源的对象，将其作为参数传递给发送接口进行发送。Response、Report是通过被动监听的方式接收的，需要实现一个接口，自动监听收到的信息。被动就是将短信，或者彩信的对象放到指定的缓存里面，由API自动获取数据发送。主动和被动的区别。两者都是实现发送的方式，实现的功能都是一样的。被动方式更灵活，但是需要开发者自己实现接口。主动方式更容易理解，做了预
11、实现。图2.2-1是主动发送的一个比较简单的例子说明。左边代码块部分是主动发送的一个过程说明，总共分为五步。第一步是初始化配置参数，比如服务器IP、端口，登录用账号、密码等。第二步是启动客户端引擎，启动的时候需要传入Response、Report、Deliver的接收器实现类，启动之后这三个实现类就开始监听服务端发送过来的Response、Report、Deliver。第三步就是创建一个短信对象，可以给短信对象指定手机号码、发送内容等信息。第四步是实例化主动发送类。第五步是调用主动发送类的sendSubmit()方法发送短信。短信发送出去之后，服务端返回的Response、Report、Del
12、iver可以在其各自的实现类里面进行异步接收。右边图示主要是为了说明Response、Report、Deliver的接收类需要分别实现三个接口，这样其不同的Handler就可以主动将返回的信息传递给具体的实现类。图2.2-1 主动发送说明图2.2-2是被动发送的例子说明，和图2.2-1不同的是被动发送在客户端引擎启动的时候还要注册被动发送实现类。这样的话Submit、Response、Report、Deliver四个对象都是被动发送的方式，他们各自实现自己的接口，并由各自的Handler或者Controller去调用。被动发送的时候需要在被动发送实现类里面传递短信对象，最简单的例子就是直接在P
13、assiveSubmitSender的getSubmit()方法中new一个CbipSubmit对象返回。但是我们一般来说都会发送一批，所以往往是采用缓存的方式实现，这样生产短信的逻辑往缓存里面放，PassiveSubmitSender的getSubmit()方法从缓存里面取，如代码块例子所示。图2.2-2 被动发送说明3.3 彩信发送的两种方式彩信资源作为彩信内容的一部分可以和彩信一起发送给服务端，也可以分别发送给服务端，所以发送彩信有两种方式：第一种，先发送彩信资源，再发手机号码等内容。先按照发送彩信资源（主动调用）发送彩信，获得资源彩信资源ID sysResourceID，然后按照发送彩
14、信（主动调用）的方式携带彩信资源编号进行发送，如下。submitMMS.addMessageContentID(bcf9cb57-9229-f54e-9d4e-2890989aa9ab);第二种，彩信资源和号码等内容一起发。CbipSubmitMms submitMMS=new CbipSubmitMms();/ 添加smil类型文件String txtName = mms.smil;File tempFile = new File(./彩信资源/mms.smil);byte smilContent = mons.io.FileUtils.readFileToByteArray(tempFile);su
