Query Account Co-connect Minutes

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

Interface Description

1、查询账号连麦分钟数
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/statistics/mic/get-duration

Online API Call

Request Method

GET

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls are subject to frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details: Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See details: Signature Generation Rules

Example

http://api.polyv.net/live/v3/channel/statistics/mic/get-duration?appId=frlr1zazn3&sign=771D13739CCA0D6CE3AF16BE4520580B&timestamp=1621844607955

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure See details: Global Error Description
status	String	Response status text
message	String	Response description. When code is 400 or 500, it provides additional error details
data	Object	On successful response, returns co-connect minutes usage and remaining balance See details: Data Field Description

Data Parameter Description

Parameter	Type	Description
available	Integer	Remaining co-connect minutes
history	Integer	Used co-connect minutes

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded 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 pooling.

private static final Logger log = LoggerFactory.getLogger(AccountTest.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/v3/channel/statistics/mic/get-duration";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询账号连麦分钟数，返回值：{}", response);
    //do somethings

}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "available":5000,
        "history":3
    }
}

Error Example

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

Live Streaming Server API