Query Role List

Updated: 2023-06-09 09:08:29

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See Signature Generation Rules

Example

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result, determined by business, success returns success, failure returns error
success	Boolean	Response result, determined by business, success returns true, failure returns false
data	Array	Role list See data field description
error	Object	Error information when status code is non-200 See Error field description
requestId	String	Request ID, a unique UUID generated for each request, only for troubleshooting and debugging, not to be tied to business

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error cause
desc	String	Error description, corresponding to error.code

data Parameter Description

Parameter	Type	Description
id	Integer	Role ID
name	String	Role name
description	String	Role description, notes
permissionName	String	Permission names, multiple names separated by commas ","

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pool.

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
    
}

Response Example

For global error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API