查询默认模板角色权限设置

下载 PDF

下载 Word

接口描述

1、查询默认模板角色权限设置
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/user/template/role-config/get

在线API调用

请求方式

GET

接口约束

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

请求参数描述

示例

http://api.polyv.net/live/v4/user/template/role-config/get?timestamp=1721289427000&appId=fso8gzbxlr&sign=01FBD9537679A0ADFDC92B8DE8716289

响应参数描述

Data参数描述

TeacherConfig参数描述

GuestConfig参数描述

Error参数描述

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 getRoleConfigTemplateTest() 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/template/role-config/get";

    //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

}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "8f8672f1cd6a4a33a42974742c981c07.68.17212894281000069",
    "data": {
        "teacherConfig": {
            "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": "3",
            "cameraSingleModeEnabled": "N",
            "aiVirtualBgUrl": "https://polyv-doc.oss-cn-shenzhen.aliyuncs.com/images/default/default_ai_virtual_bg.jpg",
            "remixDefaultEnabled": "N",
            "defaultOpenMicLinkEnabled": "video"
        },
        "guestConfig": {
            "webStartCheckInDisplayEnabled": "Y",
            "webStartLotteryDisplayEnabled": "Y",
            "webStartQuestionnaireDisplayEnabled": "Y",
            "webStartAnswerDisplayEnabled": "Y",
            "webStartRedPackDisplayEnabled": "Y",
            "webStartCardPushDisplayEnabled": "Y",
            "webStartNotifyDisplayEnabled": "Y",
            "webStartLinkMicDisplayEnabled": "Y",
            "webStartMultiMediaDisplayEnabled": "Y",
            "webStartMembersDisplayEnabled": "Y",
            "screenShareRetainCameraEnabled": "N",
            "cameraSingleModeEnabled": "N",
            "aiVirtualBgUrl": "https://polyv-doc.oss-cn-shenzhen.aliyuncs.com/images/default/default_ai_virtual_bg.jpg",
            "remixDefaultEnabled": "N"
        }
    },
    "success": true
}

异常示例

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