Create Live Category

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

API Description

1、创建直播分类
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/user/category/create

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. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
categoryName	true	string	Category name

Example

http://api.polyv.net/live/v3/user/category/create

Form Parameters:

appId=frlr1zazn3&sign=8D7D02BC9081B6DF5E9D4A651A7BDE35&categoryName=%E5%88%86%E7%B1%BB23411&timestamp=1621841318228

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, provides error details when code is 400 or 500
data	Object	Category information returned on success See Data Field Description

Data Parameter Description

Parameter	Type	Description
categoryId	String	Category ID
categoryName	String	Channel category name
userId	String	POLYV user ID, same as on the Polyv official website. Path: Official website -> Login -> Live (Development Settings)
rank	Integer	Category sort order, rank=0 indicates default sorting

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 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
 * @throws NoSuchAlgorithmException
 */
@Test
public void testCreateCategory() 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/create";
    String categoryName="分类23411";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    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":{
        "categoryId":360879,
        "categoryName":"分类23411",
        "userId":"1b448be323",
        "rank":4
    }
}

Error Example

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