分页查询暂存视频大纲

下载 PDF

下载 Word

接口描述

1、分页查询指定频道下已创建的暂存视频大纲（AI看）任务，无需逐个提交暂存文件ID。
2、接口返回大纲和答题内容的 json 地址，内容需由调用方自行请求该地址获取。
3、接口仅查询已有结果，不会触发大纲生成。
4、接口支持 HTTPS 协议。

接口URL

https://api.polyv.net/live/v4/channel/record-file/subtitle/outline/list

请求方式

GET

接口约束

1、接口调用有频率限制，建议使用 HTTPS，详见调用限制。

2、请在服务端生成签名并调用接口，严禁在 Web、App、小程序等客户端保存或使用 appSecret。

3、只返回已创建过大纲任务的暂存文件；从未发起过大纲生成的暂存文件不会出现在结果中。

4、只返回当前账号有权限访问的频道数据。

请求参数描述

请求示例

https://api.polyv.net/live/v4/channel/record-file/subtitle/outline/list?appId=yourAppId&timestamp=1700000000000&sign=YOUR_SIGN&channelId=1234567&pageNumber=1&pageSize=10

响应参数描述

error参数描述

data参数描述

contents参数描述

同一页中可能同时存在已完成、生成中、生成失败的记录，单个文件的生成状态不影响同页其他文件的返回。

大纲内容结构

请求 outlineUrl 得到的 json 结构如下：

{
  "introduction": "本场直播的整体内容简介",
  "outlineContent": [
    {
      "title": "分段标题",
      "startTime": "00:00:00,020",
      "endTime": "00:03:17,080",
      "startIndex": 0,
      "endIndex": 94,
      "summary": [
        "该分段的内容要点一",
        "该分段的内容要点二"
      ],
      "keyword": [
        "关键词一",
        "关键词二"
      ]
    }
  ]
}

答题内容结构

请求 questionUrl 得到的 json 结构如下：

{
  "questions": [
    {
      "questionId": "示例题目ID",
      "summaryId": 1,
      "question": "题干内容",
      "selectOptions": [
        {
          "option": "A",
          "content": "选项A的内容"
        },
        {
          "option": "B",
          "content": "选项B的内容"
        }
      ],
      "answer": "A",
      "type": "single",
      "videoReviewTime": 120,
      "questionTriggerTime": 180,
      "videoReviewTimeFormat": "00:02:00,000",
      "questionTriggerFormat": "00:03:00,000"
    }
  ]
}

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 pageRecordFileOutlineTest() throws IOException, NoSuchAlgorithmException {
    //公共参数，填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "https://api.polyv.net/live/v4/channel/record-file/subtitle/outline/list";
    String channelId = "1234567";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("pageNumber", "1");
    requestMap.put("pageSize", "10");
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);
    log.info("测试分页查询暂存视频大纲成功：{}", response);
    //do somethings
}

响应示例

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

成功示例：

{
  "code": 200,
  "status": "success",
  "success": true,
  "requestId": "示例请求ID",
  "error": null,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalItems": 3,
    "contents": [
      {
        "fileId": "示例暂存文件ID1",
        "status": "success",
        "outlineUrl": "https://liveimages.videocc.net/video-outline/xxxxxxxxxx/示例大纲文件.json",
        "questionUrl": "https://liveimages.videocc.net/video-question/xxxxxxxxxx/示例答题文件.json",
        "failReason": null
      },
      {
        "fileId": "示例暂存文件ID2",
        "status": "outline_processing",
        "outlineUrl": null,
        "questionUrl": null,
        "failReason": null
      },
      {
        "fileId": "示例暂存文件ID3",
        "status": "fail",
        "outlineUrl": null,
        "questionUrl": null,
        "failReason": "找不到暂存文件字幕"
      }
    ]
  }
}

异常示例：

{
  "code": 400,
  "status": "error",
  "requestId": "示例请求ID",
  "error": {
    "code": 20001,
    "desc": "application not found."
  },
  "success": false
}