小灵通短信网关 API 开发手册(JAVA 语言版)
1
小灵通短信网关 API 开发手册
(SMGP 协议 JAVA 语言版)
UT 公司
2003.8
小灵通短信网关 API 开发手册(JAVA 语言版)
2
修改记录
日期
修改版本
描述
作者
2003.8
1.0
初稿编写
曾宪志
Commented [P1]: 用于说明对文档加附页或文
档版本升级时对文档的改动情况,一般设计类文
档需要
小灵通短信网关 API 开发手册(JAVA 语言版)
3
目 录
1. 概述 ...........................................................................................................................................4
2. 安装说明 ...................................................................................................................................5
3. 配置说明 ...................................................................................................................................5
4. 数据结构定义 ...........................................................................................................................6
4.1 Submit 消息体(submitStruct)...............................................................................6
4.2 Submit Response 消息体(submitRespStruct) ......................................................7
4.3 Deliver 消息体(deliverStruct).............................................................................7
4.4 Deliver Response (deliverRespStruct).......................................................................8
5. API 函数介绍............................................................................................................................8
5.1 InitSMGPAPI.............................................................................................................8
5.2 SMGPSendSingle ......................................................................................................9
5.3 SMGPDeliver.............................................................................................................9
5.4 SMGPActiveTest .......................................................................................................9
5.5 int SMGPDisconnect().............................................................................................10
6. 附录 2 错误代码 ..................................................................................................................10
7. 附录 3 短消息格式表 ............................................................................................................12
8. 附录 4 短消息参数表 ............................................................................................................12
9. 附录 5 Demo 程序使用简介 ...............................................................................................12
小灵通短信网关 API 开发手册(JAVA 语言版)
4
1. 概述
小灵通短消息网关 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 方法。