获取账号下所有/某个频道号收入详情

接口URL

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

接口说明

1、接口URL中的{userId}为 直播账号ID
2、根据是否提交channelId来获取全部频道/某个频道的收入详情数据
3、接口支持https

支持格式

JSON

请求方式

GET、POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
startDate string 查询的开始日期 格式为yyyy-MM-dd
endDate string 查询的结束日期 格式为yyyy-MM-dd
channelId int 要查询的频道ID,不提交默认为查询所有频道
page int 查询第几页记录,不提交默认为1
pageSize int 每页显示的记录数,不提交默认为12

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": {
        "pageNumber": 1, 
        "totalItems": 2, 
        "contents": [
            {
                "amount": 0.01, 
                "channelId": 108888, 
                "payType": "good", 
                "payTypeName": "道具打赏", 
                "viewerName": "广州观众/17914", 
                "payTime": 1495441670000, 
                "outTradeNo": "4008262001201705222058849969"
            }, 
            {
                "amount": 0.01, 
                "channelId": 108888, 
                "payType": "good", 
                "payTypeName": "道具打赏", 
                "viewerName": "珠海观众/18040", 
                "payTime": 1490681792000, 
                "outTradeNo": "4008262001201703284937190753"
            }
        ], 
        "offset": 0, 
        "limit": 2, 
        "endRow": 2, 
        "firstPage": true, 
        "totalPages": 1, 
        "prePageNumber": 1, 
        "lastPage": true, 
        "startRow": 1, 
        "nextPageNumber": 1
    }
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

日期格式不正确

{
    "code": 400,
    "status": "error",
    "message": "日期格式要求为yyyy-MM-dd.",
    "data": ""
}

频道号不属于当前账号

{
    "code": 400,
    "status": "error",
    "message": "channelId is mismatching.",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
pageNumber 当前页
totalItems 记录的总数
amount 金额
payType 收入类型:good、cash、pay
payTypeName 收入类型的名称:道具打赏、现金打赏、付费观看
viewerName 付费观众昵称
payTime 付费时间
outTradeNo 保利威视系统内部订单号
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一条记录在总记录中的位置
endRow 当前页最后一个记录在总记录中的位置
limit 当前页纪录数
offset 当前页第一条记录在总记录中的位置

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数(非sign)赋值
$userId = "XXXXXXXX";
$startDate = "2017-09-11";
$endDate = "2018-03-08";
$channelId = 127075;
$page = 1;
$pageSize = 15;

$params = array(
    'appId'=>$appId,
    'startDate'=>$startDate,
    'endDate'=>$endDate,
    'channelId'=>$channelId,
    'page'=>$page,
    'pageSize'=>$pageSize,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url = "http://api.polyv.net/live/v2/user/".$userId."/get-income-detail?appId=".$appId."&timestamp=".$timestamp."&sign=".$sign."&endDate=".$endDate."&startDate=".$startDate."&channelId=".$channelId."&page=".$page."&pageSize=".$pageSize;
//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...