You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒资管理/字幕管理/获取字幕文件
获取字幕文件
最近更新时间：2024.11.19 11:14:15首次发布时间：2021.07.21 13:28:23
我的收藏

此接口用于获取字幕文件。

使用说明

支持获取指定 Vid 下的全部字幕文件，或指定条件（文件 ID、语言、标签、状态等）获取相应的字幕。

请求说明

请求地址：https://vod.volcengineapi.com?Action=GetSubtitleInfoList&Version=2020-08-01

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数
类型
是否必选
示例值
描述
Action
String
是
GetSubtitleInfoList
接口名称。当前 API 的名称为 GetSubtitleInfoList。
Version
String
是
2020-08-01
接口版本。当前 API 的版本为 2020-08-01。
Vid
String
是
v02c24g10***1v0vp92fsfu0
视频 ID。将音视频上传至视频点播服务后，可通过媒体上传完成事件获取 Vid。
FileIds
String
否
ueyrfeuiw2388***

字幕文件 ID 列表。不传默认返回 Vid 下所有字幕。多个用 , 隔开。最多 20 个。

说明

传参中的重复值或空值会默认过滤。

Languages
String
否
cmn-Hans-CN

字幕语言。取值如下：

  • cmn-Hans-CN：简体中文。
  • eng-US：英语。

说明

更多取值请见字幕语言。

Formats
String
否
webvtt

字幕格式。取值如下：

  • webvtt
  • ass
  • srt
  • ssa
LanguageIds
String
否
1

字幕语言 ID 列表。多个 ID 用 , 隔开。取值如下：

  • 1：简体中文。
  • 2：英语。

说明

更多取值请见字幕语言。

SubtitleIds
String
否
-482590843
字幕 ID 列表。多个 ID 用英文逗号 , 隔开。最多 10 个。
Status
String
否
Published

字幕状态。取值如下：

  • Published：发布。
  • Unpublished：未发布。
Title
String
否
视频
标题。
Tag
String
否
视频01
标签。
Offset
String
否
0

偏移量。默认为 0。

说明

此参数在指定 FileIds 获取字幕文件时生效。

PageSize
String
否
10

分页大小。默认为 10，最大可指定 20。

说明

此参数在指定 FileIds 获取字幕文件时生效。

Ssl
String
否
0

字幕 URL 是否为 HTTPS 地址。取值如下：

  • 1：是。
  • 0：（默认）否。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数
类型
示例值
描述
Vid
String
v02c24g1000***s1v0vp92fsfu0
视频 ID。
FileSubtitleInfoList
Object[]
-
字幕文件信息列表。
FileId
String
ueyrfeuiw2388***
字幕文件 ID。
SubtitleInfoList
Object[]
-
字幕信息列表。
Vid
String
v029c1g10003civ2i5mqib*******
视频 ID。
FileId
String
v029c1g10003civ2i5mqib*******
字幕文件 ID。
Language
String
eng-US
字幕语言。
LanguageId
Integer
1
字幕语言 ID。详见字幕语言。
Format
String
webvtt
字幕格式。
SubtitleId
String
123
字幕 ID。
Title
String
subtitle.vtt
字幕标题。
Tag
String
subtitle
字幕标签。
Status
String
enable
字幕状态。
Source
String
MU
字幕来源。
StoreUri
String
tos-vod-cn-**/191fe22a1c4a49************
字幕文件存储地址。
SubtitleUrl
String
http://example.com/191fe22a1c4a************
字幕文件访问地址。
CreateTime
String
2019-10-12T07:20:50.52Z
创建时间。
Version
String
1
字幕版本。
NotExistFileIds
String[]
[]
不存在的 FileID 列表。
TotalCount
Integer
1
符合条件的结果总数。
Offset
Integer
0
当前查询的偏移量。
PageSize
Integer
10
分页大小。

请求示例

https://vod.volcengineapi.com?Action=GetSubtitleInfoList&Version=2020-08-01&Vid=v02c24g10***1v0vp92fsfu0&FileIds=
ueyrfeuiw2388***&Languages=cmn-Hans-CN&Formats=webvtt&LanguageIds=1&SubtitleIds=-482590843&Status=Published&Title=视频&Tag=视频01&Offset=0&PageSize=10&Ssl=0

返回示例

{
  "ResponseMetadata": 
  {
    "RequestId": "20201124165******34080031B5",
    "Action": "GetSubtitleInfoList",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": 
  {
    "Vid":"v02c24g1000***s1v0vp92fsfu0",
    "FileSubtitleInfoList":[
      {
        "FileId":"v02c24g***0j9s1v0vp92fsfu0",
        "SubtitleInfoList":[
          {
            "Vid":"v02c24g1000***s1v0vp92fsfu0",
            "FileId":"v02c24g***0j9s1v0vp92fsfu0",
            "Language":"cmn-Hans-CN",
            "LanguageId":1,
            "Format":"webvtt",
            "SubtitleId":"4377df***",
            "Title":"测试",
            "Tag":"aa",
            "Status":"Status",
            "Source":"MU",
            "StoreUri":"tos-vod-cn-v-03e***12705/621cb02a0***f06c0a63445e8eb",
            "SubtitleUrl":"https://example.vod.com/621cb02***06c0a63445e8eb?auth_key=170366212***3c01840654eb307\u0026mime_type=text_plain",
            "CreateTime":"2023-12-27 14:36:00",
            "Version":"Version"
          }
        ]
      }
    ],
    "NotExistFileIds":["NotExistFileIds"
    ],
    "TotalCount":1,
    "Offset":1,
    "PageSize":1
  }

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码错误码错误信息说明
400InvalidParameter.ItemLimitExceeded-FileId 个数大于 20。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：