平台內容庫分組列表

更新時間：2025-05-12 15:33:25

介面說明

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

介面URL

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

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位元毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位元大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
type	true	String	標籤類型: script-內容庫，robot-成員庫

請求體參數說明

參數名	必選	類型	說明

範例

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

請求體json參數：

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗
status	String	回應結果，由業務決定，成功返回success，失敗返回error
success	Boolean	回應結果，由業務決定，成功返回true，失敗返回false
data	Array	標籤資料【[Data欄位說明](#Data 參數說明)】
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求產生的唯一的 UUID，僅可用於排查、除錯，不應該和業務掛上鉤

Data參數說明

參數名	類型	說明
id	Long	分組(labelId或標籤)ID
name	String	分組名稱
type	String	類型: SYS-系統素材，USER-個人素材
updateTime	Long	最後更新時間

Error參數說明

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

Java請求範例

快速接入基礎代碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

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
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "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
}

異常範例

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