Query Account Available Live Minutes

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

API Description

1、查询账号可用直播分钟数
2、接口支持https协议

API URL

http://api.polyv.net/live/v2/user/get-user-durations

Online API Call

Request Method

POST

API Constraints

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

Request Parameters

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, 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 relayed through the customer's own server to call the POLYV server for response data.` See Signature Generation Rules

Example

http://api.polyv.net/live/v2/user/get-user-durations

Form Parameters:

appId=frlr1zazn3&sign=5976AF067958E48D1312B9AC78B3AD30&timestamp=1621844576282

Response Parameters

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See Global Error Description
status	String	Response status text
message	String	Response description, assists in describing error reasons when code is 400 or 500
data	Object	Returns account available live minutes information on success See data field description

Data Parameter Description

Parameter	Type	Description
userId	String	POLYV user ID, consistent with the Polyv official website. Retrieval path: Official website -> Login -> Live (Development Settings)
available	Long	Currently available minutes
used	Long	Historically used minutes

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases HttpUtil.java and LiveSignUtil.java 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(AccountTest.class);
/**
 * 查询账号直播分钟数
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetUserDurations() 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/v2/user/get-user-durations";

    //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.postFormBody(url, requestMap);
    log.info("测试查询账号直播分钟数，返回值：{}", response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "userId":"1b448be323",
        "available":9610,
        "used":570
    }
}

Error Example

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

Live Streaming Server API