Query Channel Role Permission Settings

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

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

Request Parameter Description

Example

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

Response Parameter Description

Error Parameter Description

data 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. HttpUtil.java and LiveSignUtil.java in the test cases are included 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 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
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

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

Error Example

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