Query Account Time Range Co-connect Usage

Updated: 2022-09-02 18:08:07

API Description

1、查询账号时间范围连麦使用量
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/statistics/mic/history/get

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
Co-connect usage is calculated daily. Due to large data volume and computation, results have a two-day delay. Data from today can only be queried the day after tomorrow (summarized at 2:00 AM).

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, 32-character uppercase MD5 value. `The appSecret key used for signature generation is critical for communication data security. It must never be saved or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
startTime	false	Long	Start time, 13-digit millisecond timestamp (date only)
endTime	false	Long	End time, 13-digit millisecond timestamp (date only)

Example

http://api.polyv.net/live/v4/statistics/mic/history/get?appId=frlr1zazn3&sign=9DB0C793E311FD297EDCA9DBB9F0E3B4&startTime=1632672000000&endTime=1633017600000&timestamp=1657848439743

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging, not for business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	See data field description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error cause
desc	String	Error description, corresponds to error.code

data Parameter Description

Parameter	Type	Description
userId	String	User ID
history	Integer	Co-connect usage minutes

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download source code. After downloading, add it to your own source project. The test case files HttpUtil.java and LiveSignUtil.java are included in the download package.

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

private static final Logger log = LoggerFactory.getLogger(UserTest.class);
/**
 * 查询账号时间范围连麦使用量
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testMicDuration() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/statistics/mic/history/get";
    String startTime = "1632672000000";
    String endTime = "1633017600000";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("startTime", startTime);
    requestMap.put("endTime", endTime);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询账号时间范围连麦使用量，返回值：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "2268eadf53ff49009a2c37927da52fd2.61.16578482803179325",
    "data": {
        "userId": "1b448be323",
        "history": 101
    },
    "success": true
}

Error Example

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

Live Streaming Server API