查询频道号下所有角色信息

接口描述

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

接口URL

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

在线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/v2/channelAccount/2191541/accounts?appId=frlr1zazn3&sign=BE8A0E88376E1B4BB1BBB48BADD5AFBE&timestamp=1621841937679

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Array	请求失败时为空，请求成功时为角色的信息 【详见data字段描述】

data字段描述

参数名	类型	说明
account	String	助教/嘉宾账号
userId	String	POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置）
channelId	String	频道号
passwd	String	角色密码
nickname	String	角色名称
stream	String	角色流名，单独使用无效
status	String	角色状态
createdTime	Long	创建角色时间
lastModified	Long	角色最后修改时间
sort	String	频道中所有角色序号
avatar	String	角色头像
actor	String	角色头衔
pageTurnEnabled	String	是否拥有翻页权限，只能一个角色有，仅支持三分屏场景 Y：是 N：否
notifyEnabled	String	是否拥有发布公告权限 Y：是 N：否
checkinEnabled	String	是否拥有开启签到权限 Y：是 N：否
voteEnabled	String	是否拥有发起投票权限 Y：是 N：否
lotteryEnabled	String	是否拥有抽奖权限 Y：是 N：否
role	String	角色 Assistant：助教 Guest：嘉宾
chatListEnabled	String	助教页在线列表显示开关 Y：开启 N：关闭
chatAuditEnabled	String	助教聊天审核 Y：开启 N：关闭
monitorEnabled	String	助教监播开关 Y：开启 N：关闭
roundTourEnabled	String	助教轮巡开关 Y：开启 N：关闭
watchLockEnabled	String	锁定直播间功能开关 Y：开启 N：关闭
chatInteractionEnabled	String	互动发言功能开关 Y：开启 N：关闭
pushUrl	String	角色推流地址，角色推流请参考后台导播台使用

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 *查询频道号下所有角色信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetAccounts() 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/accounts";
    String channelId="2149710";
    
    url = String.format(url, channelId);
    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",
    "message":"",
    "data":[
        {
            "account":"0072149710",
            "userId":"1b448be323",
            "channelId":2149710,
            "passwd":"xxxxxx",
            "nickname":"赵老师",
            "stream":"km1fvuo3",
            "status":"Y",
            "createdTime":1615259640000,
            "lastModified":1615259640000,
            "channelSessionId":null,
            "sort":7,
            "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/1b448be32316137918188520c60km1fvuo3?auth_key=1615341964-0-0-fc732106ae504b75082042014f616f34"
        }
    ]
}

异常示例

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