Modify Live Category Name

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

API Description

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

API URL

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

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" name cannot be modified.

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 for signature generation is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay request data to the POLYV server.` See Signature Generation Rules
categoryId	true	String	Channel category ID
categoryName	true	String	Channel category name

Example

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

Form parameters:

appId=frlr1zazn3&sign=EF68992D79446070C6300677A30B4440&categoryName=%E5%88%86%E7%B1%BB234&categoryId=345134&timestamp=1621841517741

Response Parameters

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure See Global Error Description
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error details
data	String	Returns an empty string for both success and failure

Category Parameter Description

Parameter	Required	Type	Description
categoryId	false	String	Category ID
categoryName	false	String	Channel category name

Java Request Example

For quick integration, download the relevant dependency source code. Click to download source code. After downloading, add it to your project source code. 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 pools.

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 修改某个分类的名称
 * @throws IOException
 */
@Test
public void testUpdateCategoryName() 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-name";
    String categoryId = "345134";
    String categoryName = "分类234";
    
    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("categoryId",categoryId);
    requestMap.put("categoryName",categoryName);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改某个分类的名称：{}",response);
    //do somethings
    
}

Response Example

For 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": ""
}