Query User Bill Usage Details

API Description

1、查询用户账单使用明细数据

2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/use-detail/list

Online API Call

Request Method

GET

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameters

Example

http://api.polyv.net/live/v4/channel/use-detail/list?pageNumber=1&endDate=2023-08-04&itemCategory=duration&appId=frlr1zazn3&sign=EAD6F8790A2AD758C4D15FD81216E074&pageSize=10&startDate=2023-08-04&timestamp=1691131787072

Response Parameters

Data Parameter Description

Contents Parameter Description

Error Parameter Description

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. HttpUtil.java and LiveSignUtil.java in the test cases are included in the download file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询用户账单使用明细数据
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void useDetailListTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/use-detail/list";
    String startDate = "2023-08-04";
    String endDate = "2023-08-04";
    String itemCategory = "duration";
    String pageNumber = "1";
    String pageSize = "10";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("endDate", endDate);
    requestMap.put("itemCategory", itemCategory);
    requestMap.put("startDate", startDate);
    requestMap.put("timestamp", timestamp);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    
    log.info("测试查询用户账单使用明细数据成功：{}", response);
    //do somethings
    
}

Response Example

See Global Error Description for system-wide error explanations.

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "f2d3faf76c90440b80b91a21a36df545.67.16911317891895057",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 1,
        "contents": [
            {
                "statDate": "2023-08-04",
                "production": "直播",
                "itemCategory": "直播分钟数",
                "itemName": "国内观看时长",
                "channelId": 3346714,
                "recordId": "test-001234",
                "consumed": 1,
                "consumeUnit": "分钟",
                "startTime": "2023-08-04 13:03:01",
                "endTime": "2023-08-04 14:48:36",
                "remark": "测试-001234",
                "sessionId": "20230804130301999999",
                "avgBitRate": "1200"
            }
        ]
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}