实施 MASAPI接口说明(JAVA)

《实施 MASAPI接口说明(JAVA)》由会员分享，可在线阅读，更多相关《实施 MASAPI接口说明(JAVA)（47页珍藏版）》请在金锄头文库上搜索。

1、实施 MASAPI 接口说明(JAVA)实施 MASAPI 接口说明(JAVA) 目录 Error! Unknown document property name. Error! Unknown document property name. ii Error! Unknown document property name. 文档版本 Error! Unknown document property name. (Error! Unknown document property name.) 目录目录 1 总体说明 1-11 总体说明 1-1 1.1JAVA 接口概述 1-2 1.2 读者范围

2、 1-2 1.3 相关约定 1-2 2API 说明 2-12API 说明 2-1 2.1API 概述 2-2 2.2 基本数据类型介绍 2-3 2.3 数据结构详细描述 2-3 2.4 接口介绍 2-7 2.4.1DBSMProxy2-7 2.4.2initConn2-7 2.4.3initConn2-8 2.4.4initConn2-9 2.4.5sendSm2-9 2.4.6sendMultiSm2-10 2.4.7getReceivedSms2-11 2.4.8querySmsResult2-12 2.4.9login2-12 2.4.10isConnected2-13 目录 Error

3、! Unknown document property name. Error! Unknown document property name. iv Error! Unknown document property name. 文档版本 Error! Unknown document property name. (Error! Unknown document property name.) 2.4.11logout2-13 2.4.12destroy2-13 3 安装使用指导 3-153 安装使用指导 3-15 3.1 介绍安装 JAVASMSAPI3-1 3.2 导入开发库 3-1 3

4、.3 方法调用 3-1 4 示例代码 4-14 示例代码 4-1 4.1 初始化连接对象并登录 4-2 4.2 发送短信 4-2 4.3 查询短信发送情况 4-4 4.4 查询短信接收情况 4-4 4.5 销毁连接或者退出登录 4-5 5 配置文件说明 5-15 配置文件说明 5-1 5.1Apiconf.xml5-2 表格目录表格目录 表 2-1JavaAPI 的短信接口 2-2 表 2-2 基本数据类型简介 2-3 表 2-3SmReceiveBean 字段说明 2-3 表 2-4SmSendBean 字段说明 2-4 表 2-5SmSendResultBean 字段说明 2-6 1 总体

5、说明总体说明 关于本章 本章描述内容如下表所示。 标题内容 1.1 JAVA 接口概述介绍 JAVA 接口的背景知识。 1.2 读者范围介绍本手册的读者对象。 1.3 相关约定介绍本手册的相关约定。 1 总体说明 Error! Unknown document property name. Error! Unknown document property name. 1-2 Error! Unknown document property name. 文档版本 Error! Unknown document property name. (Error! Unknown document pro

6、perty name.) 1.1 JAVA 接口概述 为了企业用户更加简便、灵活地实现相关的业务，企业业务系统可以接入 MAS （MobileAgentServer）的应用开发接口。MAS 以 JAVA 的方式封装其短信接口，提供给 企业应用系统调用。 该 JAVA 组件封装的对象可以提供短信单发接口、数据库初始化接口、用户登录初始化 接口、短信接收接口、短信查询接口，其中短信查询接口用于查询已经发送的短信的 情况。 该版本不提供短信群发接口和点点通短信接口。 1.2 读者范围 本手册适用于华为公司 MAS 开发人员，企业 IT 管理、维护部门的相关开发人员。 1.3 相关约定 在本文中，每个

7、 API（ApplicationProgrammingInterface）函数的描述由四部分组 成：函数功能、函数原型、参数说明和返回码/值。 函数功能 描述 API 的主要功能。 函数原型 描述 API 原型，可直接拷贝程序中的函数原型代码。 参数说明 名称：参数名称 如何理解：对参数的简单解释 备注：输入/输出参数的相关信息 返回码/值 API 调用过程中的返回码/值，分为成功时的返回和异常返回。如果是异常返回，分别 对每一个可能的异常进行详细描述，包括异常名称及相应说明。 2 API 说明API 说明 关于本章 本章描述内容如下表所示。 标题内容 2.1 API 概述介绍 JAVA 短信

8、 API 的基本组成。 2.2 基本数据类型介绍各类数据结构介绍。 2 API 说明 Error! Unknown document property name. Error! Unknown document property name. 2-2 Error! Unknown document property name. 文档版本 Error! Unknown document property name. (Error! Unknown document property name.) 2.1 API 概述 本文档定义了开发程序和 MAS 之间的所有短信 API，如表 2-1 所示。 表

