宽乐通信用户短信接入规范V2.2.doc

增值业务中心

宽乐通信
短信接入规范
(V2.2)

一. 引言
1.1概述
宽乐通信短信接入规范定义了宽乐通信平台与企业客户系统之间的开放接口，主要是对短信处理流程、通信约定以及通信接口的定义。企业客户通过这一规范可以实现与宽乐通信平台对接，实现短信下发,接收回复,接收状态流程。

1.2 适用范围
此规范适用于各行业企业客户。

1.3接口优势
l 跨平台
l 可穿过防火墙
l 开发简单，低成本实现，业界已有成熟的框架或中间件
l 易于部署

1.4 技术支持:
罗工 Tel: [phone] QQ: 8729153
MSN: BrainyLuo@

二. 通信方式
双方采用HTTP协议进行通信，双方互为服务器。如下图所示：

宽

乐

通

信
客

户

平

台

HTTP方式MO

HTTP方式MT

三. 通信接口
本部分主要描述宽乐通信平台与企业客户平台的接口定义，包括下发,上行,取状态接口
统一访问的URL地址：http://183.62.139.6/sdk/SMS
3.1 上行回复MO接口
3.1.1功能描述：
用户上行后，客户平台从宽乐通信平台查询获取。客户平台成功获取后，宽乐通信平台修改标志为已获取。
每次连接最大上限值1000条短信。
3.1.2请求示例：
http://183.62.139.6/sdk/SMS?cmd=getmo&uid=0001&psw=12345
3.1.3 参数说明：
参数名称
参数说明
参数格式
备注
cmd
命令字
getmo
取上行
uid
帐号
非空

psw
密码
非空
密码需要MD5加密
3.1.4 响应说明：
101 无上行。
100 有上行。
应答样例：
100
2#20100413113838#13590234458#0001#老地方见。
3#20100413131114#13590234458#0001#请打办公室电话。
3.2 下行短信MT接口
3.2.1功能描述：
可以通过此接口向用户下送消息。
3.2.2请求示例：
http://183.62.139.6/sdk/SMS?cmd=send&uid=0001&psw=12345&mobiles=13590234458&msgid=10002&msg=test
3.2.3 参数说明：
参数名称
参数说明
参数格式
备注
cmd
命令字
send
发送短信
uid
帐号
非空

psw
密码
非空
密码需要MD5加密
mobiles
手机号码

多个号码用逗号隔开;
msgid
消息编号
长整型
默认为0
msg
消息内容

3.2.4 响应说明：
返回码
含义
100
成功
101
失败
102
验证失败
103
号码有错
104
内容有错
105
操作频率过快
106
限制发送
107
参数不全
3.3 接收状态STATUS接口
3.3.1功能描述：
发送短信后，客户平台从宽乐通信平台查询获取。
3.3.2请求示例：
http://183.62.139.6/sdk/SMS?cmd=getstatus&uid=0001&psw=12345
3.3.3 参数说明：
参数名称
参数说明
参数格式
备注
cmd
命令字
getmo
取上行
uid
帐号
非空

psw
密码
非空
密码需要MD5加密
3.3.4 响应说明：
应答格式为纯文本,每次可返回多条回复信息：
状态码
状态报告1
状态报告2
…
第一行表示操作的状态码(100表示有状态信息)。
第二行表示一条状态信息的手机号码,状态等. 各项之间用 | 分隔.
消息编号|手机号码|状态码
消息编号：对应发送是设置的msgid
手机号码：接收短信息的号码
状态码：0表示成功，1表示失败

应答样例：
100
10002#13590234458#0
10003#13590234458#0
10004#13590234458#0

3.4 定时发送 TSend 接口
3.4.1功能描述：
可以通过此接口向用户定时下送消息。(此接口不返回状态,需要状态时请在需要发送的时间调用直接发送的接口)
3.4.2请求示例：
http://183.62.139.6/sdk/SMS?cmd=tsend&uid=0001&psw=12345&mobiles=13590234458&senddate=2010-05-01&sendtime=10:33&msg=test
3.4.3 参数说明：
参数名称
参数说明
参数格式
备注
cmd
命令字
tsend
定时发送
uid
帐号
非空

psw
密码
非空
密码需要MD5加密
mobiles
手机号码

多个号码用逗号隔开;
senddate
发送日期
YYYY-MM-DD

sendtime
发送时间
hh:mm

msg
消息内容

3.4.4 响应说明：
返回码
含义
100
成功
101
失败
102
验证失败
103
号码有错
104
内容有错
105
操作频率过快
106
限制发送
107
参数不全

3.5 查询发送条数接口
3.5.1功能描述：
通过此接口查询帐户发送条数与可发送条数。
3.5.2请求示例：
http://219.134.64.3:10000/sdk/SMS?cmd=getnum&uid=0001&psw=12345
3.5.3 参数说明：
参数名称
参数说明
参数格式
备注
cmd
命令字
getnum
取发送条数信息
uid
帐号
非空

psw
密码
非空
密码需要MD5加密
3.5.4 响应说明：
101 错误。
100 # 已发送条数 # 还可发送条数
- 9 -