保利威文档中心

帮助中心

查询账号收入详情

更新时间:2022-09-23 10:07:04

接口描述

1、接口URL中的{userId}为直播账号ID
2、根据是否提交channelId来查询账号收入详细信息
3、接口支持https协议

接口URL

http://api.polyv.net/live/v2/user/{userId}/get-income-detail

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看

请求参数描述

参数名 必选 类型 说明
appId true String 账号appId【详见获取密钥
timestamp true Long 当前13位毫秒级时间戳,3分钟内有效
sign true String 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则
startDate true String 查询的开始日期 格式为yyyy-MM-dd
endDate true String 查询的结束日期 格式为yyyy-MM-dd
channelId false String 要查询的频道号,不提交或者传0则查询所有频道
page false Integer 页码,不提交默认为1
pageSize false Integer 每页数据大小,不提交默认为12

示例

http://api.polyv.net/live/v2/user/{userId}/get-income-detail

表单参数:

endDate=2021-12-11&appId=frlr1zazn3&sign=4EFC44F3108FA3DAF0DF1578E9DE49A4&pageSize=20&page=1&startDate=2019-11-24&channelId=1965681&timestamp=1621844561516

响应参数描述

参数名 类型 说明
code Integer 响应状态码,200为成功返回,非200为失败【详见全局错误说明
status String 响应状态文本信息
message String 响应描述信息,当code为400或者500的时候,辅助描述错误原因
data Object 响应成功时返回收入详情信息【详见data字段说明
Data参数描述
参数名 类型 说明
pageSize Integer 每页显示的记录数,不提交默认为12
pageNumber Integer 当前页数
totalItems Integer 总的条数
contents Array 查询的结果列表,收入详情【详见Contents参数描述
startRow Integer 当前页第一条记录在总结果集中的位置
firstPage Boolean 是否为第一页,值为:true/false,默认为false
lastPage Boolean 是否为最后一页,值为:true/false,默认为false
prePageNumber Integer 上一页编号
limit Integer 每页数量大小
totalPages Integer 总页数
endRow Integer 当前页最后一条记录在总结果集中的位置
nextPageNumber Integer 下一页编号
offset Integer 分页起始记录
Contents参数描述
参数名 类型 说明
userId String POLYV用户ID,和保利威官网一致,获取路径:官网->登录->直播(开发设置)
amount Float 金额,单位元
goodNum Integer 道具打赏数量
channelId String 频道号
payType String 收入类型
cash:现金打赏
pay:付费观看
good:道具打赏(现金礼物)
point:积分打赏(积分礼物)
payTypeName String 收入类型的名称:道具打赏(现金礼物)、现金打赏、付费观看、积分打赏(积分礼物)
viewerName String 付费观众昵称
payTime Long 付费时间,13位毫秒级时间戳
weixinAppId String 微信公众号AppId
outTradeNo String 保利威视系统内部订单号
openId String 公众号下用户唯一标识openId

Java请求示例

快速接入基础代码请下载相关依赖源码点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 查询账号收入详情
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetIncomeDetail() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url=String.format("http://api.polyv.net/live/v2/user/%s/get-income-detail",userId);
    String startDate="2019-11-24";
    String endDate="2021-12-11";
    String channelId="1965681";
    String page=String.valueOf(1);
    String pageSize=String.valueOf(20);

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("startDate", startDate);
    requestMap.put("endDate", endDate);
    requestMap.put("channelId", channelId);
    requestMap.put("page", page);
    requestMap.put("pageSize", pageSize);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试查询账号收入详情,返回值:{}", response);
    //do somethings

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "pageSize":20,
        "pageNumber":1,
        "totalItems":2,
        "contents":[
            {
                "userId":"1b448be323",
                "amount":0.01,
                "goodNum":1,
                "channelId":1965681,
                "payType":"good",
                "payTypeName":"道具打赏",
                "viewerName":"王勋",
                "payTime":1616749953000,
                "weixinAppId":"视频直播平台",
                "outTradeNo":"4200000986202103266004002654",
                "openId":"ovtl9twa7JHyHBBA8QUNVjjM4WIs"
            },
            {
                "userId":"1b448be323",
                "amount":0.02,
                "goodNum":null,
                "channelId":1965681,
                "payType":"cash",
                "payTypeName":"现金打赏",
                "viewerName":"长沙观众/95916",
                "payTime":1604911816000,
                "weixinAppId":"视频直播平台",
                "outTradeNo":"4200000848202011099220088137",
                "openId":"ovtl9t5XNOfIGQ5q-MQ5thHRhGjc"
            }
        ],
        "startRow":1,
        "firstPage":true,
        "lastPage":true,
        "prePageNumber":1,
        "limit":2,
        "totalPages":1,
        "nextPageNumber":1,
        "endRow":2,
        "offset":0
    }
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询