开发接口说明

Size: px

Start display at page:

Download "开发接口说明"

枫缠隗
7 years ago
Views:

1 金笛短信中间件 web 版开发接口说明数据库接口说明配置完数据源之后, 中间件会自动创建 smsserver_in smsserver_out smsserver_calls 三张表, smsserver_out 表用于存放待发送的短信以及短信的发送结果, 将需要发送的短信插入到该表, 中间件会自动发送, 并将发送结果记录到该表 Smsserver_in 表, 中间件收到短信以及状态报告之后, 会将其存入该表 Smsserver_calls 表, 中间件接到电话之后会将其存入该表数据库接口支持的开发语言 :java C C++ C# PHP Ruby VB 等一切可以操作数据库的编程语言数据库表结构说明 : Smsserver_in 表 : 字段名类型属性描述 id INT 自动 primary key. process INT NOT NULL 预留备用 originator CHAR(16) NOT NULL 发件人 type CHAR(1) NOT NULL 短信类型 :"I" 普通短信, "S" 短信状态报告 encoding CHAR(1) NOT NULL 编码格式 :"7" for 7bit, "8" for 8bit and "U" for Unicode/UCS2 message_date DATETIME NOT NULL 短信发送日期时间 receive_date DATETIME NOT NULL 接收日期时间 text CHAR(xxx) NOT NULL 正文 original_ref_no CHAR(64) NULL 用于短信状态报告 : 此号码对应于外发的短信序号 original_receive_date DATETIME NULL 用于短信状态报告 : 对方收到短信的日期时间 gateway_id CHAR(64) NOT NULL 通道标识, 用于标识是哪个通道收到的短信

2 Smsserver_out 表结构说明字段名类型属性描述 id INT 自动 primary key. type CHAR(1) NOT NULL 短信类型. "O" 普通短信, "W" wappush recipient CHAR(16) NOT NULL 收件人手机号码, 前面不要加 "+" 或者 0 text CHAR(xxx) NOT NULL 短信正文 NOT NULL for wap_url CHAR(xxx) WAP SI Wap 短信 URL 地址 messages! wap_expiry_date DATETIME NULL Wap 短信有效期, 默认 7 天 wap_signal CHAR(1) NULL "N" NONE, "L" LOW, "M" MEDIUM, "H" HIGH, "D" DELETE create_date DATETIME Default value: 记录插入数据库的时间 current date/time originator CHAR(16) Default value: '' 发件人正常情况下为空 encoding CHAR(1) 编码格式 : "7" 7bit, "8" 8bit and "U" Unicode/UCS2 发送中文短信请设为 Default value: '7' U status_report INT 状态报告 : 设为 1 需要短信状态报告, Default value: 0 默认为 0 flash_sms INT Default value: 0 闪信, 设为 1 发送闪信, 默认为 0 src_port INT Default value: -1 源端口 ( 对彩铃有效 ) dst_port INT Default value: -1 目的端口 ( 对彩铃有效 ) sent_date DATETIME NULL 发送时间, Jdsmsserver 发送时会更新这个时间 ref_no CHAR(64) NULL 短信对应 ID 优先级 : priority INT 低 : 负数 Default value: 0 普通 :0 高 : 正数 status CHAR(1) 短信状态 :"U" : 未发送, "Q" : 排队中, Default value "S" : 已发送, "F" : 失败 "U" errors INT 重发次数

3 Default value: 0 短信通道标识, 可指定发送通道为空由短信服务器自动选择发送通道 : *: 所有短信 MODEM 端口轮询发送 gateway_id CHAR(64) Default value is the star character Modem1( 示例 MODEM): 指定某具体 MODEM 端口发送 $: 所有手机端口轮询发送 XXXX( 示例手机号码 ): 指定某具体手机发送 user_id CHAR(24) NULL 用户 id Smsserver_calls 表结构说明 : 字段名类型属性描述 id INT 自动 primary key. call_date DATETIME NOT NULL 电话呼入时间 gateway_id CHAR(64) NOT NULL 通道标识 caller_id CHAR(16) NOT NULL 对方号码功能测试进入到控制台管理界面, 选择短信发送界面, 给您自己的手机发送一条短信, 如果收到表示测试成功也可以直接往数据库里边插入一条记录, 使用如下 SQL 语句使用短信 MODEM 设备发送短信 : insert into smsserver_out (type,recipient,text,encoding, create_date) values ('O',' ','jdsmsserver 数据库发送成功 ',' U',now()); 使用手机发送短信 : insert into smsserver_out (type,recipient,text,encoding, create_date,gateway_id) values ('O',' ','jdsmsserver 数据库发送成功 ',' U',now(),'$'); URL 收发接口说明金笛短信中间件 web 版提供了两个 url 分别用于收发短信短信发送 URL: 密码 ]&text=[ 内容 ]&recipient=[ 手机号 ]&encoding=u 发送参数说明 password: 发送密码 text: 发送内容, 该字段实际设置的是您要发送的内容的 utf8 编码 recipient: 对方手机号码, 群发时用逗号分割

