查询频道重制课件设置

接口描述

1、查询频道重制课件设置
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/pptRecord/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	频道ID

示例

http://api.polyv.net/live/v3/channel/pptRecord/get-setting?appId=fso8gzbxlr&timestamp=1628073087000&channelId=1947328&sign=1337F1DB74DC2E50ABF6F7A74E996769

响应参数描述

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

Data参数描述

参数名	类型	说明
channelId	Integer	频道ID
userId	String	用户ID
type	Integer	视频布局方式，0.三分屏、1.纯文档
globalSettingEnabled	String	应用全局设置开关 Y开启、N关闭
videoRatio	Integer	摄像头画面比例 0为16:9、1为4:3
backgroundImg	String	背景图片，旧版重制1.0使用
brandImg	String	展示图片，新版重制2.0使用

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询重制课件任务列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testPptRecordList() 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/pptRecord/get-setting";
    String channelId="1947328";

    //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": {
        "channelId": 2272655,
        "userId": "1b448be323",
        "type": 0,
        "globalSettingEnabled": "N",
        "backgroundImg": "http://liveimages.videocc.net/uploadimage/20201126/remakeCoursewareBg_1606386346554_8190198.jpg",
        "videoRatio": "0",
        "brandImg": "",
        "createdTime": 1619579289000,
        "lastModified": 1631519980000,
        "actionPosition": "right"
    }
}

异常示例

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