中国电信集团公司企业标准(SMGP协议)(v13).doc

中国电信集团公司企业标准中国电信集团公司企业标准 CT T 1 2001 基于固定电话网的信息终端及综合信息系统技术规范基于固定电话网的信息终端及综合信息系统技术规范 第七分册第七分册 短消息网关 短消息网关 SMGPSMGP 协议协议 V1 3V1 3 2002 04 30 发布 2002 04 30 实施 中国电信集团公司 发布 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 1 页 目目 录录 前前 言言 3 1适用范围适用范围 4 2引用标准引用标准 4 3缩略语缩略语 4 4SMGP 概述概述 4 4 1 SMGP 功能 4 4 2 SMGP 定义 4 4 3 SMGP 通信流程 5 5SMGP 数据包定义数据包定义 7 5 1 数据包结构 7 5 2 请求标识说明 7 5 3 包体结构 8 6编码说明编码说明 16 6 1 短消息格式代码表 16 6 2 收费类型代码表 16 6 3 短消息状态表 16 6 4 Err 错误代码表 17 6 5 Status 错误代码表 17 7基于基于 SMGP 协议的协议的 API 函数函数 18 附录附录 A 基于基于 SMGP 协议的协议的 API 函数说明函数说明 19 提示的附录提示的附录 19 A 1 基本要求 19 A 2 API 数据结构说明 以 C 语言为例 20 A 3 API 函数说明 22 A 3 7 查询短消息流量 SMGPQuery 可选 26 A 4 配置 SMGP API 26 A 5 短信的自动分割功能 27 A 6 错误代码含义 28 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 2 页 前前 言言 本标准介绍综合信息平台系统短消息网关和服务提供商内容提供商 SPCP 之间 短消息网关和短消息网关之间的通信协议 本协议简称 SMGP Short Message Gateway Protocol 本标准起草单位 中国电信集团公司 中国电信集团公司上海研发中心 本标准主要起草人 特别感谢 亚信科技中国有限公司在本协议制订过程中的大力支持和帮助 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 3 页 1适用范围适用范围 本协议适用于短消息网关开发商和短消息服务提供商内容提供商 2引用标准引用标准 SMPP Short Message Peer to Peer Protocol Specification v3 4 3 3缩略语缩略语 见总册 4SMGP 概述概述 4 1 SMGP 功能功能 网关通信 SMGP 协议是短消息服务提供商内容提供商与短消息网关 以及 短消息网关与短消息网关之间的通信协议 SMGP 可以实现以下功能 1 服务提供商内容提供商向综合信息平台综合信息系统短消息用户发送 短消息 例如邮件通知 天气预报等 2 综合信息平台综合信息系统短消息用户向服务提供商内容提供商点播 信息 例如查询股票查询信息 航班信息等 3 服务提供商内容提供商以某个短消息用户的身份向综合信息平台综合 信息系统短消息用户发送传情信息 例如图片传情 音乐传情等 4 综合信息平台综合信息系统短消息用户发送的短消息通过短消息网关 前转发送给异地的短消息用户 4 2 SMGP 定义定义 网关通信 SMGP 协议是一个基于数据包的交互式协议 底层通过 TCP IP 协 议传递数据 每个数据包都包含请求标识 代表数据包的用途 服务提供商内 容提供商与短消息网关或者短消息网关与短消息网关之间采用 cClient serverServer 的方式交互信息 客户端向服务器端发送一个请求包 服务器 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 4 页 端向客户端返回回应包 客户端发送的所有请求包都包含一个唯一的序列号 服务器端返回的回应 包也带有相应的序列号 以便客户识别这是哪一个请求的回应 客户端和服务器端之间可以采用长连接或者短连接的方式通信 如果采用 短连接 客户端必须以发送者 接收者或收发者的身份登录到服务器 通信完 毕后断开连接 如果采用长连接 一旦认证通过建立连接 客户端与服务器端 可以随时通信 在一定时间内两者之间没有发送合法的请求包 连接就中断 4 3 SMGP 通信流程通信流程 网关与 ICPCP 之间通信连接采用端口号 8890 网关与网关通信连接采用 端口号 8900 4 3 1 SMGP 登录模式登录模式 在 SMGP 协议的一个会话中客户端可以采用三种登录方式与服务器端相连 发送模式 send mode 接收模式 receive mode 和收发模式 transmit mode 在发送模式中客户端只能发送短消息 在接收模式中客户端只能接收短消息 在收发模式中客户端即可既可以发送也可以接收短消息 三种模式均可以采用 长连接与短连接两种连接方式的一种 根据实际情况选择 4 3 2 SPCP 发送短消息发送短消息 SPCP 以发送者或者是收发者身份登录后 就可以发送短消息 SPCP 可以 不等待上一个短消息发送回应包 就发送下一个短消息 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 5 页 CP SMGW login send transmit mode login resp submit 1 submit 2 submit resp 1 submit resp 2 exit exit resp 4 3 3 SPCP 接收短消息接收短消息 SPCP 以接收者或者是收发者身份登录后 短消息网关就向 SPCP 下发 MO 发送短消息 短消息网关可以不等待上一个下发 MO 短消息回应包 就下发发 送下一个 MO 短消息 SPCP SMGW login receive transmit mode login resp deliver 1 deliver 2 deliver resp 1 deliver resp 2 exit 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 6 页 exit resp 4 3 4 SMGW 转发短消息转发短消息 短消息网关需要把异地 MT MO 短消息转发到相应的短消息网关 在转发 短消息之前短消息网关需要通过对方网关认证 SPCP SMGW longin send receive transmit mode longin resp forward 1 forward 2 forward resp 1 forward resp 2 exit exit resp 5SMGP 数据包定义数据包定义 SMGP 基本数据类型定义如下表所示 Integer无符号整数 Octet String 定长字符串 位数不足时 如果左补 0 则补 ASCII 表示的 0 如果右补 0 则补二进制表示 的 0 5 1 数据包结构数据包结构 SMGP 数据包分为包头和包体两部分 包头的结构如下 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 7 页 字段字段长度 字节 长度 字节 数据类型数据类型说明说明 PacketLength4Integer数据包长度 包头和包体的长度 之和 单位 字节 RequestID4Integer请求标识 SequenceID4Integer序列号 由客户端分配 循环递 增 5 2 请求标识说明请求标识说明 请求标识 RequestID 标识数据包的类型 请求包的请求标识和回应包的 请求标识一一对应 请求名称请求名称请求标识请求标识说明说明 login0 x00000001SPCP 或 SMGW 登录请求 login resp0 x80000001SPCP 或 SMGW 登录回应 submit0 x00000002SPCP 发送短消息请求 submit resp0 x80000002SPCP 发送短消息回应 deliver0 x00000003SMGW 向 SPCP 发送短消息请求 deliver resp0 x80000003SMGW 向 SPCP 发送短消息回应 active test0 x00000004测试通信链路是否正常请求 由客户端发起 SPCP 和 SMGW 可以通过定时发送此请求来 维持连接 active test resp0 x80000004测试通信链路是否正常回应 forward0 x00000005SMGW 转发 MT MO 短消息请求 forward reCP0 x80000005SMGW 转发 MT MO 短消息回应 exit0 x00000006退出请求 exit resp0 x80000006退出回应 query0 x00000007CP 发送短信状态统计查询请求 query resp0 x80000007CP 短信状态统计查询结果回应 mt route update0 x00000008MT 路由更新请求 mt route update r esp 0 x80000008MT 路由更新回应 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 8 页 mo route update0 x00000009MO 路由更新请求 mo route update resp 0 x80000009MO 路由更新回应 5 3 包体结构包体结构 5 3 1 login 字段字段长度长度数据类型数据类型说明说明 User ClientID 118Octet Stringstrin g SPCP 编号或者 SMGW 编号 编号规则参见总册第六 6 节 Password AuthenticatorC lient 1016Octet String 客户端密码 用于鉴别客户端的接入请求 其值 通过单向 MD5 hash 计算得出 表示如 下 AuthenticatorClient MD5 ClientID 7 字节的 0 shared secret timestamp Shared secret 由中国电信服务器端 与 ICP 客户端事先商定 timestamp 格 式为 MMDDHHMMSS 即月日时分秒 10 位 LoginMode1Integerinte ger 登录类型 0 发送短消息 1 接收短消 息 2 转发收发短消息 其他保留 TimeStamp4Integer时间戳的明文 由客户端产生 格式为 MMDDHHMMSS 即月日时分秒 10 位数 字的整型 右对齐 Version1integer客户端支持的版本号 高位 4bit 表示 主版本号 低位 4bit 表示次版本号 5 3 2 login resp 字段字段长度 字节 长度 字节 数据类型数据类型说明说明 Result Status 4Integerinte ger login 请求返回结果 参照参见错误代码表 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 9 页 Authenticator Server 16Octet String 服务器端认证码 当客户端认证出错 时 此项为空 其值通过单向 MD5 hash 计算得出 表 示如下 AuthenticatorServer MD5 Status AuthenticatorClient shared secret Shared secret 由中国电信服务器端 与 ICP 客户端事先商定 AuthenticatorICPClient 为 ICP 客户 端发送给 SMGW 服务器端的上一条消息 login 中的值 Version1Integer服务器支持的最高版本号 5 3 3 submit 字段字段长度 字长度 字 节 节 数据类数据类 型型 说明说明 SubType1integer短消息子类型 0 取消订阅 1 订阅请求 2 点播 3 订阅 其 他保留 NeedReport1integer是否要求返回状态报告 0 不要求 1 要求 Pk id10Integer多包短消息标识 Pk total1Integer相同 Pk id 的消息总条数 从 1 开 始 Pk number1Integer相同 Pk id 的消息序号 从 1 开始 Priority1Integeri nteger 发送优先级 从 0 到 9 ServiceID10Octet Stringstr ing 服务类型业务类型 FeeType2Octet Stringstr ing 收费类型 参照参见收费类型代码 表 FeeCode6Octet Stringstr ing 资费代码 单位为分 MsgFormat1Octet 短消息格式 参照参见短消息格式 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 10 页 Stringint eger 代码表 ValidTime17Octet Stringstr ing 有效时间 格式遵循 SMPP3 3 协议 AtTime17Octet Stringstr ing 定时发送时间 格式遵循 SMPP3 3 协议 SrcTermID21Octet String 短消息发送用户号码 作为短消息回执的目的地址 ChargeTermID21Octet Stringstr ing 计费用户号码 点播 订阅 传情等业务的使用用 户号码 DestTermIDCount1Integeri nteger 短消息接收号码总数 小等于 100 DestTermID21 DestTerm Count Octet Stringstr ing 短消息接收号码 连续存储 DestTermIDCount 个号码 MsgLength1Integeri nteger 短消息长度 MsgContent 小等于 252 Octet Stringstr ing 短消息内容 Reserve8Octet String 保留 5 3 4 submit resp 字段字段长度 字节 长度 字节 数据类型数据类型说明说明 MsgID10Octet String 网关产生的短消息流水号 由三部分 组成 网关代码 3 字节 BCD 码 时间 4 字节 BCD 码 序列号 3 字节 BCD 码 Result Status 4Integerinte ger Submit 请求返回结果 参照参见错误 代码表 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 11 页 5 3 5 deliver 字段字段长度 字长度 字 节 节 数据类数据类 型型 说明说明 MsgID1Integer网关产生的短消息流水号 由三部 分组成 网关代码 3 字节 BCD 码 时间 4 字节 BCD 码 序列号 序列号 3 字节 字节 BCD 码 码 IsReport1Integeri nteger 是否状态报告 0 不是 1 是 MsgFormat1Integeri nteger 短消息格式 参照参见短消息格式 代码表 RecvTime14Octet Stringstr ing 短消息接收时间 格式 yyyymmddhhmiss 例如 20010301200000 SrcTermID21Octet Stringstr ing 短消息发送号码 DestTermID21Octet Stringstr ing 短消息接收号码 MsgLength1Integeri nteger 短消息长度 MsgContent 小等于 252 Octet Stringstr ing 短消息内容 Reserve8Octet String 保留 5 3 6 deliver resp 字段字段长度 长度 长度 长度 数据类型数据类型说明说明 MsgID1Integer网关产生的短消息流水号 由三部分 组成 网关代码 3 字节 BCD 码 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 12 页 时间 4 字节 BCD 码 序列号 3 字节 BCD 码 Result Status 4integerDeliver 请求返回结果 参照参见错误 代码表 5 3 7 active test 没有包体 5 3 8 acitve test resp 没有包体 5 3 9 forward 字段字段长度 长长度 长 度 度 数据类数据类 型型 说明说明 MsgID10Octet String 网关产生的短消息流水号 由三部 分组成 网关代码 3 字节 BCD 码 时间 4 字节 BCD 码 序列号 3 字节 BCD 码 DestSMGWNo6Octet Stringstr ing 目标网关代码 SrcSMGWNo6Octet Stringstr ing 源网关代码 SMCNo6Octet String 短消息中心代码 SMType1Integeri nteger 短消息类型 0 MT 1 MO 2 异地点到点短消息 3 异网点到 点短消息 其他保留 SubType1integer短消息子类型 0 取消订阅 1 订阅请求 2 点播 3 订阅 其 他保留 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 13 页 ReportFlag1Integeri nteger 当 SMType 0 时 表示是否要求返 回状态报告 0 不要求 1 要求 当 SMType 1 时 表示是否状态报 告 0 不是 1 是 Pk total1Integer多包消息总条数 从 1 开始 Pk number1Integer多包消息序号 从 1 开始 Priority1Integeri nteger 发送优先级 从 0 到 9 ServiceID10Octet Stringstr ing 服务类型业务类型 FeeType2Octet Stringstr ing 资费类型 参照参见收费类型代码 表 FeeCode6Octet Stringstr ing 资费代码 单位为分 MsgFormat1Integeri nteger 短消息格式 参照参见短消息格式 代码表 ValidTime17Octet Stringstr ing 有效时间 格式遵循 SMPP3 3 协议 AtTime17Octet Stringstr ing 定时发送时间 格式遵循 SMPP3 3 协议 SrcTermID21Octet String 短消息发送用户号码 DestTermID21Octet String 短消息接收用户号码 ChargeTermID21Octet String 计费用户号码 MsgLength1Integeri nteger 短消息长度 MsgContent 小等于 252 Octet Stringstr ing 短消息内容 Reserve8Octet String 保留 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 14 页 5 3 10 forword resp 字段字段长度长度 长度长度 数据类型数据类型说明说明 MsgID10Octet String 网关产生的短消息流水号 Pk total1Integer多包消息总条数 从 1 开始 Pk number1Integer多包消息序号 从 1 开始 Result Status 4Integerinte ger Forward 请求返回结果 参照参见错误 代码表 5 3 11 exit 没有包体 5 3 12 exit resp 没有包体 5 3 13 query 保留 保留 字段名字节数属性描述 Time8 Octet String查询时间 格式 yyyymmdd 精确 到日 Query Type1 Integer查询类别 0 总数查询 1 按业务代码查询 其他保留 Query Code10 Octet String查询码 1 业务类型 5 3 14 query resp 保留 保留 字段名字节数属性描述 Time8 Octet String查询时间 格式 yyyymmdd 精 确到日 Query Type1 Integer查询类别 0 总数查询 1 按业务代码查询 1当 Query Type 为 0 时 此项无效 当 Query Type 为 1 时 此项填写业务代码 Service id 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 15 页 其他保留 Query Code 10Octet String查询码 业务类型 MT TLMsg4 Integer从 SP 接收信息短消息总数 MT Tlusr4 Integer从 SP 接收用户总数 MT Scs4 Integer成功转发数量 MT WT4 Integer待转发数量 MT FL4 Integer转发失败数量 MO Scs4 Integer向 SP 成功送达数量 MO WT4 Integer向 SP 待送达数量 MO FL4 Integer向 SP 送达失败数量 Reverse8 Octet String保留 5 3 15 mt route update 保留 保留 字段名字段名字节数字节数属性属性描述描述 UpdateType1Integer0 添加 1 删除 2 更新 其他保留 RouteId4Integer路由编号 若 update type 为 添 加 则此字段为零 SrcGatewayId6Octet String源网关代码 SrcGatewayIP15Octet String源网关 IP 地址 SrcGatewayPort2Integer源网关 IP 端口 StartTermId6Octet StringMT 路由起始号码段 EndTermId6Octet StringMT 路由截止号码段 AreaCode4Octet String终端所属区号 5 3 16 mt route update resp 保留 保留 字段名字段名字节数字节数属性属性描述描述 Status1Integer参照参见错误代码表 5 3 17 mo route update 保留 保留 字段名字段名字节数字节数属性属性描述描述 UpdateType1Integer0 添加 1 删除 2 更新 其他保留 RouteId4Integer路由编号 若 update type 为 添加 则此字段为零 SrcGatewayId6Octet String源网关代码 SrcGatewayIP15Octet String源网关 IP 地址 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 16 页 SrcGatewayPort2Integer源网关 IP 端口 SrcTermID21Octet StringICP 代码 5 3 18 mo route update resp 保留 保留 字段名字段名字节数字节数属性属性描述描述 Status1Integer参照参见错误代码表 5 3 19 状态报告格式状态报告格式 字段字段长度长度数据类型数据类型说明说明 MsgIDid10Octet Stringstrin g 短消息标识状态报告对应原短消息的 MsgID Submit date14Octet Stringstrin g 短消息提交时间 格式 yyyymmddhhmiss 例如 010331200000 done date14Octet Stringstrin g 短消息下发时间 格式 yyyymmddhhmiss 例如 010331200000 Status7Octet Stringstrin g 短消息状态 参照参见短消息状态表 Err3Octet Stringstrin g 参见错误代码表 修改密码格式修改密码格式 字段字段长度长度数据类型数据类型说明说明 OldPassword10Octet Stringstrin g 旧密码 NewPassword10Octet Stringstrin g 新密码 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 17 页 6编码说明编码说明 6 1 短消息格式代码表短消息格式代码表 代码代码含义含义 0ASCII 编码 3短消息写卡操作 4二进制短消息 8UCS2 编码 15含 GB 汉字 6 2 收费类型代码表收费类型代码表 代码代码含义含义 00免费 01按条收费 02包月 03封顶 其他保留 6 3 短消息状态表短消息状态表 状态名状态名状态值状态值 字符串字符串 说明说明 DELIVEREDDELIVRD短消息转发成功 EXPIREDEXPIREDEXPIRED短消息超过有效期 DELETEDDELETED短消息已经被删除 UNDELIVERABLEUNDELIV短消息是不可转发的 ACCEPTEDACCEPTD短消息已经被最终用户接收 为保持与 SMPP 兼容 保留 UNKNOWNUNKNOWN未知短消息状态 REJECTEDREJECTD短消息被拒绝 为保持与 SMPP 兼容 保留 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 18 页 6 4 Err 错误代码表错误代码表 状态值状态值 字符串字符串 说明说明对应状态对应状态command status 对应值对应值 Command st atus 代码代码 000成功DELIVRDESME ROK0 x00000001 001用户不能通信EXPIREDESME RUSRABS ENT 0 x00000400 002用户忙EXPIREDESME RUSRUS Y 0 x00000401 003终端无此部件号UNDELIVESME RNOPAR T 0 x00000402 004非法用户UNDELIVESME RUSRINV ALID 0 x00000403 005用户在黑名单内UNDELIVESME RBLACK LIST 0 x00000404 006系统错误UNDELIVESME RSYSERR OR 0 x00000405 007用户内存满EXPIREDESME RMEMCA P 0 x00000406 008非信息终端UNDELIVESME PROTOC OLERROR 0 x00000407 009数据错误UNDELIVESME DATAER ROR 0 x00000408 010数据丢失UNDELIVESME DATAMIS SING 0 x00000409 注 err 错误代码的定义对应了 SMPP 协议包头中 command status 字段的 相应状态值 6 5 Status 错误代码表错误代码表 代码代码含义含义 0成功 1非法数据包系统忙 2登录失败超过最大连接数 3 9非法发送优先级保留 410非法资费类型消息结构错 511非法资费代码命令字错 612非法短消息格式序列号重复 713 19非法有效时间保留 820非法定时发送时间 IP 地址错 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 19 页 921非法短消息发送号码认证错 1022非法短消息接收号码版本太高 1123 29非法短消息长度保留 1230非法目标网关代码非法消息类型 SMType 1331非法源网关代码优先级 Priority 1432非法转发短消息接收号码资费类型 FeeType 1533非法资费代码 FeeCode 修改密码失败 1634保留非法短消息格式 MsgFormat 35非法时间格式 36非法短消息长度 MsgLength 37有效期已过 38非法查询类别 QueryType 39路由错误 40 127保留 128 255厂家自定义 7基于基于 SMGP 协议的协议的 API 函数函数 详见附录 A 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 20 页 附录附录 A 基于基于 SMGP 协议的协议的 API 函数说明函数说明 提示的附录提示的附录 A 1 基本要求基本要求 A 1 1 安装安装 网关需要提供 API 软件包 解压到指定目录下后可以修改配置文件 配置 参数至少包括 IcpId ICP 编号 IcpShareKey ICP 密码 ClientIP 客户主机 的 IP 地址 和 ServerIP 短信网关地址 A 1 2 例子程序例子程序 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 21 页 网关至少应该提供以下例程 供 ICP 调试使用 分别为 Connect 参数 检查是否能够成功登录短消息网关 TestAPI 参数 检查是否能够成功连接短信网关 SetKey 参数 修改 ICP 密码 SendSM 参数 尝试发送短信 RecvSM 参数 尝试接收短信等 RecvSMReport 参数 尝试接收短消息状态报告 A 1 3 操作系统平台要求操作系统平台要求 网关提供的 API 软件包至少要求支持以下操作系统平台 Free BSD 3 x 4 2 Solaris 5 6 5 7 5 8 包含 x86 Linux Redhat 和 Slack 等主流产品 Windows NT 2000 等 网关提供的 API 软件包至少要求支持以下编程语言 C C JAVA A 2 API 数据结构说明 以数据结构说明 以 C 语言为例 语言为例 A 2 1 接收短信的返回数据结构 接收短信的返回数据结构 DeliverResp 用途 保存 SMGPDeliver 函数返回的短信内容 字段说明 字段名字段名数据类型数据类型说明说明 sMsgIDChar 11 短消息标识 nMsgFormatInt短消息格式 参照短消息格式代码表 网 关不做判定 透明传输 sSrcTermIDChar 22 短消息发送用户号码 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 22 页 nIsReportInt是否为应答信息 代码含义 非应答信息 0 应答信息 1 nMsgLenInt消息长度 sMsgContentChar 201 消息内容 sDestTermIDchar 21 CP 的接入代码 sRecvTimechar 15 短消息接收时间 格式 yyyymmddhhmiss 例如 20010301200000 A 2 2 获取群发短信的返回数据结构 获取群发短信的返回数据结构 SendBatchResp 用途 使用 SMGPSendBatch 群发短信后 每条短信的 消息标识 和 错误代 码 保存在文件里 SMGP API 提供 GetSendBatchResp 函数获取每一条短信返 回信息 保存在 SendBatchResp 中 字段说明 字段名字段名数据类型数据类型说明说明 sMsgIDChar 11 短消息标识 nErrorCodeInt错误代码 参照错误代码表 sPhoneNoChar 22 发送号码 A 2 3 查询短消息网关的返回数据结构 查询短消息网关的返回数据结构 QueryResp 可选 可选 用途 保存 SMGPQuery 函数返回的查询结果 字段说明 字段名字段名数据类型数据类型说明说明 nMT TLMsgInt接收短消息总数 nMT TLusrInt接收用户总数 nMT ScsInt成功转发数量 nMT WTInt待转发数量 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 23 页 nMT FLInt转发失败数量 nMO ScsInt成功送达数量 nMO WTInt待送达数量 nMO FLInt送达失败数量 A 3 API 函数说明函数说明 A 3 1 初始化初始化 API InitSMGPAPI 作用 初始化 SMGP API 应用程序只需要调用一次此函数 参数 参数名参数名数据类型数据类型说明说明 SiniFileChar 100 SMGPAPI 配置文件名 缺省值是 config smgpc ini 如果应用程序的执行目录不在 smgpapi bin 下 就 需要通过绝对或相对路径指定 sINIFile 例如 InitSMGPAPI opt smgpapi config smgpc ini 返回 0 成功 1 失败 A 3 2 发送单条短信 发送单条短信 SMGPSendSingle 作用 向短消息网关发送 1 条短消息到 1 个终端用户 短消息长度最长为 200 SMGP API 在发送时自动建立 Connection Pool 采用长连接或者短连接发送短 消息 当 Cache 的 connection 中断时 API 能够自动重新连接短消息网关 如 果应用程序采用多线程发送短消息 多个线程共享同一个 Connection Pool 在 发送过程中 如果因为通信原因导致发送失败 API 能够自动重新发送 重试 的次数在配置文件设置 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 24 页 参数 参数名参数名数据类型数据类型说明说明 nNeedReportInt是否要求返回状态报告 0 不要求 1 要求 nMsgLevelInt信息级别 0 9 0 最低优先级 sServiceIDChar 11 业务类型 nMsgFormatInt短消息格式 参照短消息格式表 网关不做判定 透明传输 sFeeTypeChar 3 资费类别 sFeeCodeChar 7 资费代码 以分为单位 sValidTimeChar 18 存活有效期 格式遵循 SMPP3 3 协议 sAtTimeChar 18 定时发送时间 格式遵循 SMPP3 3 协议 sChargeTermI D Char 22 计费号码 sDestTermIDChar 22 短消息接收号码 nMsgLenInt短消息长度 sMsgContentChar 短消息内容 nMsgLen 0 时表示存放短消息的文件 名 sMsgIDChar 11 返回的短消息标识 nErrorCodeInt 错误代码 参照错误代码表 返回 0 成功 1 失败 A 3 3 群发短信 群发短信 SMGPSendBatch 作用 向短消息网关发送 1 条短消息到多个手机用户 短消息长度最长为 200 此函数使用文件传递短消息内容 SMGP API 在发送时自动建立 Connection Pool 采用长连接或者短连接发送短消息 当 Cache 的 connection 中断时 API 能够自动重新连接短消息网关 如果应用程序采用多线程发送短消息 多个线 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 25 页 程共享同一个 Connection Pool 在发送过程中 如果因为通信原因导致发送失 败 API 能够自动重新发送 重试的次数在配置文件设置 参数 参数名参数名数据类型数据类型说明说明 nNeedReportint是否要求返回状态报告 0 不要求 1 要求 nMsgLevelint信息级别 0 最低优先级 1 正常 2 紧急 3 十分紧急 sServiceIDChar 11 业务类型 nMsgFormatInt短消息格式 参照短消息格式表 网关不做判 定 透明传输 sFeeTypeChar 3 资费类别 sFeeCodeChar 7 资费代码 以分为单位 sValidTimeChar 18 存活有效期 格式遵循 SMPP3 3 协议 sAtTimeChar 18 定时发送时间 格式遵循 SMPP3 3 协议 sSrcTermIDChar 22 短消息发送用户号码 当为 CP 代码时须在前面 加 118 sChargeTermIDChar 22 计费号码 若为空 则对被叫计费 sDestTermIDFileChar 100 保存所有目的号码的文件名 nMsgLenInt消息长度 sMsgContentChar 短消息内容 nMsgLen 0 时表示存放短消息的文 件名 sMsgIDFileChar 100 保存所有短消息的返回 MsgID 和 ErrorCode 的文 件名 sSubTypeChar 2 短消息子类型 返回 0 成功 1 失败 A 3 4 获取群发短信的结果 获取群发短信的结果 GetSendBatchResp 作用 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 26 页 从文件里读取群发的某一个短信的标识 发送结果和发送号码 参数 参数名参数名数据类型数据类型说明说明 sMsgIDFileChar 100 保存所有短消息的返回 MsgID 和 ErrorCode 的文件 名 nPosInt短消息位置 从 0 开始 pSendBatchRe sp SendBatch Resp 用于保存结果的 SendBatchResp 结构指针 返回 0 成功 1 失败 A 3 5 接收短信 接收短信 SMGPDeliver 作用 连接短信网关 等待接收属于本 ICP 的短信 参数 参数名参数名数据类型数据类型说明说明 nTimeoutint等待时间 单位 秒 0 表示永远等待 pDeliverRespDeliverRe sp 保存短消息的 DeliverResp 结构指针 返回 0 成功 1 失败 A 3 6 检查短信网关是否能够提供服务 检查短信网关是否能够提供服务 CMMPActiveTest 作用 检查短信网关是否能够提供服务 参数 参数名参数名数据类型数据类型说明说明 nErrorCodeInt 错误代码 参照错误代码表 基于固定电话网的信息终端及综合信息系统平台技术规范 第七分册 第 27 页 返回 0 成功 1 失败 A 3 7 查询短消息流量 查询短消息流量 SMGPQuery 可选 可选 作用 向短消息网关查询某天的短消息流量 参数 参数名参数名数据类型数据类型说明说明 sDateChar 10 查询日期 格式 yyyymmdd nQueryTypeInt查询类型 0 总数查