查询频道回放设置

单独查询回放开关可使用旧版接口，接口地址查询频道回放开关

接口描述

1、查询频道回放设置
2、接口支持https协议

接口URL

https://api.polyv.net/live/v3/channel/playback/get-setting

在线API调用

请求方式

GET

接口约束

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

请求参数描述

示例

http://api.polyv.net/live/v3/channel/playback/get-setting?appId=frlr1zazn3&sign=9DC1D9A3AAD34E0DD5C3B3154F1A6F5D&channelId=3187786&timestamp=1655964947987

响应参数描述

Data参数描述

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 查询频道回放设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetPlaybackSetting() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/playback/get-setting";
    String channelId = "3187786";
    
    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": {
        "channelId": 3187786,
        "type": "single",
        "origin": "record",
        "videoId": null,
        "playbackEnabled": "Y",
        "videoName": null,
        "sectionEnabled": "Y",
        "globalSettingEnabled": "N",
        "chatPlaybackEnabled": "N",
        "crontabType":"period",
        "startTime": 1694102400000,
        "endTime": 1695398400000,
        "productPlaybackEnabled": null,
        "customOpenDuration": 18,
        "playbackMultiplierEnabled": "Y",
        "playbackProgressBarEnabled": "Y",
        "playbackProgressBarOperationType": "drag",
        "showPlayButtonEnabled": "Y",
        "questionnairePlaybackEnabled": "N",
        "qaPlaybackEnabled": "N",
        "cardPushPlaybackEnabled": "N",
        "checkInPlaybackEnabled": "N"
    }
}

异常示例

参数错误

{
    "code": 400,
    "status": "error",
    "message": "param validate error",
    "data": 400
}

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

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

签名错误

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