查询频道回放设置

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

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

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

请求参数描述

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

示例

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

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Object	请求成功返回频道回放设置【详见data参数描述】

Data参数描述

参数名	类型	说明
channelId	String	频道号
type	String	回放类型 single：单个视频回放 list：列表回放
playbackEnabled	String	回放的开关 Y：开启 N：关闭
origin	String	回放的视频来源 record：录制文件 playback：回放列表 vod：点播列表
videoId	String	回放的视频ID
videoName	String	回放的视频名称
sectionEnabled	String	回放设置，章节开关 Y：开启 N：关闭
globalSettingEnabled	String	是否应用通用设置 Y：是 N：否
chatPlaybackEnabled	String	聊天重放 Y：开启 N：关闭
crontabType	String	定时回放类型 timedOpen：定时打开，timedClosed：定时关闭，period：时间段内打开,custom-自定义,disable：关闭
startTime	Long	放开回放的时间,13位毫秒级时间
endTime	Long	关闭回放的时间,13位毫秒级时间
playbackMultiplierEnabled	String	倍数播放开关 Y：开启 N：关闭
playbackProgressBarEnabled	String	进度条开关 Y：开启 N：关闭
playbackProgressBarOperationType	String	进度条操作方式 drag 拖动,prohibitDrag 禁止拖动,dragHistoryOnly 只能拖动已观看内容
showPlayButtonEnabled	String	显示播放按钮开关 Y：开启 N：关闭
customOpenDuration	Long	定时回放：自定义时间,crontType为custom自定义时生效
productPlaybackEnabled	String	商品库开关 Y：开启 N：关闭,开启后，回放时观众将看到商品列表和推送商品，将读取后台最新的商品数据。

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

异常示例

参数错误

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