保利威文档中心

幫助中心

查詢角色列表

更新時間:2023-06-09 09:08:29

介面描述

1、查询子账号角色权限列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/children/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伺服器取得回應資料【詳見簽名生成規則

範例

https://api.polyv.net/live/v4/user/children/role/list?appId=frlr1zazn3&timestamp=1670482607000&sign=91F4CBF905DED94336F34F246D8D700D

回應參數描述

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

Error參數描述

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

data參數描述

參數名 類型 說明
id Integer 角色ID
name String 角色名稱
description String 角色描述,備註
permissionName String 權限名稱,多個權限名稱用英文逗號”,“分割

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 getUserRoleListTest() 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/children/role/list";
    
    //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": "ea917b23a1114d82b16dd9ad4ae89b31.69.16704826088465019",
    "data": [
        {
            "id": 2,
            "name": "直播频道管理员",
            "description": "拥有频道级管理的能力",
            "permissionName": "新建直播,直播方式,页面装修,角色设置,课件资源,观看限制,聊天室设置,观看页设置,商品库,邀请海报,报名观看,分享设置,渠道推广,打赏,广告,公众号,卡片推送,回放设置,视频库,重制课件,直播间统计,场次报表,防录屏跑马灯,虚拟人数设置,转播,线上双师,多会场,其他设置,图文直播,直播监控,导播台,录制设置,管理分类,直播分类,删除频道,红包,云分发,消息通知,互动游戏,客户端下载,帮助中心,在线咨询,意见反馈,消息中心,观看链接,编辑直播间信息,装修页-播放器,条件抽奖,坐席,预设红包,云剪辑,风险测评,子账号修改密码,素材库,音频审核"
        },
        {
            "id": 1,
            "name": "管理员",
            "description": "拥有直播平台的所有功能",
            "permissionName": "新建直播,直播方式,页面装修,角色设置,课件资源,观看限制,聊天室设置,观看页设置,商品库,邀请海报,报名观看,分享设置,渠道推广,打赏,广告,公众号,卡片推送,回放设置,视频库,重制课件,直播间统计,场次报表,防录屏跑马灯,虚拟人数设置,转播,线上双师,多会场,其他设置,平台统计,直播间统计,场次统计,用户统计,默认模板,图文直播,直播监控,导播台,录制设置,严禁词设置,短信平台,客户端,虚拟昵称,频道设置,开发者设置,回调设置,积分打赏设置,财务概览,账单明细,使用明细,我的账户,我要提现,收入详情,提现记录,管理分类,直播分类,删除频道,购买并发,页脚设置,红包,云分发,消息通知,互动游戏,客户端下载,帮助中心,在线咨询,意见反馈,消息中心,观看链接,编辑直播间信息,装修页-播放器,条件抽奖,坐席,预设红包,组织架构,子账号用量,云剪辑,风险测评,子账号修改密码,互动脚"
        }
    ],
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询