9、2-1 JavaAPI 的短信接口 序 号 接口名称描述 1publicDBSMProxy()建立一 个和 MAS 短 信接口 访问的 代理对 象。 2publicfinalvoidinitConn()throwsException初始化 和 MAS 系统的 连接。 3publicfinalvoidinitConn(StringconfFile)throwsException初始化 和 MAS 系统的 连接。 4publicfinalvoidinitConn(Mapargs)throwsException初始化 和 MAS 系统的 连接。 序 号 接口名称描述 5publicfinalintS

10、endSm(SmSendBeansendBean)throwsException发送短 消息接 口消 息。 6intsendMultiSm(SmSendBeansendBean)发送短 消息接 口，提 交一条 群发消 息到 MAS 的 发送消 息队 列。 7getReceivedSms(intmaxCount,java.util.DatefromTime,java.util.DateendTime,java.lang.StringorgAddr,java.lang.StringdestAddr)throwsjava.lang.Excepti on 从 MAS 接收的 消息队 列中获 取消 息。

11、 8publicfinalSmSendResultBeanquerySmsResult(intsm_id,java.util.DatefromTime,java.util.DateendTime,StringorgAddr,StringdestAddr)throwsException查询短 消息发 送结 果。 2 API 说明 Error! Unknown document property name. Error! Unknown document property name. 2-4 Error! Unknown document property name. 文档版本 Error! Un

12、known document property name. (Error! Unknown document property name.) 序 号 接口名称描述 9publicfinalvoidlogin(StringuserName,Stringpassword)throwsException根据用 户名、 密码登 录系 统，登 录 MAS， 如果失 败抛出 异常。 10booleanisConnected()判断 API 是 否已经 和 MAS 建立了 连接。 序 号 接口名称描述 11publicfinalvoidlogout()退出登 录函数 仅仅清 理当前 的用 户，可 以在此 基

13、础上 再次登 录，连 接仍然 是存在 的。 12publicfinalvoiddestroy()销毁函 数，将 清理连 接，关 闭数据 库连 接。 2.2 基本数据类型介绍 短信 API 中各种基本数据类型表示如下。 2 API 说明 Error! Unknown document property name. Error! Unknown document property name. 2-6 Error! Unknown document property name. 文档版本 Error! Unknown document property name. (Error! Unknown d

14、ocument property name.) 表2-2 基本数据类型简介 名称如何理解 SmSendBean短信发送的消息结构体。 SmReceiveBean接收消息的结构体描述。 SmSendResultBean发送结果的消息体描述。 2.3 数据结构详细描述 SmReceiveBean 接收消息的结构体描述。从 MAS 中获取消息，获取完成之后自动在 tbl_smreceived 表 中把 Reserve1 字段配置为 1。结构体各字段的说明请参见表 2-3。 SmReceiveBean 继承于 SmSendBean。 表2-3 SmReceiveBean 字段说明 字段名字段类型字段说

15、明 smActionIDprivatejava.lang.Stri ng 接收消息的请求类型。CMPP （ChinaMobilePeertoPeer）3 消 息点播使用，参见 CMPP3 协议。 SMPP（ShortMessagePeertoPeer） 不使用。 smActionReasonIDprivatejava.lang.Stri ng 接收消息的请求原因。CMPP3 消息 点播使用。SMPP 不使用。 字段名字段类型字段说明 smDestAddrprivatejava.lang.Stri ng 接收消息的目的地址，对应的就是 SP 的接入号。 smIdprivateint接收消息 id

16、（唯一标识），为-1 的时候表明此消息为无效消息。 smMessageIDprivatejava.lang.Stri ng 接收消息的类型。CMPP3 消息点播 使用。SMPP 不使用。 smMsgContentprivatejava.lang.Stri ng 接收消息的消息内容。 smOrgAddrprivatejava.lang.Stri ng 接收消息的源地址，对应于发送方 手机号码。 smOrgAddrTypeprivateint接收消息的源地址类型，包括两种 类型： 掩码 真实手机号码 CMPP3 消息点播使用。SMPP 不使 用。 smRecvTimeprivatejava.util.Date接收消息的接收时间。 smReserve1privatejava.lang.Stri ng 接收消息的保留标识，暂时没有使 用。 smReserve2privatejava.lang.Stri ng 接收消息的保留标识，暂时没有使 用。 smServiceIDprivatejava.lang.Stri ng 接收消息的请求业务 id。CMPP3 消 息点