Modify Live Category Order

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

API Description

1、修改直播频道分类的顺序
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/user/category/update-rank

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
The "Default Category" cannot be reordered.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details for obtaining 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 for generating 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 to the POLYV server for response data.` See signature generation rules
categoryId	true	String	Category ID
afterCategoryId	true	String	Move the category to the position after the category corresponding to this ID

Example

http://api.polyv.net/live/v3/user/category/update-rank

Form parameters:

afterCategoryId=345111&appId=frlr1zazn3&sign=B4B478890FEE3A332984025DF46FB7B0&categoryId=345134&timestamp=1621841596190

Response Parameter Description

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, auxiliary error reason when code is 400 or 500
data	String	Returns an empty string for both success and failure

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. 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(AccountTest.class);
/**
 * 修改直播分类顺序
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateCategoryRank() 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/user/category/update-rank";
    String categoryId = "345134";
    String afterCategoryId="345111";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryId", categoryId);
    requestMap.put("afterCategoryId", afterCategoryId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改直播分类顺序，返回值：{}", response);
    //do somethings

}

Response Example

For system global error descriptions, see Global Error Description

Success example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":""
}

Error example

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