查询频道的功能开关状态

接口描述

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 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

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

示例

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

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Array	成功响应时返回开关状态信息数组【详见data字段说明】

Data参数描述

参数名	类型	说明
type	String	开关类型【取值详见type字段说明】
enabled	String	开关值，取值Y/N，具体说明和类型相关【说明详见type字段说明】

type参数描述

参数名	说明
isClosePreview	是否关闭系统观看页 Y：关闭 N：开启
mobileWatch	是否开启移动端系统观看页
mobileAudio	是否开启移动端音视频切换
autoPlay	是否开启播放器自动播放功能
booking	是否开启预约功能
redPack	是否开启红包功能
shareBtnEnabled	是否开启分享功能
chat	是否开启聊天室
chatPlayBack	是否开启聊天回放开关
closeChaterList	是否关闭在线列表 Y：关闭 N：开启
consultingMenu	是否开启咨询提问
closeDanmu	是否关闭弹幕功能 Y：关闭 N：开启
praise	是否开启点赞语功能
welcome	是否开启欢迎语功能
sendFlowersEnabled	是否开启送花开关
pushSharingEnabled	是否开启推流端分享开关
viewerSendImgEnabled	是否开启观众发送图片
qaMenuEnabled	是否开启问答功能 Y：开启 N：关闭
filterManagerMsgEnabled	过滤聊天室管理员的聊天消息开关，即观看页聊天室只看主持人开关
showCustomMessageEnabled	显示自定义消息开关
chatOnlineNumberEnable	在线人数开关

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