4 encoding: 字符编码集, 设置为 U 发送中文短信可选发送参数说明 : priority: 优先级, 低 : 负数普通 :0 高 : 正数 from: 发送者名称, 部分运营商支持, 只针对 GSM modem gateway: 短信通道,* : 所有短信 MODEM 端口 Modem1( 示例 MODEM): 某一具体短信 modem 端口 $ : 手机端口 XXXX( 示例手机号码 ): 某一具体手机返回的结果说明 : 举例如下 : 成功的例子 : <?xml version="1.0" encoding="utf-8"?> <send> <error>0</error> <message_status>sent</message_status> <ref_no>221</ref_no> <gateway>modem1</gateway> </send> Error: 错误代码, 返回 0 表示发送成功 -9000: 参数非法,-9001: 缺少参数,-9002: 发送错误,-9003: 密码错误,-9999: 发送终止 message_status: 短信的发送状态,UNSENT( 未发送 ) SENT 已发送 FAILED 发送失败 ref_no: 短信对应 ID Gateway: 实际发送短信通道失败的例子 : <?xml version="1.0" encoding="utf-8"?> <send> <error>-9002</error> <error_description>message not sent.</error_description> <message_status>failed</message_status> <failure_cause>unknown</failure_cause> <ref_no>null</ref_no> <gateway>*</gateway> </send> error_description: 错误描述 failure_cause: 导致发送失败的原因, 有以下几种情况 : NO_ERROR No error, everything OK. BAD_NUMBER BAD_FORMAT Bad destination number - fatal error. Bad message format - fatal error. GATEWAY_FAILURE Generic gateway failure - transient error, retry later. NO_CREDIT GATEWAY_AUTH error. NO_ROUTE No credit left - fatal error. Authentication problem (pin, passwords, etc) - fatal Unable to route message - transient error.

5 LOCAL_OPTOUT EzTexting specific: Local opt out (the recipient/number is on your opt-out list.) GLOBAL_OPTOUT EzTexting specific: Globally opted out phone number (the phone number has been opted out from all messages sent from our short code) UNKNOWN Unknown generic problems encountered. 短信接收 URL: 密码 ]&gateway=modem[ 设备序号 ] 接收参数说明 password: 接收密码 Gateway: 短信模块, 用于从指定模块接收短信, 如果没有指定则从所有模块读取短信返回的结果说明 : <?xml version='1.0' encoding="utf-8"?> <messages> <error>0</error> <message> <message_type>inbound</message_type> <message_date> t14:45:11 08:00</message_date> <originator> </originator> <text> <![CDATA[ 金笛短信中间件 web 版 httpserver 接口 ]]> </text> <encoding>encucs2</encoding> <gateway>modem1</gateway> </message> </messages> error: 错误代码, 返回 0 表示发送成功 -9000: 参数非法,-9001: 缺少参数,-9002: 发送错误,-9003: 密码错误,-9999: 发送终止 message: 对应于一条接收到的短信它包含了许多子元素, 其子元素说明如下 : message_type: 短信类型,INBOUND: 接收到的短信未知类型 OUTBOUND: 发送出去的短信 STATUSREPORT: 状态报告 WAPSI:WAP_PUSH 短信 UNKNOWN: message_date: 发送方发送该短信的时间 originator: 发送方手机号码 text: 短信内容 <![CDATA[]]> 这一段 xml 代码, 请自行截取掉, 短信内容采用的 UTF-8, 您在接收到短信内容之后, 需要将其转换为 GB2312 编码 ( 中文编码格式 ), 例子中是已经解码后的短信内容 encoding: 短信内容的编码方式 gateway: 短信模块, 收到该短信的模块

6 在 develop 文件夹有 java 的关于 htttpserver 接口收发短信的历程, 可以参考一下回调功能说明对收到的短信进行实时处理, 比如通过设备发一条短信, 对方收到后回复一条, 我需要知道短信内容和发送人, 并能进行相应的处理 : 1: 在配置文件 JDSMSServer.conf 中把这几行注释去掉, #interface.2=http1,httppush #http1.get_url= #d%&text=%text%&originator=%originator% #http1.method=get 其中 http1.get_url= 换成你的 web 服务器的地址和相应的页面, 最后重新启动一下服务其中 Console 文件夹中有对应的 test.jsp 文件可以参考一下

JMX 接口 : 通过 RMI 方式实现远程控制短信收发队列 ( 对象 ) HTTP 接口 : 收到短信或者发出短信后, 可以按照指定参数调用 URL HTTP Server 接口 : 内嵌 HTTP Server, 用户可通过 URL 参数传递实现短信发送金笛短信服务器还支持多达 500 个汉字

JMX 接口 : 通过 RMI 方式实现远程控制短信收发队列 ( 对象 ) HTTP 接口 : 收到短信或者发出短信后, 可以按照指定参数调用 URL HTTP Server 接口 : 内嵌 HTTP Server, 用户可通过 URL 参数传递实现短信发送金笛短信服务器还支持多达 500 个汉字一产品简介金笛短信服务器是一款基于短信猫猫池的 JAVA 短信平台软件可以部署在 Win Linux 等环境下, 为企业事业单位提供六种短信调用接口用户不需要编码, 就可以实现业务系统和短信收发功能的嫁接 DB HttpClient HttpServer XML EMail JMX JINDI SMS Server 通道 1,wavecom 通道 2,maestro 通道 3, 金笛 24PL