查询默认模板回放设置
更新时间:2026-03-05 17:25:45
接口描述
1、查询回放默认模板设置
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/user/template/playback-setting/get
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| timestamp | true | String | 当前13位毫秒级时间戳,3分钟内有效 |
示例
http://api.polyv.net/live/v4/user/template/playback-setting/get?appId=frlr1zazn3&sign=82ADECF49C78E5F6399D99A6EDE4EEAD×tamp=1677167039930
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码,与 http 状态码相同,用于确定基本的响应状态 |
| data | Object | 模板-回放设置对象【详见Data参数描述】 |
| error | Object | 状态码非200时的错误信息【详见Error参数描述】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 是否成功响应 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| playbackEnabled | String | 回放开关 Y:开启 N:关闭 |
| type | String | 观看页回放方式 single:单个视频 list:列表回放 |
| origin | String | 回放视频来源 record:暂存 playback:回放列表 vod:点播列表 |
| sectionEnabled | String | 章节开关 Y:开启 N:关闭 |
| chatPlaybackEnabled | String | 聊天回放开关 Y:开启 N:关闭 |
| playbackMultiplierEnabled | String | 倍数播放开关 Y:开启 N:关闭 |
| playbackProgressBarEnabled | String | 进度条开关 Y:开启 N:关闭 |
| playbackProgressBarOperationType | String | 进度条操作方式 drag 拖动,prohibitDrag 禁止拖动,dragHistoryOnly 只能拖动已观看内容 |
| showPlayButtonEnabled | String | 显示播放按钮开关 Y:开启 N:关闭 |
| chatPlaybackEnabled | String | 聊天互动重现开关 Y:开启 N:关闭 |
| productPlaybackEnabled | String | 商品库互动重现开关 Y:开启 N:关闭 |
| questionnairePlaybackEnabled | String | 问卷互动重现开关 Y:开启 N:关闭 |
| qaPlaybackEnabled | String | 答题卡互动重现开关 Y:开启 N:关闭 |
| cardPushPlaybackEnabled | String | 卡片推送互动重现开关 Y:开启 N:关闭 |
| checkInPlaybackEnabled | String | 签到互动重现开关 Y:开启 N:关闭 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询回放默认模板设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getPlaybackSettingTest() 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/user/template/playback-setting/get";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询回放默认模板设置成功:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "62420aef40254ac2b8b13a9a0895d285.75.16771670417921429",
"data": {
"playbackEnabled": "Y",
"sectionEnabled": "N",
"type": "single",
"origin": "record",
"chatPlaybackEnabled": "Y",
"playbackMultiplierEnabled": "Y",
"playbackProgressBarEnabled": "N",
"playbackProgressBarOperationType": "drag",
"showPlayButtonEnabled": "N",
"chatPlaybackEnabled": "Y",
"productPlaybackEnabled": "Y",
"questionnairePlaybackEnabled": "Y",
"qaPlaybackEnabled": "Y",
"cardPushPlaybackEnabled": "Y",
"checkInPlaybackEnabled": "Y"
},
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
