查詢用戶等級列表

更新時間：2026-09-24 12:37:01

介面描述

1、查询账号的用户等级列表，按等级顺序升序返回
2、用户等级为账号级配置，账号下所有频道共用同一套等级；直播模板和频道只控制是否展示等级
3、管理后台【用户】→【用户等级】和开放API读写同一份配置，任一入口保存成功后，另一入口查询到相同结果
4、账号从未配置过用户等级时，首次查询会初始化5个默认等级（青铜、白银、黄金、钻石、皇冠）并保存
5、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/viewer-level/get

線上API呼叫

請求方式

GET

介面限制

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

2、介面根據簽名中的 appId 確定目標帳號，不接收用戶ID或頻道號

3、用戶等級的功能說明詳見用戶等級

請求參數說明

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

範例

http://api.polyv.net/live/v4/user/viewer-level/get?appId=frlr1zazn3&sign=49428741C1D7BEE8BE1EE545F066ECC7&timestamp=1677167340447

回應參數說明

參數名	類型	說明
code	Integer	狀態碼，與http狀態碼相同，用於確定基本的回應狀態
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應
requestId	String	請求ID，每次請求生成的唯一UUID，僅可用於排查、除錯，不應與業務掛鉤
error	Object	狀態碼非200時的錯誤資訊【詳見Error參數說明】
data	Array	用戶等級列表，按等級順序升序排列【詳見data參數說明】

Error參數說明

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

data參數說明

參數名	類型	說明
levelId	String	等級標識，帳號內唯一
levelName	String	等級名稱
levelIcon	String	等級圖示URL，未設定時為null
levelBgColor	String	等級底色，格式為#RGB或#RRGGBB，未設定時為null
description	String	等級說明，僅用於後台識別和管理，不展示給觀眾，未設定時為null
requiredPoints	Long	積分門檻，即觀眾獲得該等級所需的最低累計獲得積分
sortOrder	Integer	等級順序，從1開始遞增

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询用户等级列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testViewerLevelGet() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/user/viewer-level/get";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试查询用户等级列表，返回值：{}", response);
    //do somethings

}

回應範例

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

成功範例（首次查詢時回傳的預設等級）

{
    "code": 200,
    "status": "success",
    "requestId": "414afeb28f1c4f0ca17e1c3c1e39d247.71.16771673423081591",
    "data": [
        {
            "levelId": "bronze",
            "levelName": "青铜",
            "levelIcon": "https://s1.videocc.net/default-img/level-icon/v1/bronze.png",
            "levelBgColor": "#FF6456",
            "description": null,
            "requiredPoints": 1,
            "sortOrder": 1
        },
        {
            "levelId": "silver",
            "levelName": "白银",
            "levelIcon": "https://s1.videocc.net/default-img/level-icon/v1/silver.png",
            "levelBgColor": "#5E81FF",
            "description": null,
            "requiredPoints": 1000,
            "sortOrder": 2
        },
        {
            "levelId": "gold",
            "levelName": "黄金",
            "levelIcon": "https://s1.videocc.net/default-img/level-icon/v1/gold.png",
            "levelBgColor": "#FF894E",
            "description": null,
            "requiredPoints": 3000,
            "sortOrder": 3
        },
        {
            "levelId": "diamond",
            "levelName": "钻石",
            "levelIcon": "https://s1.videocc.net/default-img/level-icon/v1/diamond.png",
            "levelBgColor": "#A361FF",
            "description": null,
            "requiredPoints": 5000,
            "sortOrder": 4
        },
        {
            "levelId": "crown",
            "levelName": "皇冠",
            "levelIcon": "https://s1.videocc.net/default-img/level-icon/v1/crown.png",
            "levelBgColor": "#FB5C91",
            "description": null,
            "requiredPoints": 10000,
            "sortOrder": 5
        }
    ],
    "success": true
}

異常範例

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