Query Default Template Role Permission Settings

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have frequency limits. See details

Request Parameter Description

Example

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

Response Parameter Description

Data Parameter Description

TeacherConfig Parameter Description

GuestConfig Parameter Description

Error Parameter Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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
}

Error Example

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