查詢應用角色列表

更新時間：2025-07-17 14:55:09

介面描述

1、查询应用角色列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/webapp-role/list

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

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

範例

http://api.polyv.net/live/v4/user/webapp-role/list?pageNumber=1&appId=frlr1zazn3&sign=76AEC105CAD0C5091FCECCF14FC6DA74&pageSize=10&timestamp=1699580616354

回應參數描述

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

Error參數描述

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

Data參數描述

參數名	類型	說明
contents	Array	分頁資料集合【詳見Contents參數描述】
pageNumber	Integer	當前頁碼，第幾頁
pageSize	Integer	分頁大小
totalItems	Integer	總記錄數
totalPages	Integer	總頁數

Contents參數描述

參數名	類型	說明
id	Integer	角色ID
name	String	角色名稱
userId	String	使用者ID
description	String	角色描述
status	Boolean	角色狀態
createdTime	Long	建立時間戳
lastModified	Long	最後修改時間戳
permissionName	String	權限名稱
isOldRole	Boolean	是否為舊角色
type	String	角色類型(root:僅主帳號可見， child:主帳號和子帳號都可見)

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 getRoleListTest() 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/webapp-role/list";
    String pageNumber = "1";
    String pageSize = "10";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询应用角色列表成功：{}", response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "bf2ffb7b-b062-4e6b-ba70-94b5495c2591",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 7,
        "contents": [
            {
                "id": 3519,
                "name": "123222",
                "userId": "2b3ccac944",
                "description": "",
                "status": true,
                "createdTime": 1752720853000,
                "lastModified": 1752720858000,
                "permissionName": "新建直播",
                "isOldRole": false,
                "type": "root"
            },
            {
                "id": 3518,
                "name": "测试",
                "userId": "2b3ccac944",
                "description": "123123",
                "status": true,
                "createdTime": 1752720399000,
                "lastModified": 1752720399000,
                "permissionName": "新建直播",
                "isOldRole": false,
                "type": "root"
            }
        ]
    },
    "success": true
}

異常範例

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