# 查询角色列表

### 接口描述

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

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v4/user/children/role/list/README.md)

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |

### 示例

```requestUrl
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字段说明](#data参数描述)】            |
| error     | Object  | 状态码非200时的错误信息【详见[Error字段说明](#error参数描述)】 |
| requestId | String  | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |

### Error参数描述

| 参数名  | 类型      | 说明                   |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因     |
| desc | String  | 错误描述，与 error.code 对应 |

#### data参数描述

| 参数名            | 类型      | 说明                    |
| -------------- | ------- | --------------------- |
| id             | Integer | 角色ID                  |
| name           | String  | 角色名称                  |
| description    | String  | 角色描述，备注               |
| permissionName | String  | 权限名称，多个权限名称用英文逗号”,“分割 |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
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
    
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

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

异常示例

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://polyv.gitbook.io/document/docs/live/api/v-4/user/children/role/list.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.