数字虚拟运营平台统一接口说明

修订人	修订时间	版本号
邵雷强	2018-07-19 11:43	V1.0

---

第一章 概述

1.1 接口协议

    本系统对外接口基于HTTP协议构建，理论上可给所有支持HTTP协议的平台均提供接口服务。

1.2 数据格式

    如无特殊说明，本系统对外接口一律采用JSON数据格式。

1.3 提交方式

    如无特殊说明，本系统对外接口一律采用POST方式提交

1.4 字符集

    如无特殊说明，本系统对外接口一律采用UTF-8数据格式。

1.5 接口授权

    第三方系统与本系统对接前，需先联系我公司商务（或销售）部门申请接入授权码。

    全局定义:

• 接口地址 ：请联系业务人员提供
• agentId ：代理商编码，请联系业务人员提供。
• authCode ：接入授权码，请联系业务人员提供。
• authPwd ：接入密码，请联系业务人员提供。

head参数	参数类型	是否必填	备注
agentId	String	Y	代理商编码
authCode	String	Y	授权码
authPwd	String	Y	授权密码（MD5加密）

java例：

HttpClient client = new HttpClient();
PostMethod postMethod = new PostMethod(url);
postMethod.addRequestHeader("agentid", agentid);
postMethod.addRequestHeader("authcode", authcode);
postMethod.addRequestHeader("authpwd",加密后的{ authpwd }值);

第二章 充值接口

2.1 接口描述

    本接口支持 流量充值、话费充值、视频卡类直充、卡券卡密提取到手机号服务。

2.2 请求地址

    请联系业务运营人员提供。

2.3 请求参数

{
    "rchProduct": "XXXXXX",
    "rchType": "423",
    "rchAccount": "XXXXXX",
    "sign": "77938b6132823423e04d9bfa1c13e7bd",
    "reqTime": "20171110161128",
    "rchMOrdeid": "AOD17111016112848362432"
}

    参数说明

参数	参数类型	是否必填	备注
rchMorderId	String	Y	商户充值订单号,确保唯一
rchAccount	String	Y	充值账号
rchProduct	String	Y	充值产品编号,联系运营提供
rchType	String	Y	充值产品类型见5.2
rchTime	String	Y	充值提交时间格式 yyyyMMddHHmmss
sign	String	Y	sign标识 MD5小写

sign加密规则：

MD5(agentId + authCode + authPwd + rchAccount + rchProduct + rchType + reqTime + rchMOrderId)

2.4 响应报文

{
    "rtCode": "0000",
    "rtMsg": "提交成功",
    "rchAccount": "1048645260",
    "rchMOrderId": "AOD17111016112848362432",
    "rchOrderId": "TKCQOD17111016112968835932"
}

    响应报文说明

参数	参数类型	描述
rchMorderId	String	商户充值订单号
rchAccount	String	充值账号
rchType	String	充值产品类型
rchOrderId	String	平台充值订单号
rtCode	String	平台响应状态（0000提交成功）
rtMsg	String	平台响应状态描述

---

第三章 订单查询接口

3.1 接口描述

    根据平台订单号或者商户订单号查询订单充值状态信息。

3.2 接口地址

    请联系运营人员提供

3.3 请求参数

{
    "rchType": "423",
    "sign": "54b31ab729048bc2d51edec17cdfb343",
    "reqTime": "20171115150638",
    "rchOrderId": "TKCQOD17111016112968835932",
    "rchMOrderId": "10020171031140106160716"
}

    参数说明

参数	参数类型	是否必填	描述
rchOrderId	String	Y	平台订单号
rchMOrderId	String	Y	代理商订单号
rchType	String	Y	充值类型
reqTime	String	Y	请求时间
sign	String	Y	校验标识

sign加密规则：

MD5(agentId + authCode + authPwd + rchOrderId + rchMOrderId + rchType + reqTime)

3.4 响应报文

