# 查询单个角色信息

### 接口描述

```
1、查询频道内某个助教或嘉宾的具体信息
2、接口URL中的{channelId}为频道号
3、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v2/channelAccount/{channelId}/account
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v2/channelAccount/%7BchannelId%7D/account/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)】 |
| account   | true | String | 助教/嘉宾账号（不能以数字类型提交，否则可能去掉角色号前的00）                                                                                                                                                                          |

### 示例

```requestUrl
https://api.polyv.net/live/v2/channelAccount/2191541/account?appId=frlr1zazn3&sign=2D733253D9E982E7AEE33C083A388AC1&account=0052191541&timestamp=1621841869093
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                                      |
| ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】                                                        |
| status  | String  | 响应状态文本信息                                                                                                                                                                                |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                                                                       |
| data    | Object  | 请求失败时为空，请求成功时为角色的信息 【详见[data字段描述](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/channel/operate/get_account.md?id=data%E5%AD%97%E6%AE%B5%E6%8F%8F%E8%BF%B0)】 |

#### data字段描述

| 参数名                    | 类型      | 说明                                             |
| ---------------------- | ------- | ---------------------------------------------- |
| account                | String  | 助教/嘉宾账号                                        |
| userId                 | String  | POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置）       |
| channelId              | String  | 频道号                                            |
| passwd                 | String  | 角色密码                                           |
| nickname               | String  | 角色名称                                           |
| stream                 | String  | 角色流名，单独使用无效                                    |
| status                 | String  | 角色状态                                           |
| createdTime            | Long    | 创建角色时间                                         |
| lastModified           | Long    | 角色最后修改时间                                       |
| sort                   | Integer | 频道角色序号                                         |
| avatar                 | String  | 角色头像                                           |
| pageTurnEnabled        | String  | <p>是否拥有翻页权限，只能一个角色有，仅支持三分屏场景<br>Y：是<br>N：否</p> |
| notifyEnabled          | String  | <p>是否拥有发布公告权限<br>Y：是<br>N：否</p>                |
| checkinEnabled         | String  | <p>是否拥有开启签到权限<br>Y：是<br>N：否</p>                |
| voteEnabled            | String  | <p>是否拥有发起投票权限<br>Y：是<br>N：否</p>                |
| lotteryEnabled         | String  | <p>是否拥有抽奖权限<br>Y：是<br>N：否</p>                  |
| role                   | String  | <p>角色<br>Assistant：助教<br>Guest：嘉宾</p>          |
| chatListEnabled        | String  | <p>助教页在线列表显示开关<br>Y：开启<br>N：关闭</p>             |
| chatAuditEnabled       | String  | <p>助教聊天审核<br>Y：开启<br>N：关闭</p>                  |
| monitorEnabled         | String  | <p>助教监播开关<br>Y：开启<br>N：关闭</p>                  |
| roundTourEnabled       | String  | <p>助教轮巡开关<br>Y：开启<br>N：关闭</p>                  |
| watchLockEnabled       | String  | <p>锁定直播间功能开关<br>Y：开启<br>N：关闭</p>               |
| chatInteractionEnabled | String  | <p>互动发言功能开关<br>Y：开启<br>N：关闭</p>                |
| pushUrl                | 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(ChannelOperateTest.class);
/**
 * 查询角色信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetAccount() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v2/channelAccount/%s/account";
    String channelId="2149710";
    String account = "0062149710";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("account", account);
    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",
    "message":"",
    "data":{
        "account":"0062149710",
        "userId":"1b448be323",
        "channelId":2149710,
        "passwd":"xxxxxx",
        "nickname":"杨老师123",
        "stream":"km1bdhf9",
        "status":"Y",
        "createdTime":1615252064000,
        "lastModified":1615254463000,
        "channelSessionId":null,
        "sort":6,
        "avatar":"//s1.videocc.net/default-img/avatar/assistant.png",
        "actor":"助教",
        "pageTurnEnabled":"N",
        "notifyEnabled":"Y",
        "checkinEnabled":"Y",
        "voteEnabled":"Y",
        "lotteryEnabled":"Y",
        "role":"Assistant",
        "chatListEnabled":"Y",
        "chatAuditEnabled":"N",
        "monitorEnabled":"N",
        "roundTourEnabled":"N",
        "watchLockEnabled":"N",
        "pushUrl":"rtmp://push-d1.videocc.net/recordf/1b448be32316137918188520c60km1bdhf9?auth_key=1615258732-0-0-52776ade7d496c0bd8c2da61d80cc0e1"
    }
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
```
