无线天利通用业务接口协议(cbip)api说明 文档java版

《无线天利通用业务接口协议(cbip)api说明 文档java版》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、无线天利移动信息化服务平台通用业务接口协议CommonBusinessInterfaceProtocol版本号：1.0.1客户端API说明文档-ForJavaEdition2010-04-20发布北京无线天利移动信息技术有限公司发布2010-04-20实施北京无线天利移动目录1.客户端API安装31.1API压缩包31.2环境变量配置32.客户端API配置文件说明32.1客户端配置信息32.2日志记录配置信息43.客户端API数据结构说明43.1手机上行类IDeliverReceiver43.2状态报告返回类IReportRe

2、ceiver53.3信息发送类ISubmitSender64.客户端API调用类示例说明84.1客户端启动84.2接收手机上行94.3接收下行状态报告94.4短信下行104.5彩信下行104.6彩信资源发送125.客户端API开发建议135.1准备工作135.2开发建议136.附录146.1错误代码表141.客户端API概述API包采用框架结构，对外解决所有通信和协议问题，对内开放回调接口，二次开发工作简化为：重载实现接口类、生成接口类实例、将实例挂接到框架上，框架就会自动回调相应接口函数，完成数据收发。API包对通信作了很好

3、的包装，解决连接建立、连接保持等协议问题；用类对协议数据作了包装，并对非必填字段赋了默认值，开发时只需填写必填字段即可。通信机制是异步通信机制，请求不等响应立即返回，响应回来通过回调函数通知，请求和响应之间是通过标识匹配，后面的具体描述中有详细说明。2.客户端API配置文件说明11.1客户端配置信息客户端配置文件为：config.properties。此配置文件主要配置了与服务器端的程序进行通信的相关信息，开发人员可以只修改相关配置并实现例程中的读取配置项的相关程序，即可实现程序与服务器侧的通信的长连接。具体配置请参看配置文件

4、中标有【酌情修改】字样的字段。名称实例名称说明下行服务器主机ipAPI服务器端主机IP地址下行端口号portAPI服务器端主机端口号客户端IDclientId客户端登录服务器端ID客户端用户名loginName客户端登录服务器端用户名客户端密码password客户端登录服务器端密码长号码longCode长号码值暂时不用submitPath暂时不用resourceFilePath暂时不用copyPath暂时不用resourceIdFilePath滑动窗口大小controlWindowSize最大允许等待response响应的下行

5、数量彩信资源保持时间keepDate上传彩信资源保持存在的时间客户端系统处理父类maxQueueSize客户端系统处理配置信息父类滑动窗口的清理时间clearTimeOut设置滑动窗口的清理时间，单位为：毫秒滑动窗口的休眠时间clearSleepTime设置滑动窗口的休眠时间，单位为：毫秒系统间隔时间idleTime长连接链路检测包发送时间间隔，单位为：秒接收缓存大小inBufferSize接收缓存大小，单位为：Bytes发送缓存大小outBufferSize发送缓存大小，单位为：Bytes1.1日志记录配置信息Logback

6、Config.xml相关日志记录的log4j配置文件可以自行修改。1.客户端API数据结构说明22.1手机上行类IDeliverReceiver²IDeliverReceiver类说明：类方法：publicvoidreceive(Standard_Deliverobj)接收手机上行信息²Standard_Deliver类说明：类属性：序号参数名说明是否必填参数类型字段长度1srcMobile源手机号是OctetString212destNumber目的号码（默认填写""）OctetString213messageFormat消

7、息的编码格式0ASCII串3短信写卡操作4二进制信息8UCS2编码15GBK编码Integer24serviceCode上行的业务代码（运营商产生）OctetString105linkID临时订购关系（默认填写""）OctetString206operatorID运营商编号1移动2联通3Integer2电信7provinceID省编号（默认填写0）（保留字段，暂无意义）Integer28cityID市编号（默认填写0）（保留字段，暂无意义）Integer29channelID渠道编号（默认填写0）（保留字段，暂无意义）Inte

8、ger410messageType消息的类型（默认填写0）（保留字段，暂无意义）Integer211userLevel用户级别（默认填写0）（保留字段，暂无意义）Integer212reserve保留字段（默认填写""）OctetString2013messageLength