查询重制课件任务列表

接口描述

1、查询课件重制任务列表
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/pptRecord/list

在线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

频道号

sessionId

false

String

重制课件模块中的场次id

status

false

String

状态值 waiting:等待处理 process:处理中 success:重制成功 fail:重制失败 uploaded:上传点播成功 uploadFailed:上传点播失败 vodOweUploadFailed:点播欠费 vodSpaceOverUploadFailed:点播空间不足

startTime

false

String

直播开始时间开始区间,格式为yyyyMMddHHmmss

endTime

false

String

直播开始时间结束区间,格式为yyyyMMddHHmmss

page

false

Integer

分页页码

pageSize

false

Integer

每页数据大小

示例

http://api.polyv.net/live/v3/channel/pptRecord/list?appId=frlr1zazn3&sign=4D564199C480715472D1929201121282&pageSize=2&startTime=20200111000000&sessionId=fsb50pwxec&endTime=20201111000000&page=1&channelId=1965681&timestamp=1621842179615&status=success

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

Object

响应成功时返回重制课件结果集【详见data字段说明

Data参数描述

参数名类型说明

pageNumber

Integer

当前页数

totalPages

Integer

总页数

pageSize

Integer

每页数据大小

contents

Array

任务列表【详见Contents参数描述

Contents参数描述

参数名类型说明

taskId

Integer

任务id

channelId

String

频道号

title

String

对应回放的名称

url

String

重制mp4下载地址,有24小时的防盗链超时时间

sessionId

String

重制课件模块中的场次id

startTime

String

对应回放的直播开始时间,格式为yyyyMMddhhmmss

status

String

状态值 waiting:等待处理 process:处理中 success:重制成功 fail:重制失败 uploaded:上传点播成功 uploadFailed:上传点播失败

remainDay

Integer

重制剩余的过期时间,过期后将无法访问和下载

duration

Integer

重制的视频时长,单位秒

videoId

String

直播系统视频ID,如:992d36fa40

vid

String

重制课件上传到点播的点播视频VID

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/list";
    String channelId="1965681";
    String sessionId="fsb50pwxec";
    String status="success";
    String startTime="20200111000000";
    String endTime="20201111000000";
    String page=String.valueOf(1);
    String pageSize=String.valueOf(2);

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sessionId", sessionId);
    requestMap.put("status", status);
    requestMap.put("startTime", startTime);
    requestMap.put("endTime", endTime);
    requestMap.put("page", page);
    requestMap.put("pageSize", pageSize);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询重制课件任务列表,返回值:{}", response);
    //do somethings

}
    

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageNumber": 1,
        "totalPages": 1,
        "pageSize": 2,
        "contents": [
            {
                "taskId": 236067,
                "channelId": 1965681,
                "title": "修改标题后",
                "url": "http://playback.videocc.net/transform/992d36fa40_0.mp4?auth_key=1652509714-0-0-31919e0b005ec2c1b89b0385394f88ec",
                "sessionId": "fsb50pwxec",
                "startTime": "20201021145602",
                "status": "success",
                "remainDay": 0,
                "duration": 5,
                "videoId": "992d36fa40",
                "vid": "1b448be32312e7504159ce7008c81295_1"
            },
            {
                "taskId": 402456,
                "channelId": 1965681,
                "title": "回放183-33",
                "url": "http://playback.videocc.net/transform/14785e39ff_1.mp4?auth_key=1654219664-0-0-a3ca953d6666a788151abe56009ac90a",
                "sessionId": "g1yjsdnu9q",
                "startTime": "20210901171754",
                "status": "success",
                "remainDay": 0,
                "duration": 92,
                "videoId": "14785e39ff",
                "vid": null
            }
        ]
    }
}

异常示例

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

Last updated