短信猫平台8.2应用说明文档.doc

第 1 页 共 28 页 短信猫二次开发平台短信猫二次开发平台 8 28 2 支持长短信收发 支持长短信收发 使 用 说 明 书 第 2 页 共 28 页 目录 一 短信服务器二次开发平台简介一 短信服务器二次开发平台简介 4 二 短信服务器二次开发平台原理二 短信服务器二次开发平台原理 5 三 短信服务器二次开发平台特点三 短信服务器二次开发平台特点 8 四 二次开发平台数据库表说明 四 二次开发平台数据库表说明 9 4 1 短信禁发词汇表 BLACKWORDTABLE 9 4 2 错误日志表 ERRORLOGTABLE 9 4 3 设备管理表 MODEMTABLE 9 4 4 用户短信条数日志表 PAYLOGTABLE 10 4 5 短信接收日志表 RECVSMSTABLE 10 4 6 待发短信表 SENDINGSMSTABLE 11 4 7 短信发送日志表 SENTSMSTABLE 11 4 8 系统日志表 SYSTEMLOGTABLE 12 4 9 用户管理表 USERTABLE 12 4 10 定时发送信息表 TIMESENDSMSTABLE 13 五 五 OEM 短信服务器产品信息短信服务器产品信息 14 5 1 开发目的 14 5 2 开发方法 14 5 3 开发难度 14 六 实现应用系统的短信功能六 实现应用系统的短信功能 15 6 1 基于命令行方式的短信功能实现 15 6 1 1使用特点 15 6 1 2开发方法 15 6 1 3开发难度 15 6 2 基于外部数据库的开发接口 16 6 2 1使用特点 16 6 2 2开发方法 16 6 2 3开发难度 18 6 3 基于系统数据库的开发接口 19 6 3 1使用特点 19 6 3 2开发方法 19 5 3 3开发难度 20 6 4 基于 SOCKET客户端的开发接口 21 6 4 1使用特点 21 6 4 2开发方法 21 6 4 3开发难度 21 6 5 基于网络客户端 OCX 控件的开发接口 22 6 5 1使用特点 22 6 5 2开发方法 22 6 5 3开发难度 24 第 3 页 共 28 页 6 6 基于 HTTP 协议的开发接口 25 6 6 1使用特点 25 6 6 2开发方法 25 6 6 3开发难度 26 七 六种开发接口的分析比较七 六种开发接口的分析比较 27 八 在八 在 MS SQL SERVER 中安装开发平台数据库中安装开发平台数据库 28 8 1 方法一 通过附加数据库方式实现 28 8 2 方法二 通过 DTS 方式实现 29 九 如何修改系统默认数据库九 如何修改系统默认数据库 30 附录附录 修订记录修订记录 30 第 4 页 共 28 页 一 短信服务器二次开发平台简介一 短信服务器二次开发平台简介 为了简化软件开发流程 减少各应用系统相同模块的重复开发工作 提高系统稳 定性和可靠性 我们开发了本套 企业短信服务器二次开发平台 功能 1 基于本短信服务器二次开发平台 可以快速地使您的应用系统实现短信 功能 多种接口方式供二次开发时选择 系统具备良好的可扩展性 功能 2 基于本短信服务器二次开发平台 可使同一网络 局域网或广域网 内 众多客户端 共享一个短信服务器进行短信收发 短信服务器具备对客户端的管理功 能 企事业单位通过短信服务器方式实现短信功能 既实现了资源的共享和有效使用 便于企业对进出信息的管理 监控和统计 同时为以后短信功能的扩展提供了便利 短信服务器二次开发平台包括了下列可使用二次开发方法 1 修改短信服务器软件界面信息 OEM 成自己的产品 2 应用系统通过命令行方式来收发短信 3 通过设置外部数据库 使应用系统实现短信收发功能 4 通过应用系统操作短信服务器数据库的方式 实现短信收发功能 5 通过 socket 客户端方式 实现应用系统的短信收发功能 6 使用短信客户端 OCX 控件 实现应用系统的短信收发功能 7 在网页上利用 HTTP 协议来发送短信 上述各种二次开发方法的具体应用场合和使用方法 在后续章节中将有详细描述 第 5 页 共 28 页 二 短信服务器二次开发平台原理二 短信服务器二次开发平台原理 下面是短信服务器原理图 下面是某市建设银行采用本短信二次开发平台时实施的系统方案图 第 6 页 共 28 页 在该方案中 考虑到银行是对信息安全性要求很高的行业 采用 GSM MODEM 作为短信 收发设备 避免了常用的通过移动互联网网关与移动短信中心相连接的方式 从而避免了 来自互联网的安全性威胁 短信收发记录采用通用数据库 如 Oracle SQL Server 等 存储 为新建系统或应用 系统新增功能提供了方便 例如 在该方案中 要对储户短信查询进行按条数计费 计费 系统可直接统计本数据库中的各储户的查询记录即可 短信服务器使用基本步骤 1 安装服务器软件 加密狗驱动程序 2 点击 开始 菜单顶部的 短信服务器 运行软件 然后点击界面 设备管理 进行设备配置 当 设备状态 是绿色的 启用 状态时 表明正常连接了设备 软件可正常工作 第 7 页 共 28 页 3 利用软件提供的 6 种开发接口进行二次开发 若设备 工作状态 是 无法启动 那么请按以上步骤检查 1 短信设备与电脑是否连接好 2 短信设备天线是否拧紧 3 短信设备插入手机卡 10 秒后 插卡旁边的工作指示灯应该是有规律的闪烁 如果 是一直红灯 表明没有插卡或者卡没有插好 卡内无话费 卡有开机密码 需要 换手机卡 第 8 页 共 28 页 三 短信服务器二次开发平台特点三 短信服务器二次开发平台特点 1 基于此平台可快速开发网络短信的应用 哪怕在不涉及编程的情况下也能够让你 的现有系统快速集成短信功能 2 方便 灵活 简单的六种开发接口供选择 任何一位软件开发人员都能选择到一 种自己得心应手的开发接口进行开发 3 采用数据库与应用系统接口 支持 WINDOWS 下的各种编程开发工具 支持常见的 数据库 如 Oracle SQL Server Access 等 4 本平台具备性能稳定的短信群发功能 5 短信服务器可以外接 20 个 GSM 模块 自动调节模块间的负载平衡 从而非常简单 地就可实现多模块并行发送扩展 6 能够控制各个 GSM 模块的发送范围 如移动或联通 能分别设定各个客户端允许 使用的 GSM 模块 以及各个客户端的使用优先级 7 短信服务器包含禁发词汇过滤功能 系统操作员可定义禁发词汇 一旦客户端提 交了包含禁发词汇的短信内容 服务器能够自动删除该短信 8 能够分别设定各个 GSM 模块的发送速度 以及实时查看各个 GSM 模块当前实际发 送速率 9 能够自动检测短信服务器上各个 GSM 模块的设备运行状况 10 能够通过手机短信远程查询服务器的运行状况 11 能够设定系统发送工作时间段 12 可按软件定义规则向各客户端转发GSM模块收到的短信 有明确转发和隐式转发 两种方式 明确转发 要求短信格式为 客户端名称 短信内容 隐式转发不要 求短信格式 服务器自动按 谁最近往该手机号码上发过短信 则转发给谁 的 原则处理 系统优先使用明确转发方式 如果明确转发方式失败 自动使用隐式 转发方式 13 短信服务器有短信发送和接收的日志记录 有收发权限管理 14 系统能实时记录完整的系统操作员的操作日志以及出错日志 15 系统维护和升级比较简单 第 9 页 共 28 页 四 二次开发平台数据库表说明 四 二次开发平台数据库表说明 4 14 1 短信禁发词汇表短信禁发词汇表 BlackWordTableBlackWordTable 字段名类型说明 BlackWord文本 短信禁发词汇 4 24 2 错误日志表错误日志表 ErrorLogTableErrorLogTable 字段名类型说明 ErrorIndex自动编号错误编号 主键 自动生成 ErrorTime日期 时间出错时间 ErrorText文本错误描述 4 34 3 设备管理表设备管理表 ModemTableModemTable 字段名类型说明 ModemIndex文本 设备序号 如短信设备 1 短信设备 2 短信设 备 3 ModemState文本标记设备状态 启用或禁用 ComName文本 连接串口 COM 号 例如 COM1 COM2 COM3 ModemType文本设备类型 工业 GSM Modem 或西门子手机 ComRate文本 设备连接波特率 根据设备的不同可能为 9600 19200 38400 57600 115200 注 GSM Modem 的波特率为 9600 NumberArea文本 发送对象的范围 值可为 不限范围 移动号码 联通号码 第 10 页 共 28 页 SendRate文本发送速度 SendSucceedCount数字本设备已累计发送成功的短信条数 SendErrorCount数字本设备已累计发送失败的短信条数 MaxSendCount数字 限制发送短信条数 只计算发送成功数 0 为不 限制 Remark文本备注信息 可为任意文本 4 44 4 用户短信条数日志表用户短信条数日志表 PayLogTablePayLogTable 字段名类型说明 PayIndex自动编号记录编号 主键 自动生成 PayTime日期 时间操作时间 UserID文本用户代码 PayValue数字添加或删除短信条数 4 54 5 短信接收日志表短信接收日志表 RecvSmsTableRecvSmsTable 字段名类型说明 SmsIndex自动编号接收短信编号 主键 自动生成 SmsTime日期 时间接收时间 SendNumber文本短信发送号码 SmsContent文本短信内容 RecvModemSet文本接收本条短信的设备序号 NewFlag数字未处理标志 预留给应用系统使用 默认值为 1 SendTime日期 时间短信发送的时间 注 本表记录的增加由短信服务器二次开发平台来完成 应用系统只需查询有无新记录 NewFlag 字段值为 1 表示是新记录 有则读出处理 第 11 页 共 28 页 4 64 6 待发短信表待发短信表 SendingSmsTableSendingSmsTable 字段名类型说明 SmsIndex自动编号发送短信编号 主键 自动生成 SmsUser文本发送短信的用户 或类型 PhoneNumber文本短信接收号码 SmsContent文本短信内容 UserDefineNo数字用户自定义编号 可用于短信的标识 PutInType文本信息提交方式 SendModem数字 发送短信的设备 如 1 2 3 表示使用某 号短信设备来发送 如为 0 则表示不作发送设 备限制 默认值为 0 SendLevel数字 短信发送优先级 数值越低 优先级越高 范围 2 1 0 1 2 默认值为 1 NewFlag数字未处理标志 默认值为 1 RM1文本供用户使用 RM2文本供用户使用 RM3文本供用户使用 注 本表记录的增加由应用系统来完成 至少需要更新以下字段值 PhoneNumber SmsContent NewFlag 具体开发方法请参见 6 3 2 章节 4 74 7 短信发送日志表短信发送日志表 SentSmsTableSentSmsTable 字段名类型说明 SmsIndex自动编号已发短信编号 主键 自动生成 PhoneNumber文本短信接收号码 SmsContent文本短信内容 SmsTime日期 时间发送时间 SmsUser文本提交短信的用户 或类型 Status数字发送结果 1 为成功 否则为失败 第 12 页 共 28 页 NewFlag数字未处理标志 预留给应用系统使用 默认值为 1 UserDefineNo数字用户短信自定义编号 用于短信标识使用 SendSetIndex数字发送该短信的设备序号 RM1文本供用户使用 RM2文本供用户使用 RM3文本供用户使用 注 本表记录的增加亦由短信服务器二次开发平台来完成 应用系统只需查询有无新记录 有则读出处理 4 84 8 系统日志表系统日志表 SystemLogTableSystemLogTable 字段名类型说明 LogIndex自动编号系统日志编号 主键 自动生成 LogTime日期 时间记录时间 LogText文本记录内容 NewFlag数字未处理标志 默认值为 1 4 94 9 用户管理表用户管理表 UserTableUserTable 字段名类型说明 UserID文本用户代码 UserDesc文本用户描述 UserKey文本用户口令 UseSetList文本用户可以使用短信设备列表 如 UserLevel数字数值越低 优先级越高 0 为最高级 1 为优先 级 2 为普通级 SmsCount数字剩余可发送短信条数 默认值为 0 第 13 页 共 28 页 4 104 10 定时发送信息表定时发送信息表 TimeSendSmsTableTimeSendSmsTable 字段名类型说明 SmsIndex自动编号定时发短信编号 主键 自动生成 PhoneNumber文本短信接收号码 SmsContent文本短信内容 SmsUser文本提交短信的用户 或类型 UserDefineNo数字用户短信自定义编号 用于短信标识使用 SendLevel数字设置短信的优先级 数值越低 优先级越高 默 认值为 0 SendModem数字发送短信的设备 如 1 2 3 表示使用某 号短信设备来发送 如为 0 则表示不作发送设 备限制 默认值为 0 SendTime数字设置发送短信的时间 表示方法 yyyy mm dd hh mm ss 即年 4 位 月 2 位 日 2 位 时 2 位 分 2 位 秒 2 位 RM1文本供用户使用 RM2文本供用户使用 RM3文本供用户使用 第 14 页 共 28 页 五 五 OEM 短信服务器产品信息短信服务器产品信息 5 15 1 开发目的开发目的 修改短信服务器界面和标识 使之与公司产品统一和配套 5 25 2 开发方法开发方法 服务器软件的界面图片文件为 m1 bmp m2 bmp 修改界面图片信息 即可完成短信服 务器界面的修改 5 35 3 开发难度开发难度 简单 不涉及编程 只需要会使用图像处理工具 如 Photoshop 等 即可 第 15 页 共 28 页 六 实现应用系统的短信功能六 实现应用系统的短信功能 6 16 1 基于命令行方式的短信功能实现基于命令行方式的短信功能实现 6 1 1 使用特点使用特点 快速 简单地实现短信收发功能 对开发语言的支持性好 Windows 平台上的各种开发 语言都可以非常简单地完成 使用简单 调试过程短 6 1 2 开发方法开发方法 1 发送短信 发送短信 程序中执行命令行 SendSms 发送手机号码 发送短信内容 如 WinExec SendSms生日快乐 SW HIDE 2 接收短信 接收短信 在短信服务器界面的 系统设置 命令行方式 设置接收日志文件 中 设置好接收日 志文件 则短信服务器每接收到手机用户发过来的短信 就会自动写入该接收日志文件中 应用系统定时检测接收日志文件的内容即可接收短信 3 查询发送短信情况 查询发送短信情况 在短信服务器界面的 系统设置 命令行方式 设置发送日志文件 中 设置好发送日 志文件 则通过命令行发送短信的发送结果 成功或失败 发送时间 将自动写入该文件 中 应用系统定时检测发送日志文件的内容来判断短信发送情况 6 1 3 开发难度开发难度 简单 要实现发送短信 一般只需添加一行代码即可完成 第 16 页 共 28 页 6 26 2 基于外部数据库的开发接口基于外部数据库的开发接口 6 2 1 使用特点使用特点 快速地使现有的应用系统具备短信收发功能 不需要编程 不需要对原应用系统进行代 码修改 只需要在短信服务器界面上作些配置即可 尤其适合已存在系统的功能升级 特别是源代码已不存在的系统 6 2 2 开发方法开发方法 建立应用系统数据库的 ODBC 连接 然后在短信服务器上指定应用系统的发送表和接收 表 相对于短信服务器系统而言 称之为外部发送表和外部接收表 发送短信原理与配置方法发送短信原理与配置方法 短信服务器通过定时扫描外部发送表 来判断外部发送表中是否有新记录 如果有新 记录 则将新记录读出来 并将该记录写入短信服务器自带的待发短信表中 凡被写入该 表的记录均会被自动用短信发送出去 然后在外部发送表中删除本条记录 或修改本条记 录的状态标志 短信服务器应用系统 应用系统数据库应用系统数据库 应用系统数据表 1 应用系统数据表 2 设定为发送表 应用系统数据表 3 应用系统数据表 4 应用系统数据表 5 短信服务器数据库短信服务器数据库 用户管理表 设备管理表 短信发送日志表 短信接收日志表 待发短信表 定时检测是否有新记录 有新记录 取入内 部待发送表中 待 发 第 17 页 共 28 页 外部发送表的配置在短信服务器软件的 系统设置 配置外部发送表 中进行 配置 界面如下图所示 图中数据仅为示例 配置完成后 向发送表中插入一条新记录 更新 手机号码字段 短信内容字段 值即 可 接收短信原理与配置方法接收短信原理与配置方法 短信服务器通过短信设备接收到手机用户发过来的短信后 一方面把接收到的短信写 到自带的短信接收日志表中 同时也把该短信写入外部接收表中 假设已把应用系统的某 张表指定为外部接收表 应用系统即可通过定时 或事件触发 检查接收表中有无新记录 如有记录 则读进 应用系统 然后应用系统再作分析处理 第 18 页 共 28 页 外部接收表的配置在短信服务器软件的 系统设置 配置外部接收表 中进行 配置界 面如下图所示 图中数据仅为示例 6 2 3 开发难度开发难度 短信服务器应用系统 应用系统数据库应用系统数据库 应用系统数据表 1 应用系统数据表 2 应用系统数据表 3 设定为接收表 应用系统数据表 4 应用系统数据表 5 短信服务器数据库短信服务器数据库 用户管理表 设备管理表 短信发送日志表 短信接收日志表 待发短信表 收到手机短信 同步写入 第 20 页 共 28 页 简单 不涉及编程 不需要对原系统的代码进行修改 第 21 页 共 28 页 6 3 基于系统数据库的开发接口基于系统数据库的开发接口 6 3 1 使用特点使用特点 多个应用系统共享一个短信服务器来收发短信 希望是一个简单的网络应用 应用系统 在收发选项上希望比命令行方式更多一些 更灵活一些 需要对应用系统代码进行修改 需要编程 6 3 2 开发方法开发方法 注 系统数据库连接文件为短信服务器二次开发平台安装目录下的 GWDB link ini 文件 要修改系统数据库连接 直接修改 GWDB link ini 文件即可 若无 运行二次开发平 台 将自动生成 然后可以修改 系统安装时 默认安装的数据库为 Access 类型数据库 数据库文件是位于短信服务器 二次开发平台安装目录下的 SmsServer mdb 文件 1 短信发送 短信发送 把您要发送的短信写入 SendingSmsTable 表里 注意 请按字段描述的要求写入 系 统将自动读出该记录并发送 已发送记录保存在 SentSmsTable 表中 示例 SQL 语句 PhoneNumber SmsContent NewFlag 三个字段值必须添加 NewFlag 为 1 表示新加入 未处理 insert into SendingSmsTable PhoneNumber SmsContent NewFlag values文字短信测试消息一 1 采用 1 号短信设备发送 且该短信优先级为 0 insert into SendingSmsTable PhoneNumber SmsContent SmsModem SmsLevel NewFlag values文字短信测试消息二 1 0 1 2 查看短信发送情况 查看短信发送情况 通过查看 SentSmsTable 下记录得 Status 字段来获知该记录发送成功还是失败 当 Status 值为 1 时 表示发送成功 否则为失败 3 短信接收 短信接收 第 22 页 共 28 页 短信服务器通过短信设备接收到手机用户发过来的短信后 均写入了数据库 RecvSmsTable 表中 应用系统可从中读取接收到的短信 4 4 设置短信设备信息和查看短信设备状态 设置短信设备信息和查看短信设备状态 设置 ModemTable 表中的 CommName 和 ModemStatus 值可以向开发平台系统传递所 连接短信设备的 Com 口号和让该设备工作与否 设置 MaxSendCount 值可以向开发平台传 递该设备的限制发送条数 以成功计算 0 为不限制 读取 SendSucceedCount 可以知道该设备上累计发送成功了多少条信息 读取 SendErrorCount 可以知道该设备上累计发送失败的信息条数 5 查看出错信息 查看出错信息 读取 ErrorTable 表中的记录 即可获取出错信息 5 3 3 开发难度开发难度 中等难度 只要会数据库读写操作 一般都可以顺利完成开发 第 23 页 共 28 页 6 46 4 基于基于 SocketSocket 客户端的开发接口客户端的开发接口 6 4 1 使用特点使用特点 方便于网络 局域网或广域网 上多用户使用 网络上要发送短信的软件 只需要通过 TCP 与服务器相连 并按照规定协议与服务器进行指令交互 即可完成短信的收发操作 6 4 2 开发方法开发方法 连接端口号 TCP 协议 端口号 9518 长连接 命令语法 参数 1 参数 2 参数 3 功能功能发起过程发起过程客户端客户端服务器服务器 登陆客户端 服务器 用户名 密码 成功可发送条数 用户名错误 口令错误 服务器即时返回 提交成功可发送条数 失败 无授权条数 未登陆 发送短信客户端 服务器 自定义 编号 手机号 短 信内容 服务器稍后返回 发送成功 自定义 编号 发送失败 自定义 编号 接收短信 服务器 客户端 客户端在线时才 转达接收的短信 手机号码 短信内容 注 仅客户端在线时才转达接收的 短信 转发规则见第三章 注 如果服务器暂停服务 则上述客户端的每条指令返回均为 服务暂停 6 4 3 开发难度开发难度 中等 需要有网络程序开发经验 第 24 页 共 28 页 6 56 5 基于网络客户端基于网络客户端 OCXOCX 控件的开发接口控件的开发接口 6 5 1 使用特点使用特点 方便于网络 局域网或广域网 上多用户使用 只需要插入客户端 ocx 控件后 简单地 调用控件接口函数 就可以方便地发送和接收短信 简单 易用 6 5 2 开发方法开发方法 应用系统中嵌入短信客户端 OCX 控件 通过调用控件接口函数实现网络 包括互联网 方式的短信发送和接收 控件文件名 SmsClient ocx 控件接口名 SmsClient 短信客户端短信客户端 OCXOCX 控件接口函数 控件接口函数 接口函数一 函数名 Long ConnectSmsServer CString ServerIP CString UserName CString PassWord 函数描述连接短信服务器 SmsServerIP服务器 IP 地址 UserName登陆用户名 参数描述 PassWord登陆口令 返回值 1 为成功登陆 其余为连接失败 1 连接失败 2 用户名错误 3 密码错误 接口函数二 函数名long GetCanSendSmsAmount 函数描述取得该客户端的可发送短信条数 第 25 页 共 28 页 参数描述无无 返回值可发送短信条数 接口函数三 函数名long SendSms CString PhoneNumber CString SmsContent long SmsIndex 函数描述发送短信 PhoneNumber接收手机号码 SmsContent短新内容 参数描述 SmsIndex自定义编号 返回值1 提交成功 1 服务器拒绝请求 2 尚未连接服务器 接口函数四 函数名void DisconnectSmsServer 函数描述断开与服务器的连接 参数描述无无 返回值无 短信客户端短信客户端 OCXOCX 控件接口事件控件接口事件 事件一 事件名RecvSms LPCTSTR PhoneNumber LPCTSTR SmsContent 事件描述收到短信 PhoneNumber发送者手机号码 参数描述 SmsContent短信内容 事件二 事件名SendSmsResult long Result long SmsIndex 事件描述短信发送报告 第 26 页 共 28 页 Result发送结果 1 为成功发送 其余为失败 参数描述 SmsIndex发送短信的自定义标识编号 事件三 事件名ServerDisConnect 事件描述服务器关闭了与本客户端的连接 参数描述无无 6 5 3 开发难度开发难度 简单 需要进行程序开发 第 27 页 共 28 页 6 6 基于基于 HTTP 协议的开发接口协议的开发接口 6 6 1 使用特点使用特点 在网页程序或 Java 程序中直接调用 URL 语句来完成发送短信的提交以及接 收短信 简单 易用 6 6 2 开发方法开发方法 1 发送短信调用格式 发送短信调用格式 http 服务器地址 9618 User Password MsgID Phone Msg 注 如 User Msg 内容中有特殊字符 请先