最近更新时间：2024.01.08 17:26:44
首次发布时间：2021.07.21 13:28:23
此接口用于获取字幕文件。
支持获取指定 Vid 下全部字幕文件，或指定条件（转码流 FileId、语言、标签、状态等）获取对应的字幕。
请求频率：单用户请求频率限制为 10 次/秒。
请求地址：https://vod.volcengineapi.com?Action=GetSubtitleInfoList&Version=2020-08-01
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetSubtitleInfoList | 接口名称。当前 API 的名称为 GetSubtitleInfoList。 |
| Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01。 |
Vid | String | 是 |
| 音视频 ID。音视频上传后，获取
|
FileIds | String | 否 |
| 转码视频 ID 列表。不传默认返回 说明 传参中的重复值或空值会默认过滤。 |
Languages | String | 否 |
| 字幕语言。取值如下：
说明 更多支持的取值请参见字幕语言。 |
Formats | String | 否 |
| 字幕格式。取值如下：
|
LanguageIds | String | 否 |
| 字幕语言 ID 列表。多个用 "," 隔开。取值如下：
说明 更多支持的取值请参见字幕语言。 |
| SubtitleIds | String | 否 | -482590843 | 字幕 ID 列表，多个用英文逗号 , 隔开。最多 10 个。 |
Status | String | 否 |
| 字幕状态列表。取值如下：
|
| Title | String | 否 | 视频 | 标题。 |
| Tag | String | 否 | 视频01 | 标签。 |
Offset | String | 否 |
| 偏移量。默认为 0。 说明 此参数在指定 |
PageSize | String | 否 |
| 分页大小。默认为 10，最大可指定 20。 说明 此参数在指定 |
Ssl | String | 否 |
| 字幕 URL 是否为 HTTPS 地址。取值如下：
|
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vid | String | v02c24g1000***s1v0vp92fsfu0 | 视频 ID。 |
| FileSubtitleInfoList | Array of FileSubtitleInfoList | - | 字幕信息列表。 |
| NotExistFileIds | Array of String | [] | 不存在的转码 FileID 列表。 |
| TotalCount | Integer | 1 | 符合条件的视频结果总数。 |
| Offset | Integer | 0 | 当前查询的偏移量。 |
| PageSize | Integer | 10 | 分页大小。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| FileId | String | ueyrfeuiw2388*** | 转码视频 ID。 |
| SubtitleInfoList | Array of SubtitleInfoList | - | 字幕列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vid | String | v02c24g1000***s1v0vp92fsfu0 | 视频 ID。 |
| FileId | String | v02c24g***0j9s1v0vp92fsfu0 | 转码视频 ID。 |
| Language | String | cmn-Hans-CN | 字幕语言。 |
| LanguageId | Integer | hds843** | 字幕语言 ID。 |
| Format | String | webvtt | 字幕格式。 |
| SubtitleId | String | -482590843 | 字幕 ID。 |
| Title | String | 测试 | 字幕标题。 |
| Tag | String | aa | 字幕标签。 |
Status | String |
| 字幕状态。取值如下：
|
Source | String |
| 字幕来源。取值如下：
|
| StoreUri | String | tos-vod-cn-v-03e***12705/621cb02a0***f06c0a63445e8eb | 存储地址。 |
| SubtitleUrl | String | https://example.vod.com/621cb02***06c0a63445e8eb?auth_key=170366212***3c01840654eb307\u0026mime_type=text_plain | 字幕播放地址。 |
| CreateTime | String | 2023-12-27 14:36:00 | 创建时间。 |
| Version | String | 1 | 字幕版本。 |
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 }
本接口无特有的错误码。更多信息请见公共错误码。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | InvalidParameter.ItemLimitExceeded | - | FileId 个数大于 20。 |
点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：