文档概览

流量说明

请求和响应报文

接口采用http进行交互,所有提交参数均需要UTF-8的urlencode编码后传输,支持GET和POST方式提交(数据量大则建议采用POST)。
 
返回报文统一使用JSON,编码为UTF-8,报文中某个可选参数的值为空,则该标签可以不出现。
 
请接入用户登录到平台在用户基本信息页获取 ApiKey
 
 

标注 (签名) 的参数需要对其进行签名校验,签名算法参见文档尾

单号码充流量


请求
Action 命令 charge
V 版本号 1.1 固定值
Range 流量类型 0 漫游流量 1非漫游流量,不带改参数时默认为0
OutTradeNo 商户订单号 商户系统内部的订单号,64个字符内、可包含字母,可为空
Account 帐号 (签名)
 
Mobile 号码 (签名)  
Package 套餐 (签名) 流量包(必须在返回流量包选择内)
Sign 签名 参见签名算法
 
响应
TaskID 任务编码 失败为0
Code 代码 成功为0
Message 消息 注意:启用商户订单号唯一性验证后,如果手机号码+商户订单号存在,Code会返回0,表示成功。Message提示为:商户订单号xxx已经存在
但不会再新建订单,TaskID将会返回上一次相同商户订单号提交返回的TaskID。如果TaskID返回为-1,需要人工介入判断。

例:http://host.com/api.aspx?v=1.1&action=charge&account=帐号&mobile=手机号&package=100&sign=MD5

批量充流量

请求
Action 命令 chargeBat
V 版本号 1.1 固定值
Range 流量类型 0 漫游流量 1非漫游流量,不带改参数时默认为0
OutTradeNo 商户订单号 商户系统内部的订单号,64个字符内、可包含字母,可为空
Account 帐号(签名)  
CMPackage 移动套餐(签名) 如有移动号码则必传 传值参考getPackage返回参数
CUPackage 联通套餐(签名) 如有联通号码则必传 传值参考getPackage返回参数
CTPackage 电信套餐(签名) 如有电信号码则必传 传值参考getPackage返回参数
Mobile 号码(签名) 半角逗号(,)分割
Sign 签名 参见签名算法
 
响应
TaskID 任务编码 失败为空
Code 代码 成功为0
Message 消息 注意:启用商户订单号唯一性验证后,如果手机号码+商户订单号存在,Code会返回0,表示成功。Message提示为:商户订单号xxx已经存在
但不会再新建订单,TaskID将会返回上一次相同商户订单号提交返回的TaskID。如果TaskID返回为-1,需要人工介入判断。
 
例:http://host.com/api.aspx?v=1.1&action=chargeBat&account=帐号&mobile=手机号逗号分割&cmPackage=100&cuPackage=100&ctPackage=100&sign=MD5


卡密充流量


请求
Action 命令 chargeCard
V 版本号 1.1 固定值
Account 帐号(签名)  
Mobile 号码(签名)  
CardNo 卡号(签名)  
Password 卡密(签名)  
Sign 签名 参见签名算法
 
响应
TaskID 任务编码 失败为空
Code 代码  
Message 消息  
 
例:http://host.com/api.aspx?v=1.1&action=chargeCard&account=帐号&mobile=手机号&cardNo=卡号&pssword=密码&sign=MD5

获取流量包定义


请求
Action 命令 getPackage
V 版本号 1.1 固定值
Account 帐号(签名)  
Range 流量类型 0 漫游流量 1非漫游流量,不带改参数时默认为0  
Type 类型(签名) 0:不指定, 1:移动, 2:联通, 3:电信
Sign 签名 参见签名算法
 
响应
Code 代码  
Message 消息  
Packages + 返回流量包  
    Type 类型,数字 1:移动, 2:联通, 3:电信
    Package 流量包  
    Name 名称  
    Price 价格  
 
例:http://host.com/api.aspx?v=1.1&action=getPackage&account=帐号&sign=MD5


查询余额

请求
Action 命令 getBalance
V 版本号 1.1 固定值
Account 帐号(签名)  
Sign 签名 参见签名算法
 
响应
Code 代码  
Message 消息  
Balance 余额  
 
例:http://host.com/api.aspx?v=1.1&action=getBalance&account=帐号&sign=MD5

获取状态

请求
Action 命令  getReports
V 版本号  1.1 固定值
Account 帐号(签名)  
Count 一次取数量(签名)  
Sign 签名 参见签名算法
 
响应
Code 代码  
Message 消息  
  Reports+ 返回记录  
    TaskID 任务  
    Mobile 手机  
    Status 状态  4.状态成功, 5.状态失败
    ReportTime 时间  
    ReportCode 代码说明  
    OutTradeNo 商户订单号 商户系统内部的订单号
 
例:http://host.com/api.aspx?v=1.1&action=getReports&account=帐号&sign=MD5
状态被获取后服务器删除该状态 建议获取到状态后先记录一个日志






 
QQ在线咨询
服务热线
021-31652084
24小时电话
15900894283