合作方:中国移动广东公司广州分公司
中国联通广东分公司增值业务部
中国电信广州分公司
前言:
由于短信接入客户繁多,各自的规范都不相同,我公司制定统一的接入规范,方便公司管理与维护,给客户提供稳定、安全的技术服务。
一、接口协议
短信发送接口协议使用HTTP协议,短信平台接口提供访问的URL,用户使用HTTP POST方法发送请求并得到应答内容(注意:建议使用POST的方式提交,可以避免宽带运营商弹出广告页面,请求无法跳转,导致发送失败)。二、接口规范
1.短信接收
http://mt.10690404.com/receive.do?Account=test&Password=test&Fmt=json入参:
参数 | 名称 | 备注 |
Account | 账号 | |
Password | 密码 | |
Fmt | 返回的信息格式(默认json) | 目前支持json, xml等格式 |
返回結果:
{"data":[{"recieve":"106550200682","content":"收到","mobile":"11111111111","recievetime":"2015-05-01 22:05:45","exno":""}],"message":"获取成功","code":"9001"} |
返回結果說明:
参数 | 说明 |
code | 9001:获取成功 0001:帐号为空 0002:密码为空 0003:帐号验证不通过 8001:其他异常 |
data | 上行数组 |
data.recieve | 下行号码 |
data.content | 上行内容 |
data.recievetime | 接受时间 |
data.mobile | 上行号码 |
data.exno | 扩展号 |
2.短信发送(一个内容多个号码)
http://mt.10690404.com/send.do?Account=test&Password=test&Mobile=11111111111&Content=test&Exno=0&Fmt=json入参:
参数 | 名称 | 备注 |
Account | 账号 | |
Password | 密码 | |
Mobile | 接收号码 | 多个号码“,”分割 注意:国际短信统必须以“00”开始,如香港号码:00852,台湾号码:00886。中国的号码不能加区号(0086),否则按照国际短信价格收费 |
Content | 内容 | 内容不超过350字 程序编码: ASP:server.URLEncode(“短信内容”) PHP:urlencode(“短信内容”) JAVA:java.net.URLEncoder.encode(“短信内容”) |
Exno | 扩展号 | 默认为空 |
SendTime | 定时发送 | 该字段为空、格式错误和设置的时间小于当前时间,系统为立即发送,如果定时发送,时间格式如下 (yyyyMMddHHmmss ) 例:20150421201232 |
Fmt | 返回的信息格式(默认json) | 目前支持json、xml等格式 |
返回結果:
{"message":"提交成功","batch":"20131009103710000002","code":"9001","subNum":1,"reNum":0,,"redate":[{"btch":"20140619194810084503","mobile":"11111111111"}] } |
返回結果說明:
参数 | 说明 |
code | 9001:发送成功 0001:帐号为空 0002:密码为空 1003:发送号码为空 1004:发送内容为空 0003:帐号验证不通过 1009:其他异常 8001:其他异常 |
message | 信息提示 |
batch | 提交批次 |
subNum | 提交成功数量 |
reNum | 10分钟内重复提交数量 |
Redata | 重复提交数组 |
redata.btch | 号码批次 |
redata.mobile | 发送号码 |
3.余额查询
http://mt.10690404.com/getUser.do?Account=test&Password=test&Fmt=json入参:
参数 | 名称 | 备注 |
Account | 账号 | |
Password | 密码 | |
Fmt | 返回的信息格式(默认json) | 目前支持json、xml等格式 |
返回結果:
{"money":"1189.40","code":"9001","suffix":"【悦信无线】","companyname":"悦信无线科技","summ":11894} |
返回結果說明:
参数 | 说明 |
code | 9001:获取成功 0001:帐号为空 0002:密码为空 0003:帐号验证不通过 8001:其他异常 |
money | 剩余金额(元) |
suffix | 信息签名 |
companyname | 公司名称 |
summ | 剩余条数 |
4、打包发送接口(一个内容一个号码)
http://mt.10690404.com/send_bag.do? paramStr=test&fmt=json入参:
参数 | 名称 | 备注 |
fmt | 编码格式 | 目前支持json格式,默认:json |
paramStr | 打包参数 | 打包信息 ASP:server.URLEncode(paramStr) PHP:urlencode(paramStr) JAVA:java.net.URLEncoder.encode(paramStr) |
paramStr打包参数说明(json参数) | ||
username | 帐号 | |
key | 加密标识 | Md5(username+#+password) |
sendtime | 定时发送 | 该字段为空、格式错误和设置的时间小于当前时间,系统为立即发送。如果定时发送,时间格式如下 (yyyyMMddHHmmss ) 例:20150421201232 |
dataList | 打包数组 | |
dataList.mid | 信息唯一编码 | 提交信息不能重复(长短不超过9位,超过9位的将被截掉),不能为空 |
dataList.mobile | 号码 | 不能为空 注意:国际短信统必须以“00”开始,如香港号码:00852,台湾号码:00886。中国的号码不能加区号(0086),否则按照国际短信价格收费 |
dataList.content | 内容 | 不能为空 |
dataList.exno | 拓展号 | |
例子: {"dataList":[{"content":"你好短信测试联通511","mid":"1009188","exno":"001","mobile":"11111111111"},{"content":"你好短信测试移动511","mid":"1009198","exno":"001","mobile":"11111111111"}],"username":"tsst","key":"c54a5c41cce22e68423774e5675399e0"} |
返回結果:
{"message":"发送成功","batch":"1718043695","code":"9001","subNum":2} |
返回結果說明:
参数 | 说明 |
code | 9001:发送成功 0001:帐号为空 0002:密码为空 1003:发送号码为空 1004:发送内容为空 0003:帐号验证不通过 1009:其他异常 8001:其他异常 |
message | 信息提示 |
batch | 提交批次 |
subNum | 提交成功数量 |
5、打包发送接口(一个内容模版,多个参数替换)
http://mt.10690404.com/send_para.do? paramStr=test&fmt=json入参:
参数 | 名称 | 备注 |
Fmt | 编码格式 | 目前支持json格式,默认:json |
paramStr | 打包参数 | 打包信息 ASP:server.URLEncode(paramStr) PHP:urlencode(paramStr) JAVA:java.net.URLEncoder.encode(paramStr) |
paramStr打包参数说明(json参数) | ||
Username | 帐号 | |
Key | 加密标识 | Md5(username+#+password) |
Sendtime | 定时发送 | 该字段为空、格式错误和设置的时间小于当前时间,系统为立即发送。如果定时发送,时间格式如下 (yyyyMMddHHmmss ) 例:20150421201232 |
Content | 短信内容 | 不能空 |
parameter | 参数 | 多个参数用“|#|”分隔开 |
dataList | 打包数组 | |
dataList.mid | 信息唯一编码 | 提交信息不能重复(长短不超过9位,超过9位的将被截掉),不能为空 |
dataList.mobile | 号码 | 不能为空 注意:国际短信统必须以“00”开始,如香港号码:00852,台湾号码:00886。中国的号码不能加区号(0086),否则按照国际短信价格收费 |
dataList.value | 替换值 | 多个参数用“|#|”分隔开(必须与parameter一一对应) |
dataList.exno | 拓展号 | |
例子: {"dataList":[{"value":"AA|#|1200元|#|500分","mid":"100118800","exno":"001","mobile":"11111111111"},{"value":"BD|#|1300元|#|530分","mid":"100333801","exno":"001","mobile":"11111111111"}],"content":"33-66分尊敬的{客户名称},你的卡号还剩下{多少钱},可以积分{多少分},请及时充值,谢谢。","username":"wnkj","parameter":"{客户名称}|#|{多少钱}|#|{多少分}","sendtime":"20150421234000","key":"18f4a1957617638bfde2a24c74c6cbcf"} |
返回結果:
{"message":"发送成功","batch":"1718043695","code":"9001","subNum":2} |
返回結果說明:
参数 | 说明 |
code | 9001:发送成功 0001:帐号为空 0002:密码为空 1003:发送号码为空 1004:发送内容为空 0003:帐号验证不通过 1009:其他异常 8001:其他异常 |
message | 信息提示 |
batch | 提交批次 |
subNum | 提交成功数量 |