Platform Content Library Group List

Updated: 2025-05-12 15:33:25

Interface Description

1、平台内容库分组列表
2、接口支持https协议

Interface URL

https://api.polyv.net/live/v4/global/robot/label/list

Online API Call

Request Method

GET

Interface Constraints

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

Request Parameter Description

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 never be saved 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 Signature Generation Rules
type	true	String	Tag type: script - content library, robot - member library

Request Body Parameter Description

Parameter	Required	Type	Description

Example

https://api.polyv.net/live/v4/global/robot/label/list?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318&type=robot

Request body JSON parameters:

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result, determined by business logic: success returns "success", failure returns "error"
success	Boolean	Response result, determined by business logic: success returns true, failure returns false
data	Array	Tag data [See Data Field Description](#Data Parameter Description)
error	Object	Error information when status code is non-200 See Error Field Description
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, should not be tied to business logic

Data Parameter Description

Parameter	Type	Description
id	Long	Group (labelId or tag) ID
name	String	Group name
type	String	Type: SYS - system material, USER - personal material
updateTime	Long	Last update time

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error cause
desc	String	Error description, corresponding to error.code

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 code project. HttpUtil.java and LiveSignUtil.java from the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API functionality integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 平台内容库分组列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void listTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "https://api.polyv.net/live/v4/global/robot/label/list";
    String type = "robot";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("type", type);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.get(url, null);
    
    log.info("测试平台内容库分组列表结果：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "data": [
        {
            "id": 900000000,
            "name": "通用组",
            "type": "SYS",
            "updateTime": 4102416000000
        },
        {
            "id": 900000001,
            "name": "中老年组",
            "type": "SYS",
            "updateTime": 4102416000000
        },
        {
            "id": 900000002,
            "name": "中文名组",
            "type": "SYS",
            "updateTime": 4102416000000
        },
        {
            "id": 900000009,
            "name": "英文名组",
            "type": "SYS",
            "updateTime": 4102416000000
        },
        {
            "id": 5300,
            "name": "111",
            "type": "USER",
            "updateTime": 1747015055000
        },
        {
            "id": 4961,
            "name": "默认分类",
            "type": "USER",
            "updateTime": 1742785082000
        }
    ],
    "requestId": "92dca09e-5a7d-4afe-a950-d352ac60f0ed",
    "status": "success",
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API