{
    "finishTime": "2017-11-10 16:11:45",
    "rtMsg": "订单查询成功",
    "rchProduct": " XXXXXX ",
    "rtCode": "2000",
    "rchType": "4",
    "rchAccount": " XXXXXX ",
    "orderStatus": "2",
    "rchMOrdeid": "10020171031140106160716",
    "rchOrdeid": "TKCQOD17111016112968835932"
}

    参数说明

参数	参数类型	描述
rtCode	String	返回编码
rtMsg	String	返回描述
rchOrderId	String	平台订单号
rchMOrderId	String	代理商订单号
rchType	String	充值类型
rchProduct	String	充值产品
orderStatus	String	订单状态
rchAccount	String	充值账号
finishTime	String	完成时间 yyyy-MM-dd hh:mm:ss

---

第四章 回调代理商通知接口

4.1 接口描述

    代理商提交成功后，系统处理成功后回调代理商通知接口，告知成功失败。

4.2 接口地址

    代理商提供

4.3 请求参数

{
    "finishTime": "2017-11-10 16:11:29",
    "rchProduct": "XXX",
    "rchType": "425",
    "orderStatusDesc": "充值成功",
    "rchAccount": "XXXXXX",
    "orderStatus": "2",
    "rchOrdeid": "TKCQOD17111016112968835932",
    "rchMOrdeid": "10020171031140106160716"
}

    参数说明

参数	参数类型	描述
rchMorderId	String	商户充值订单号(确保唯一)
rchOrderId	String	平台充值订单号
rchAccount	String	充值账号
rchProduct	String	充值产品编号
rchType	String	充值产品类型
orderStatus	String	平台订单状态
orderStatusDesc	String	平台订单状态描述

4.4 响应报文

    代理方接收成功返回字符串： ”success”

---

第五章 业务接口参数说明

5.1 订单状态 orderStatus

参数	参数值	参数值描述	备注
orderStatus	1	充值中	平台订单状态
orderStatus	2	充值成功	平台订单状态
orderStatus	3	充值失败	平台订单状态

5.2 充值类型 rchType

参数	参数值	参数值描述	备注
rchType	000	流量	移动
rchType	001	流量	联通
rchType	002	流量	电信
rchType	100	话费	移动
rchType	101	话费	联通
rchType	102	话费	电信
rchType	421	卡密提取	卡号卡密
rchType	422	卡密提取	字串
rchType	423	卡券直充	腾讯Q币
rchType	4241	卡券直充	腾讯视频
rchType	425	卡券直充	联通积分
rchType	426	卡券直充	优酷视频
rchType	427	卡券直充	爱奇艺视频
rchType	428	卡券直充	QQ音乐

5.3 充值产品 rchProduct

    注： 以下充值产品都需平台运营人员配置审核之后才可充值

    流量充值产品：

产品类型	产品编码	产品名称	备注
000	YDHF10	移动话费10元
001	LTHF10	联通话费10元
002	DXHF10	电信话费10元

    话费充值产品：

产品类型	产品编码	产品名称	备注
100	YDQG010200M	移动全国流量200M
101	LTQG010200M	联通全国流量200M
102	DXQG010200M	电信全国流量200M

    卡密提取产品：

产品类型	产品编码	产品名称	备注
421	TKJDK001	京东E卡5元
422	TKZSH001	中石化加油卡100元

    卡券直充产品：

产品类型	产品编码	产品名称	备注
423	TXQQB001	腾讯QQ币1元
423	TXQQB005	腾讯QQ币5元
423	TXQQB010	腾讯QQ币10元
423	TXQQB030	腾讯QQ币30元
4241	TXSP001	腾讯视频VIP周卡
4241	TXSP002	腾讯视频VIP月卡
4241	TXSP004	腾讯视频VIP年卡
425	ZGLTJF001	中国联通100积分
426	YKTD001	优酷土豆黄金会员周卡
426	YKTD002	优酷土豆黄金会员月卡
427	AQYVIP001	爱奇艺黄金会员月卡
428	QQYY001	QQ音乐会员绿钻豪华版一个月

第六章 接口实现代码块

6.1 JAVA版接口请求

6.2 .NET版本接口请求

6.3 JAVA版卡券解密