重制课件参数获取
更新时间：2022-09-02 18:08:07
接口URL
https://api.polyv.net/live/v3/channel/pptRecord/get-setting
接口说明
1、接口用于设置重制课件参数
2、接口支持https
支持格式
JSON
请求方式
GET、POST
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取，在直播系统登记的appId |
| timestamp | 是 | long | 13位当前毫秒级时间戳 |
| sign | 是 | String | 签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | 是 | int | 频道号 |
响应成功JSON示例：
{
"code": 200,
"status": "success",
"message": "",
"data": {
"channelId": 1947328,
"userId": "cf7f07e096",
"type": 0,
"globalSettingEnabled": "N",
"backgroundImg": "http://liveimages.videocc.net/uploaded/images/2020/12/fu9tqrl4wj.jpg",
"videoRatio": "0",
"brandImg": "http://liveimages.videocc.net/uploadimage/20201224/remakeCoursewareBg_1608804635322_7656406.png",
"createdTime": 1602471455000,
"lastModified": 1608859631000
}
}
响应字段说明
| 参数名 | 说明 |
|---|---|
| code | 状态码,成功为200，签名失败为403，参数错误为400，服务端错误为500 |
| status | 成功为success,错误时为error |
| message | 成功为""，错误时为错误描述信息 |
| data | 响应数据 |
| data.globalSettingEnabled | 是否使用通用设置，Y.是、N.否 |
| data.type | 视频布局方式，0.三分屏、1.纯文档 |
| data.videoRatio | 摄像头画面比例，0表示16:9、1表示4:3 |
| data.brandImgFile | 展示图片 |
| data.backgroundImgFile | 背景图片 |
响应失败JSON示例：
参数错误
{
"code": 400,
"status": "error",
"message": "param validate error",
"data": ""
}
未输入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": ""
}
非法频道号
{
"code": 403,
"status": "error",
"message": "illegal channel id: %s",
"data": ""
}
java请求示例
public void testAddRecordTask() {
String url = "https://api.polyv.net/live/v3/channel/pptRecord/get-setting";
// appId和加密串
String appId = "xxxxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxx";
int channelId = 123;
Map<String, String> params = new HashMap<>();
params.put("channelId", String.valueOf(channelId));
// 调用Polyv的工具类方法设置sign
PolyvTool.setLiveSign(params, appId, appSecret);
String content = HttpClientUtil.getInstance()
.sendHttpPost(url, params);
System.out.println(content);
}
