如何使用Zealware提供的SMGPAPI进行固网小灵通短信网关程序开发?
介绍如何使用zealware.com提供的SMGP接口库开发固网小灵通短信网关程序。
接口库说明
zealware提供的SMGPAPI接口库包含以下三个文件:smgp.h,smgpapi.lib,smgpapi.dll。
smgp.h是接口库的头文件,包括smgp1.38(修订整合版)的消息结构定义,和接口的导出函数定义。消息结构包括:
SMGP_HEAD 协议消息头
SMGP_SUBMIT SP下行包
SMGP_SUBMIT_RESP SP下行包应答
SMGP_DELIVER 网关上行包
SMGP_DELIVER_RESP 上行包应答
SMGP_STATUS_REPORT 状态报告
MtStr 包括消息头和下行包应答定义
MoStr 包括消息头和上行包定义
二次开发时只需要用到MtStr和MoStr两种消息。
提供的接口函数包括:
1. Start - 启动函数
定义:
SMGP_API int __stdcall Start(const char *pchSmgIp, const int nSmgPort, const char *pchClientID, const char *pchPwd, const unsigned char uchVersion, void (__stdcall *pOnDeliver)(MoStr mo), void (_stdcall *pOnSubmitResp)(MtStr mt));
参数说明:
pchSmgIp - 网关IP地址
nSmgPort - 网关端口号
pchClientID - CP编号,最长8位,不足接口库会自动补齐
pchPwd - CP的登录密码
uchVersion - 协议版本号,目前是0x13
void (__stdcall *pOnDeliver(MoStr mo)) - 处理上行消息的回调函数指针(包括MO消息和状态报告)
void (_stdcall *pOnSubmitResp)(MtStr mt) - 处理MT回复的回调函数指针(即SubmitResp)
介绍:
接口库启动,调用时传入连接网关的相关参数和消息处理回调函数指针,接口库会自动连接网关,并且启动消息手法和处理线程模块,各种处理自动进行。通过调用下面将要介绍的Submit函数,用户可以主动下发MT消息;上行消息(MO和状态报告)的接收将在接口库内自动进行,收到上行消息后,通过内部调度算法,调用用户自定义的消息处理函数pOnDeliver进行处理,消息内容作为参数传给用户定义的回调函数。当有MT应答消息返回的时候,接口库会自动调用pOnSubmitResp函数进行处理,同样,submitresp消息的内容将作为参数传给pOnSubmitResp函数。
返回值:
0 – 成功
其它 – 错误码
说明:
接口库启动后,会在当前目录生成trace.log文件,记录接口库的出错信息和运行情况,当出现错误时,可以打开trace.log文件观察具体原因。
传入回调函数指针其实比较简单,下面是例子代码:
// 处理上行消息的函数
void __stdcall OnDeliver(MoStr mo) {
if (0 == mo.pk_deliver.uchIsReport)
printf("手机号:%s, Mo内容:%s\n", mo.pk_deliver.sSrcTermId, mo.pk_deliver.MO_Msg_Content.sMsgcontent);
else
printf("Report状态:%s\n", mo.pk_deliver.MO_Msg_Content.csr.sStat);
}
void __stdcall OnSubmitResp(MtStr mtresp) {
printf("下行消息回复,SeqId = %d, MsgID = %s, Status = %d\n", mtresp.pk_head.nSeqId, mtresp.pk_submitresp.sMsgid, mtresp.pk_submitresp.nStatus);
}
int main(int argc, char* argv[])
{
int nRetCode = 0;
DWORD exitCode = 0;
WSADATA wsaData;
WSAStartup(MAKEWORD(2, 2), &wsaData);
nRetCode = Start("127.0.0.1", 8890, "SMGP", "123", 0x13, OnDeliver, OnSubmitResp);
if (0 != nRetCode) {
AfxMessageBox("Smgp Client Start Error!");
return nRetCode;
}
Release();
WSACleanup();
return 0;
}
2. submit - 提交下行消息(MT)
定义:
SMGP_API int __stdcall Submit(unsigned char uchSubType, unsigned char uchNeedReport, unsigned char uchPriority, char *pchServiceID, char *pchFeeType, char *pchFixedFee, char *pchFeeCode, unsigned char uchMsgFmt, char *pchValidTime, char *pchAtTime, char *pchSrcTermID, char *pchChargeTermID, unsigned char uchDstTermCount, char *pchDstTermID, unsigned char uchMsgLen, char *pchMsgContent, char *pchReserved, unsigned int & nSeqId);
参数说明:
uchSubType - 短消息类型(1=取消订阅,2=订阅请求,3=点播,4=订阅,5=交互式操作,6=查询,其他保留)
uchNeedReport - 是否要求返回状态报告(0=不要求,1=要求)
uchPriority - 发送优先级,0-9,填几都可以
pchSericeID - 业务类型,最长10位
pchFeeType - 收费类型,2位
00
免费
01
按条收费
02
包月
03
封顶
其他
保留
pchFixedFee - 包月费/封顶费(单位为分),六位
pchFeeCode - 资费代码(单位为分),六位
uchMsgFmt - 短消息格式
0
ASCII编码
3
短消息写卡操作
4
二进制短消息
8
UCS2编码
15
包含汉字
pchValidTime - 有效时间,格式遵循SMPP3.3协议,一般传入时填NULL即可
pchAtTime - 定时发送时间,格式遵循SMPP3.3协议,一般传入时填NULL即可
pchSrcTermId - 短消息发送用户号码118+CP代码
pchChargeTermID - 计费用户号码,最长21位。
uchDstTermCount - 短消息接收号码总数(≤100)。
pchDstTermID - 短消息接收号码(连续存储DestTermIDCount个号码)。
uchMsgLen - 消息内容长度。
pchMsgContent - 消息内容,变长,按照协议要求最大252。
pchReserved - 保留,8位,传入时填NULL即可,这里保留这个参数是为了兼容以后的协议升级。
nSeqId - MT消息的流水号,跟OnSubmitResp里面的MtStr里面的submitresp消息里面的流水号是对应的。
介绍:
提交MT下行消息的函数,所有的字段都按照smgp协议的submit消息定义,具体可以参照协议5.3.3节。
返回值:
0 – 成功
其它 – 错误码
说明:
如果由于网络原因,发送失败的话,接口库会自动重连,重新发送一次。如果Submit函数返回失败的话,表示消息根本就没有发送到网关,这是不会有submitresp返回,这时应用程序需要根据情况判断是否重发等等。(如果发到网关了,返回了submitresp,但是submitresp里面的status字段非零,表示消息已经发送到网关,只是由于字段填写错误,或者其他原因,网关没有继续往前传送,这又是另外一种错误情况了)
另外接口库还提供另外一个函数,SubmitEx。和Submit函数的功能完全一样,只是传入参数由分别的几个字段变成了smgp_submit,传入前,需要首先给mt包赋值。定义如下:
SMGP_API int __stdcall SubmitEx(smgp_submit mt, unsigned int & nSeqId)
例子代码:
int nRetCode = 0;
unsigned int nSeqId;
for (int ix=0; ix<10; ix++) {
// 此处的字段都对应协议submit消息的字段
nRetCode = Submit(1, 1, 1, "9999", "01", "3000", "02", 15, "", "", "13911638108", "13911638109", 1, "13911638110", 4, "test", "", nSeqId);
if (0 != nRetCode) {
printf("Submit Error:%d.\n", nRetCode);
}
else {
printf("Submit Success!<seqid = %d>\n", nSeqId);
}
Sleep(3000);
}
3. Release - 关闭连接,释放接口库
定义:
SMGP_API int __stdcall Release()
参数说明:
无
介绍:
停止个模块运行,关闭网关连接,释放资源。
返回值:
无
说明:
结束收发操作以后,需要调用Release函数来关闭连接,释放资源。也就是说调用Start函数以后,一定要调用Release函数。