ISMP网关API开发手册(JAVA)

ISMP网关API开发手册（JAVA语言版）1ISMP网关API开发手册（SMGP协议JAVA语言版）深圳协尔信息系统有限公司2004．12ISMP网关API开发手册（JAVA语言版）2修改记录日期修改版本描述作者2003.81.0初稿编写曾宪志2004.8.61.0修改JDK的版本说明（由1.4改为1.3.1）和部分描述曾宪志2004.8.301.0配置参数“RequestTimeout”单位由“秒”改为“毫秒”；新增群发的接口”SMGPSendMulti”曾宪志ISMP网关API开发手册（JAVA语言版）3目录1.概述..........................................................................................................................................42.安装说明...................................................................................................................................53.配置说明...................................................................................................................................54.数据结构定义...........................................................................................................................64.1submitStruct..............................................................................................................64.2deliverStruct..............................................................................................................74.3deliverMsg................................................................................................................85.API函数介绍...........................................................................................................................85.1InitSMGPAPI............................................................................................................85.2SMGPSendSingle......................................................................................................85.3SMGPSendMulti.......................................................................................................95.4SMGPDeliver............................................................................................................95.5SMGPActiveTest.....................................................................................................105.6intSMGPDisconnect()............................................................................................106.附录1:FAQ............................................................................................................................117.附录2错误代码..................................................................................................................118.附录3短消息格式表............................................................................................................129.附录4短消息参数表............................................................................................................1310.附录5Demo程序使用简介.......................................................................................13ISMP网关API开发手册（JAVA语言版）41.概述ISMP网关SMGPAPI针对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方法。ISMP网关API开发手册（JAVA语言版）52.安装说明1.API是基于JDK1.3.1运行开发，如果版本比这个低，有可能会产生运行时错误；2.将smgpApi.jar文件加入CLASSPATH；3.在调用的API的class中导入：“importcom.ut.smgp.api.*”“importcom.ut.smgp.api.structure.*”3.配置说明API开发包采用配置文件smgpc.ini需要配置，以下是配置文件配置项的说明：名称说明CpIdCP编号，必须与License的一致。CpShareKeyCP的密码，如果填写不正确会导致应用程序不能通过SMGP用户认证。ServiceMode取值1为“收发公用收发类型接口”，取值2为“收发分别用独立的接收接口和发送接口”ClientIP客户主机的IP地址，必须填写接入Internet的公网地址。如果主机是通过Gateway接入Internet，就填写Gateway地址。此项配置填写错误会导致应用程序不能通过网关对CP的IP地址校验。SubmitRetry发送短消息自动重试次数（1表示只发送1次，0不重新发送）RequestTimeout发送请求超时时间，这个参数要配置成大于0，否则会返回运行时错误，单位：毫秒ActiveTestCycle握手间隔时间，单位毫秒ActiveTestRetryactivetest的重试次数，若重复多次没能连接，则重新建立通讯端口。ServerIP短消息网关的IP地址ServerPort短消息网关的端口ISMP网关API开发手册（JAVA语言版）64.数据结构定义4.1submitStruct字段数据类型说明msgTypeint短消息类型（1＝取消订阅，2＝订阅请求，3＝点播，4＝订阅，5＝交互式操作，6=查询，其他保留）needReportint是否要求返回状态报告（0=不要求，1=要求）priorityint发送优先级（从0到9）serviceIdString业务类型feeTypeString收费类型（参见第7.2节收费类型代码表）feeCodeString资费代码（单位为分）按条扣费时填写fixedFeeString包月费/封顶费（单位为分）包月扣费时填写msgFormatint短消息格式（参见第7.1节短消息格式代码表）validTimeString有效时间，格式遵循SMPP3.3协议atTimeString定时发送时间，格式遵循SMPP3.3协议srcTermIdString短信息发送方的电话号码（格式为“电话号码*子信箱号“），当短消息来自CP时，电话号码为118+CPID或者发送方主叫号码。chargeTermIdString计费用户号码destTermIdCountint短消息接收号码总数（≤100）destTermIdString[]短消息接收号码（多个DestTermIDCount号码，每一个接收方号码的的最长长度为21，格式为“电话号码*子信箱号ISMP网关API开发手册（JAVA语言版）7“，’0’表示公共信箱,’1’表示一号子信箱,’2’表示二号子信箱,’3’表示三号子信箱msgLengthint短消息长度msgContentbyte[]短消息内容。对应于不同的业务，短消息内容域具有不同的格式。reserveString保留msgIdStringsubmitresponse信息中的msgId信息，submit发送成功后msgId的数值才有效，否则为空。4.2deliverStruct字段数据类型说明m