完整儲存使用者等級列表
更新時間:2026-09-24 12:37:01
介面說明
1、全量保存账号的用户等级列表:请求中的等级列表会整体覆盖原有等级,未包含在请求中的等级将被删除,数组顺序即等级顺序
2、(timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、用户等级为账号级配置,账号下所有频道共用同一套等级;直播模板和频道只控制是否展示等级
4、管理后台【用户】→【用户等级】和开放API读写同一份配置,任一入口保存成功后,另一入口查询到相同结果
5、接口支持https协议
介面URL
http://api.polyv.net/live/v4/user/viewer-level/save
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、介面根據簽名中的 appId 確定目標帳號,不接收使用者ID或頻道號
3、每個帳號至少保留1個、最多儲存100個等級;同一請求中的等級標識 levelId 不能重複
4、已開通保利威使用者體系的帳號,每個等級都必須設定積分門檻 requiredPoints,且按陣列順序嚴格遞增,即後一個等級的積分門檻必須大於前一個等級
5、未開通使用者體系的帳號只儲存等級名稱、圖示、底色和說明等展示配置,請求中的 requiredPoints 不生效:已有等級(按 levelId 匹配)沿用原積分門檻,新增等級的積分門檻為0
6、建議先呼叫查詢使用者等級列表取得目前配置,在此基礎上修改後整體提交,避免誤刪等級
7、使用者等級的功能說明詳見使用者等級
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
請求體參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| levels | true | Array | 等級列表,陣列順序即等級順序,至少1個、最多100個【詳見levels參數說明】 |
levels參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| levelId | true | String | 等級標識,帳號內唯一;以字母或數字開頭,僅支援字母、數字、底線和中劃線,最長64個字元 |
| levelName | true | String | 等級名稱,展示給觀眾,最長10個字元 |
| levelIcon | false | String | 等級圖示URL,最長512個字元;未設定時展示等級名稱和底色 |
| levelBgColor | false | String | 等級底色,格式為#RGB或#RRGGBB,如#FF6456 |
| description | false | String | 等級說明,僅用於後台識別和管理,不展示給觀眾,最長100個字元 |
| requiredPoints | false | Long | 積分門檻,即觀眾獲得該等級所需的最低累計獲得積分,取值1~999999 已開通使用者體系時必填,且按陣列順序嚴格遞增 未開通使用者體系時傳入的值不生效 |
範例
http://api.polyv.net/live/v4/user/viewer-level/save?appId=frlr1zazn3&sign=49428741C1D7BEE8BE1EE545F066ECC7×tamp=1677167340447
請求體json參數:
{
"levels": [
{
"levelId": "bronze",
"levelName": "青铜",
"levelIcon": "https://s1.videocc.net/default-img/level-icon/v1/bronze.png",
"levelBgColor": "#FF6456",
"description": "新用户默认等级",
"requiredPoints": 1
},
{
"levelId": "silver",
"levelName": "白银",
"levelBgColor": "#5E81FF",
"requiredPoints": 1000
}
]
}
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與http狀態碼相同,用於確定基本的回應狀態 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
| requestId | String | 請求ID,每次請求產生的唯一的UUID,僅可用於排查、除錯,不應該和業務掛鉤 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error參數說明】 |
| data | Boolean | 是否儲存成功,true表示儲存成功 |
Error參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因【詳見錯誤碼說明】 |
| desc | String | 錯誤描述,與error.code對應 |
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 testViewerLevelSave() 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/save";
List<Map<String, Object>> levels = new ArrayList<>();
Map<String, Object> bronze = new HashMap<>();
bronze.put("levelId", "bronze");
bronze.put("levelName", "青铜");
bronze.put("levelIcon", "https://s1.videocc.net/default-img/level-icon/v1/bronze.png");
bronze.put("levelBgColor", "#FF6456");
bronze.put("description", "新用户默认等级");
bronze.put("requiredPoints", 1);
levels.add(bronze);
Map<String, Object> silver = new HashMap<>();
silver.put("levelId", "silver");
silver.put("levelName", "白银");
silver.put("levelBgColor", "#5E81FF");
silver.put("requiredPoints", 1000);
levels.add(silver);
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
Map<String, Object> jsonMap = new HashMap<>();
jsonMap.put("levels", levels);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
log.info("测试全量保存用户等级列表,返回值:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "414afeb28f1c4f0ca17e1c3c1e39d247.71.16771673423081591",
"data": true,
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 25105,
"desc": "最低积分需大于上一等级的最低积分"
},
"success": false
}
錯誤碼說明
| 錯誤碼 | 錯誤描述 | 說明 |
|---|---|---|
| 10001 | 至少保留1個會員等級 | 未傳levels,或levels為空陣列 |
| 10001 | 最多支援100個會員等級 | levels超過100個 |
| 10001 | 等級標識不能為空 | 未傳levelId |
| 10001 | 等級標識僅支援字母、數字、底線和中劃線,且以字母或數字開頭 | levelId格式不正確,或超過64個字元 |
| 10001 | 等級名稱不能為空 | 未傳levelName |
| 10001 | 等級名稱不能超過10個字元 | levelName超過10個字元 |
| 10001 | 等級圖示地址過長 | levelIcon超過512個字元 |
| 10001 | 等級顏色格式不正確 | levelBgColor不是#RGB或#RRGGBB格式 |
| 10001 | 等級描述不能超過100個字元 | description超過100個字元 |
| 10001 | 最低積分不能小於1 | requiredPoints小於1 |
| 10001 | 最低積分不能大於999999 | requiredPoints大於999999 |
| 25102 | 等級標識不能重複 | levels中存在相同的levelId |
| 25104 | 最低積分必須為非負整數 | 已開通使用者體系時,存在未傳requiredPoints的等級 |
| 25105 | 最低積分需大於上一等級的最低積分 | 已開通使用者體系時,requiredPoints未按陣列順序嚴格遞增 |
