ISMP网关PI开发手册.docVIP

ISMP网关API开发手册 （SMGP协议JAVA语言版） 深圳协尔信息系统有限公司 20XX．12 修改记录 日期 修改版本 描述 作者 2003.8 1.0 初稿编写 曾宪志 2004.8.6 1.0 修改JDK的版本说明（由1.4改为1.3.1）和部分描述 曾宪志 2004.8.30 1.0 配置参数“RequestTimeout”单位由“秒”改为“毫秒”； 新增群发的接口”SMGPSendMulti” 曾宪志 目 录 1. 概述 4 2. 安装说明 5 3. 配置说明 5 4. 数据结构定义 6 4.1 submitStruct 6 4.2 deliverStruct 7 4.3 deliverMsg 8 5. API函数介绍 8 5.1 InitSMGPAPI 8 5.2 SMGPSendSingle 8 5.3 SMGPSendMulti 9 5.4 SMGPDeliver 9 5.5 SMGPActiveTest 10 5.6 int SMGPDisconnect() 10 6. 附录1:FAQ 11 7. 附录2 错误代码 11 8. 附录3 短消息格式表 12 9. 附录4 短消息参数表 13 10. 附录5 Demo程序使用简介 13  概述 ISMP网关SMGP API针对SMGP协议开发，具有良好的性能和扩展性，是为ICP提供的方便的应用开发工具。 本手册介绍JAVA语言版API，具体包括如下接口函数： InitSMGPAPI 获取配置文件的配置参数，初始化API的配置 SMGPSendSingle 发送短信 SMGPDeliver 接收短信和状态报告 SMGPActiveTest 检查短消息网关是否能够提供服务 SMGPDisconnect 从网关注销登录身份，中止相关线程 API说明： InitSMGPAPI只是读取配置文件初始化参数，不与网关建立连接； API采用长连接的方式连接网关，并维护连接，断连后自动重连，用户不需关心； 不同的接口实现模式（即配置文件中“ServiceMode”项配置）有不同的处理方式： ServiceMode＝1： 用户应用程序的收发采用公用的收发类型接口发送和接收消息，用户在第一次调用发送或接收函数时，API自动与网关连接，建立收发类型接口，登录网关并保持连接，断连时自动重连； 这种方式下，若用户使用多个线程处理发送或接收，则所有的发送和接收都是公用同一个收发类型接口 ServiceMode＝2： 用户应用程序的收发会采用独立的接收类型接口和发送类型接口方式工作，当用户第一次调用发送函数或接收函数时API自动与网关连接建立发送类型或接收类型的接口，登录网关并自动与网关握手保持连接。发送或接收接口建立后若连接中断，API都会自动重连并保持连接 这种方式下，若用户使用多个线程处理发送或接收，所有的接收都共用同一个接收类型接口，所有的发送都共用同一个发送类型接口。 用户调用SMGPSendSingle、SMGPDeliver函数时，若API发现还没有连接登录网关或断连，API将自动连接登录。 SMGPActiveTest只是检测系统连接状态，不触发登录网关的操作； SMGPDisconnect从网关注销登录身份，断开连接； API提供的所有数据结构体的各属性均提供get、set方法。 安装说明 API是基于JDK1.3.1运行开发，如果版本比这个低，有可能会产生运行时错误； 将smgpApi.jar文件加入CLASSPATH； 在调用的API的class中导入： “import com.ut.smgp.api.*” “import com.ut.smgp.api.structure.*” 配置说明 API开发包采用配置文件smgpc.ini需要配置，以下是配置文件配置项的说明： 名称 说明 CpId CP编号，必须与License的一致。 CpShareKey CP的密码，如果填写不正确会导致应用程序不能通过SMGP用户认证。 ServiceMode 取值1为“收发公用收发类型接口”，取值2为“收发分别用独立的接收接口和发送接口” ClientIP 客户主机的IP地址，必须填写接入Internet的公网地址。如果主机是通过Gateway接入Internet，就填写Gateway地址。此项配置填写错误会