云测短信服务平台.doc

文档介绍：云测短信云服务平台
用户手册
时间
修改人
版本号
修改说明
2015-07-31
宣震

创建文档
2015-08-01
杨进

1、修改code码描述
2、将接口说明中的apikey改为apiKey
2015-08-07
杨进

1、,将“SendSms”改为“”
2、
./sms
目录
1. 开发说明 2
2
2
2. 概述 2
3. 发送短信接口 3
4. 接收上行短信接口 5
5. 接收手机状态报告接口 7
6. 查询余额接口 9
附录:sig签名规则算法 11
开发说明

云测短信云平台:是针对软件开发商和系统集成商的软件开发及技术产品服务的需求,提供的短信通讯服务平台。

MT ——下行短信,即向手机终端发送短信
MO ——上行短信,即手机用户向接收号码发送短信
RePort——短信状态报告,即手机向运营商返回是否收到短信的标识。
概述
请求说明
云测短信服务接口根据合作伙伴/用户发起的HTTPPOST请求,返回格式化的数据。接口采用HTTP协议,数据类型为JSON,编码格式为utf-8。
短信的API的接口地址:./sms
请求参数信息如下:
op: 操作动作。“”->请求发送短信验证码服务(该参数不同对应不同的业务,如:发送,接收回复,接收报告,查询余额)
apiKey: 平台分配给接入方的唯一标识
ts: 时间戳(单位:毫秒)
sig: 数字签名
注:1、请求参数说明中未明确写"可选" ,则视为必填项。
返回值json解析说明
返回串为json格式,所有json中的字符串value需要做编码转换以免解析和传输过程出错。公用信息如下:
op: 操作动作,例如“SendSms”->请求发送短信验证码;
code: 返回错误码,值为1000时代表请求成功;
msg: 返回说明语句;
json 返回例子如下:
{"op":"","code":1000,"msg":"成功"}
申请apiKey(用户名)以及secretKey(密码)
由云测提供,模板短信的模板id由云测提供。
发送短信接口
功能描述
开发者通过发送接口发送短信
地址:./sms
协议定义
>>>请求
POST /sms HTTP/
Host: .
Accept: text/plain
Accept-Charset: utf-8
Content-length: 内容长度
{
"op":"", #String, //接口名称
"apiKey":, #String, //平台分配给接入方的唯一标识
"ts":, #Long, //时间戳(单位:毫秒)
“templateId":, #String, //短信模版ID
"phone":, #String, //发送目标的手机号( 批量发送用英文逗号隔开,最多200个手机号码,号码间不能有逗号以外的其他字符,例: **********,**********,**********)
"content":, #String, //发送内容,多个内容以|为分隔符
"taskId":, #String //不超过64位长度的唯一字符串,用于手机状态报告的数据匹配(如果需要获取短信报告回执,该参数在自己的系统要做存储)
"extNum", #String //发送扩展号(要单独申请才能开通)
"sig":, #String //数字签名
}
<<<响应
HTTP/ 200 OK
Content-type: text/plain
Connection: close
Content-length: 内容长度
{
"op":"",
"code": #Integer,
"msg": #String,
}
发送参数说明
结果返回值说明
code
描述
备注
999
服务启动中
1000
成功
3002
无效的参数(apiKey)
3003
模版id不存在
3004
变量数据与模版不匹配
3005
超过50个变量标签
3008
手机号不合法
3009
数字签名错误
软件的字符集不是utf8,md5算法不正确
3010
数字签名为空
9999
其他错误