商户流量充值协议(1.1)解读.docVIP

商户流量充值协议(1.1) 2016-03-02 目录 1. 请求和响应报文 3 2. API请求地址 3 3. 消息单元定义 3 3.1. 单号码充流量 3 3.2. 批量充流量 4 3.3. 卡密充流量 4 3.4. 获取流量包定义 5 3.5. 查询余额 6 3.6. 获取状态 6 3.7. 推送状态 7 3.8. 主动状态查询(不建议使用) 8 4. 错误定义 8 5. 签名算法 9  1. 请求和响应报文 接口采用http进行交互，所有提交参数均需要UTF-8的urlencode编码后传输，支持GET和POST方式提交(数据量大则建议采用POST)。 返回报文统一使用JSON，编码为UTF-8，报文中某个可选参数的值为空，则该标签可以不出现。 请接入用户登录到平台在用户基本信息页获取 ApiKey 标注 (签名) 的参数需要对其进行签名校验，签名算法参见文档尾 2. API请求地址 /api.aspx其中为实际的流量平台域名 3. 消息单元定义 3.1. 单号码充流量 请求 Action 命令 charge V 版本号 1.1 固定值 Range 流量类型 0 全国流量 1省内流量，不带改参数时默认为0 OutTradeNo 商户订单号 商户系统内部的订单号,64个字符内、可包含字母，可为空 Account 帐号 (签名) Mobile 号码 (签名) Package 套餐 (签名) 流量包大小(必须在返回流量包选择内) Sign 签名 参见签名算法 响应 TaskID 任务编码 失败为空 Code 代码 Message 消息 例:/api.aspx?v=1.1action=chargeaccount=帐号mobile=手机号package=100sign=MD5 3.2. 批量充流量 请求 Action 命令 chargeBat V 版本号 1.1 固定值 Range 流量类型 0 全国流量 1省内流量，不带改参数时默认为0 OutTradeNo 商户订单号 商户系统内部的订单号,64个字符内、可包含字母，可为空 Account 帐号(签名) CMPackage 移动套餐(签名) 如有移动号码则必传 传值参考getPackage返回参数 CUPackage 联通套餐(签名) 如有联通号码则必传 传值参考getPackage返回参数 CTPackage 电信套餐(签名) 如有电信号码则必传 传值参考getPackage返回参数 Mobile 号码(签名) 半角逗号(,)分割 Sign 签名 参见签名算法 响应 TaskID 任务编码 失败为空 Code 代码 Message 消息 例:/api.aspx?v=1.1action=chargeBataccount=帐号mobile=手机号逗号分割cmPackage=100cuPackage=100ctPackage=100sign=MD5 3.3. 卡密充流量 请求 Action 命令 chargeCard V 版本号 1.1 固定值 Account 帐号(签名) Mobile 号码(签名) CardNo 卡号(签名) Password 卡密(签名) Sign 签名 参见签名算法 响应 TaskID 任务编码 失败为空 Code 代码 Message 消息 例:/api.aspx?v=1.1action=chargeCardaccount=帐号mobile=手机号cardNo=卡号pssword=密码sign=MD5 3.4. 获取流量包定义 请求 Action 命令 getPackage V 版本号 1.1 固定值 Account 帐号(签名) Type 类型(签名) 0:不指定, 1:移动, 2:联通, 3:电信 Sign 签名 参见签名算法 响应 Code 代码 Message 消息 Packages + 返回流量包 Package 流量包 Name 名称 Price 价格 例:/api.aspx?v=1.1action=getPackageaccount=帐号sign=MD5  3.5. 查询余额 请求 Action 命令 getBalance V 版本号 1.1 固定值 Account 帐号(签名) Sign 签名 参见签名算法 响应 Code 代码 Message 消息 Balance 余额 例:/api.aspx?v=1.1action=getBalanceaccount=帐号sign=MD5 3.6. 获取状态 请求 Action 命令 getReports V 版本号 1.1 固定值 Account 帐号(签名) Count 一次取数量(签名)