查询频道角色权限设置

接口描述

1、查询频道角色权限设置
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/role-config/get-by-role

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
channelId	true	Integer	频道ID
role	true	String	角色类型 Teacher：讲师、Guest：嘉宾

示例

http://api.polyv.net/live/v4/channel/role-config/get-by-role?channelId=4872391&role=Teacher&timestamp=1721290785000&appId=fso8gzbxlr&sign=386B2A96BE453F70FD9071A5190890B8

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	视频列表【详见data字段说明】

Error参数描述

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

data参数描述

参数名	类型	说明
webStartCheckInDisplayEnabled	String	开播端签到功能显示开关 Y：开启、N：关闭
webStartLotteryDisplayEnabled	String	开播端抽奖功能显示开关 Y：开启、N：关闭
webStartQuestionnaireDisplayEnabled	String	开播端问卷功能显示开关 Y：开启、N：关闭
webStartAnswerDisplayEnabled	String	开播端答题卡功能显示开关 Y：开启、N：关闭
webStartTimerDisplayEnabled	String	开播端定时器功能显示开关 (角色类型为讲师时有此字段) Y：开启、N：关闭
webStartRedPackDisplayEnabled	String	开播端红包功能显示开关 Y：开启、N：关闭
webStartCardPushDisplayEnabled	String	开播端卡片推送功能显示开关 Y：开启、N：关闭
webStartNotifyDisplayEnabled	String	开播端公告功能显示开关 Y：开启、N：关闭
webStartLinkMicDisplayEnabled	String	开播端连麦功能显示开关 Y：开启、N：关闭
webStartMultiMediaDisplayEnabled	String	开播端多媒体功能显示开关 Y：开启、N：关闭
webStartMembersDisplayEnabled	String	开播端成员列表功能显示开关 Y：开启、N：关闭
screenShareRetainCameraEnabled	String	共享保持摄像头状态开关 Y：开启、N：关闭
multiplexingDefaultLayout	String	混流布局默认应用 (角色类型为讲师时有此字段) 1：单人模式、2：平铺模式、3：主讲模式
cameraSingleModeEnabled	String	摄像头单人模式开关 Y：开启、N：关闭
aiVirtualBgUrl	String	AI抠像背景图
remixDefaultEnabled	String	混音默认开关 Y：开启、N：关闭
showSceneTemplateEnabled	String	是否显示场景模板开关 Y：开启、N：关闭
hideFramesDirectionEnabled	String	隐藏画面方向切换入口开关 Y：开启、N：关闭
defaultOpenMicLinkEnabled	String	是连麦默认方式 (角色类型为讲师时有此字段) video：音视频、audio：音频

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 getChannelRoleConfigTest() 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/channel/role-config/get-by-role";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", "4872391");
    requestMap.put("role", "Teacher");
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    
    log.info("测试查询频道角色权限设置成功：{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
	"code": 200,
	"status": "success",
	"requestId": "8f8672f1cd6a4a33a42974742c981c07.73.17212907857930173",
	"data": {
		"webStartCheckInDisplayEnabled": "N",
		"webStartLotteryDisplayEnabled": "Y",
		"webStartQuestionnaireDisplayEnabled": "Y",
		"webStartAnswerDisplayEnabled": "Y",
		"webStartTimerDisplayEnabled": "Y",
		"webStartRedPackDisplayEnabled": "Y",
		"webStartCardPushDisplayEnabled": "Y",
		"webStartNotifyDisplayEnabled": "Y",
		"webStartLinkMicDisplayEnabled": "Y",
		"webStartMultiMediaDisplayEnabled": "Y",
		"webStartMembersDisplayEnabled": "Y",
		"screenShareRetainCameraEnabled": "N",
		"multiplexingDefaultLayout": "2",
		"cameraSingleModeEnabled": "N",
		"aiVirtualBgUrl": "https://polyv-doc.oss-cn-shenzhen.aliyuncs.com/images/default/default_ai_virtual_bg.jpg",
		"remixDefaultEnabled": "N",
		"showSceneTemplateEnabled": "Y",
		"hideFramesDirectionEnabled": "N",
		"defaultOpenMicLinkEnabled": "video"
	},
	"success": true
}

异常示例

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