流量 HTTP 接口对接指南

---

概述

本接口规范定义了秒信平台（服务方，这里指秒信技术服务平台）与客户系统（客户方）之间的数据传输协议及使用方法。通过这个接口规范可以实现客户系统(通过秒信)与运营商流量订购业务之间的消息传送。

秒信云流量HTTP接口

秒信平台的流量订购接口协议使用HTTP协议，秒信云平台提供访问的URL，客户使用HTTP POST方法发送请求并得到应答内容,客户作为秒信云平台的HTTP客户端，秒信云平台作为用户的HTTP服务器。秒信平台为客户提供流量订购、订单状态查询、余额查询、订单回执等相关服务。

加密方式及安全

对于短信发送、状态查询接口，秒信平台会验证发送方的有效性，我们有两重策略。

• 第一：协议签名
• 第二：IP接入验证

---

一、购买流量包接口

• 提交地址：：http(s)://www.51miaoxin.com/flow/buy
• 提交方法：POST
• 提交格式：application/x-www-form-urlencoded

字段	必填	类型	描述
account	√	string	参考：短信HTTP 接口对接总览
token	√	string	参考：短信HTTP 接口对接总览
ts	√	string	参考：短信HTTP 接口对接总览
mobiles	√	string	订购用户的手机号码，多个手机用半角字符“,”分开。 如：“18600001111,18600002222”，每个手机号11位数字。 账号开启加密后手机号则为加密后的密文。
productId	√	string	购买的产品编码 比如：ZGYD_10M，详见产品编码章节
ref		string	客户可以对提交的短信加入reference参数以便后续进行跟踪，设置的ref参数最终会被状态回调的时候同步给客户。

接口应答JSON格式如下

{
      "code":0, 
      "msg":"下单成功",  
      "total":2, 
      "reports":[
            {
                "mobile":"18600000001",              
                "order_id":"1839347820929302091",       
                "status":0,
                "receive_time":"2016-12-22 23:11:40",
                "msg":"处理中"                   
            },
            {
                "order_id":"1839347820929302093",
                "mobile":"18600000000",
                "status":-11,
                "receive_time":"2016-02-22 23:11:40",
                "msg":"运营商返回异常"
            }
       ]
  }

接口应答JSON数据含义

变量名	必反	类型	含义
code	√	int	0代表成功，负数代表失败
msg	√	string	code状态对应的中文解释
total	√	int	代表本次收到多少个短信发送请求，数量会和mobiles的手机号数量一致
reports	√	array	状态的汇报信息是一个数组，会对每一个手机号码的下发请求做单独的汇报
reports.code	√	int	0代表成功，负数代表失败
reports.msg	√	string	reports.code状态对应的中文解释
reports.mobile	√	string	发送的目标客户手机号码 账号开启加密后手机号则为加密后的密文。
reports.receive_time	√	string	秒信系统平台接收此下发需求的时间

---

二、流量包订单状态查询接口

• 提交地址：：http(s)://www.51miaoxin.com/flow/check
• 提交方法：POST
• 提交格式：application/x-www-form-urlencoded

字段	必填	类型	描述
account	√	string	参考：短信HTTP 接口对接总览
token	√	string	参考：短信HTTP 接口对接总览
ts	√	string	参考：短信HTTP 接口对接总览
orderIds	√	string	可以一次查询一个订单或者多个订单，多个订单号用半角字符“,”分开

接口应答JSON格式如下

{
      "code":0, 
      "msg":"查询成功",  
      "total":2, 
      "reports":
            [
                  {
                        "order_id":"1839347820929302091",       
                        "mobile":"18600000001",              
                        "status":0, 
                        "msg":"信息提示",              
                        "receive_time":"2016-12-22 23:11:40",
                        "ref":""                   
                  },
                  {
                        "order_id":"1839347820929302093",       
                        "mobile":"18600000000",              
                        "status":0,      
                        "msg":"信息提示",              
                        "receive_time":"2016-12-22 23:11:40",
                        "ref":""                            
                  }
            ]
}

接口应答JSON数据含义

变量名	必反	类型	含义
code	√	int	0代表成功，负数代表失败
msg	√	string	code状态对应的中文解释
total	√	int	代表本次收到多少个短信发送请求，数量会和mobiles的手机号数量一致
reports	√	array	状态的汇报信息是一个数组，会对每一个手机号码的下发请求做单独的汇报
reports.order_id	√	string	短信提交成功后的订单id
reports.mobile	√	string	订单对应下发的目标手机号码 账号开启加密后手机号则为加密后的密文。
reports.status	√	string	详见错误代码对应表
reports.msg	√	string	reports.status对应的中文解释
reports.receive_time	√	string	下单的时间
reports.ref		string	reference参数（如果有则返回）

---

三、获取产品编码的接口

• 提交地址：：http(s)://www.51miaoxin.com/flow/productList
• 提交方法：POST
• 提交格式：application/x-www-form-urlencoded

字段	必填	类型	描述
account	√	string	参考：短信HTTP 接口对接总览
token	√	string	参考：短信HTTP 接口对接总览
ts	√	string	参考：短信HTTP 接口对接总览

接口应答JSON格式如下

{
      "code":0, 
      "msg":"查询成功",  
      "total":2, 
      "data":
            [
                  {
                        "product_id":"ZGYD_10M",       
                        "product_name":"中国移动-10M",          
                        "product_price":"2.4"                   
                  },
                  {
                        "product_id":"ZGYD_100M",       
                        "product_name":"中国移动-100M",          
                        "product_price":"5.0"                           
                  }
            ]
}

接口应答JSON数据含义

变量名	必反	类型	含义
code	√	int	0代表成功，负数代表失败
msg	√	string	code状态对应的中文解释
total	√	int	多少个产品编码返回
data	√	array	数组，多种产品编码
data.product_id	√	string	产品编号
data.product_name	√	string	产品描述
data.product_price	√	string	购买价格