查詢頻道的功能開關狀態

介面描述

1、查询开关状态，可查询全局开关状态或频道开关状态
2、接口支持https协议
3、isClosePreview当enabled值为Y时，表示的是关闭系统观看页；closeDanmu当enabled值为Y时，表示的是关闭弹幕；closeChaterList当enabled值为Y时，表示的是关闭在线列表
4、当频道非三分屏场景时才返回：mobileAudio移动端音频开关，redPack红包开关，praise点赞语开关，chatPlayBack聊天回放开关

介面URL

http://api.polyv.net/live/v3/channel/switch/get

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

範例

https://api.polyv.net/live/v3/channel/switch/get?appId=frlr1zazn3&sign=0EBE4C9FCAEBB325135F0945497C7792&channelId=2191569&timestamp=1621840901604

回應參數描述

Data參數描述

type參數描述

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 查询频道的功能开关状态
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSwitchGet() 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/v3/channel/switch/get";
    String channelId= String.valueOf(2191569);

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道的功能开关状态，返回值：{}", response);
    //do somethings

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "type":"isClosePreview",
            "enabled":"N"
        },
        {
            "type":"mobileWatch",
            "enabled":"Y"
        },
        {
            "type":"autoPlay",
            "enabled":"Y"
        },
        {
            "type":"booking",
            "enabled":"Y"
        },
        {
            "type":"shareBtnEnabled",
            "enabled":"Y"
        },
        {
            "type":"rtsEnabled",
            "enabled":"N"
        },
        {
            "type":"chat",
            "enabled":"Y"
        },
        {
            "type":"consultingMenu",
            "enabled":"Y"
        },
        {
            "type":"closeDanmu",
            "enabled":"N"
        },
        {
            "type":"welcome",
            "enabled":"Y"
        },
        {
            "type":"viewerSendImgEnabled",
            "enabled":"N"
        },
        {
            "type":"sendFlowersEnabled",
            "enabled":"Y"
        },
        {
            "type":"pushSharingEnabled",
            "enabled":"Y"
        },
        {
            "type":"closeChaterList",
            "enabled":"Y"
        }
    ]
}

異常範例

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