You need to enable JavaScript to run this app.
文档中心
文档备案控制台
视频直播

视频直播

请输入
  • 文档首页
    • 视频直播API 参考声影同传ListSpeechSubtitleSrt - 获取字幕 SRT 文件
复制全文
下载 pdf
我的收藏
声影同传
ListSpeechSubtitleSrt - 获取字幕 SRT 文件
复制全文
下载 pdf
我的收藏
ListSpeechSubtitleSrt - 获取字幕 SRT 文件

调用 ListSpeechSubtitleSrt 接口，获取声影同传或字幕任务（非纯字幕模式）的字幕 SRT 文件。

使用说明

您可调用本接口，获取声影同传或字幕任务（非纯字幕模式）的字幕 SRT 文件。

  • 声影同传任务：在调用 CreateSpeechTask 创建声影同传任务时，您必须传入 SubtitleTosConfig 参数并将 Enable 设置为 true。在同传任务的转推时间段内推流后，您可调用本接口，传入 TaskID 获取任务的字幕 SRT 文件。
  • 字幕任务（非纯字幕模式）：在调用 CreateSubtitleTranscodePreset 或 UpdateSubtitleTranscodePreset 创建或更新字幕配置时，您必须传入 SubtitleTosConfig 参数并将 Enable 设置为 true。在推流后，您可调用本接口，传入 PushDomain、AppName、StreamName 和 SuffixName 获取任务的字幕 SRT 文件。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=ListSpeechSubtitleSrt&Version=2023-01-01

调试

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListSpeechSubtitleSrt接口名称。当前 API 的名称为 ListSpeechSubtitleSrt。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

参数类型是否必选示例值描述
TaskIDString否ab5d68****257f3f目标声影同传任务 ID。您可通过调用 CreateSpeechTask 或 SearchSpeechTask 获取 ID。
PushDomainString否push.example.com目标字幕任务对应的推流域名。例如推流地址为 rtmp://push.example.com/live/test?authinfo，则推流域名为 push.example.com。
AppNameString否live目标字幕任务推流地址中的 AppName。例如推流地址为 rtmp://push.example.com/live/test?authinfo，则 AppName 为 live。
StreamNameString否test目标字幕任务推流地址中的 StreamName。例如推流地址为 rtmp://push.example.com/live/test?authinfo，则 StreamName 为 test。

SuffixName

String

否

subtitle

目标字幕任务的字幕后缀。例如字幕流地址为 rtmp://pull.example.com/live/test_subtitle，则字幕后缀为 subtitle。
您可调用 ListVhostSubtitleTranscodePreset，并通过返回参数 SuffixName 获取字幕后缀。

StartTime

String

否

2026-05-20 15:04:05.999999999 +0800 CST

查询时间范围的开始时间，例如 2026-05-20 15:04:05 +0800 CST。
其中，

  • 2026-05-20 15:04:05 表示日期和时间。时间最少精确到秒，秒后可按需追加小数部分，最多支持纳秒，例如 2026-05-20 15:04:05.999999999。
  • +0800 CST 表示 UTC+8 时区。

说明

  • StartTime 和 EndTime 的间隔不能超过 72 小时。
  • StartTime 必须早于 EndTime。

EndTime

String

否

2026-05-20 16:04:05.999999999 +0800 CST

查询时间范围的结束时间，例如 2026-05-20 16:04:05 +0800 CST。
其中，

  • 2026-05-20 16:04:05 表示日期和时间。时间最少精确到秒，秒后可按需追加小数部分，最多支持纳秒，例如 2026-05-20 16:04:05.999999999。
  • +0800 CST 表示 UTC+8 时区。

说明

  • StartTime 和 EndTime 的间隔不能超过 72 小时。
  • StartTime 必须早于 EndTime。
PageCurInteger否1分页查询页码。默认值为 1。取值大于等于 1。
PageSizeInteger否10分页查询数量。取值范围为 [1,20]，默认值为 10。

返回参数

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

参数类型示例值描述
ListArray of List-数据列表。
PaginationObject of Pagination-分页信息。

List

参数类型示例值描述
PushDomainStringpush.example.com字幕任务对应的推流域名。
AppNameStringlive字幕任务推流地址中的 AppName。
StreamNameStringtest字幕任务推流地址中的 StreamName。
SuffixNameStringsubtitle字幕任务的字幕后缀。
TaskIDStringab5d68****257f3f声影同传任务 ID。
BucketStringbucketa存储字幕 SRT 文件的 TOS 桶名称。

Region

String

cn-beijing

存储字幕 SRT 文件的 TOS 桶区域。取值如下：

  • cn-beijing：华北2（北京）
  • cn-guangzhou：华南1（广州）
  • cn-shanghai：华东2（上海）
TimeString1779270470000字幕 SRT 文件的生成时间。Unix 时间戳，单位为毫秒。
UriStringtestdir/test.push.com/l******est_en/1779106221662.srt字幕 SRT 文件在 TOS 桶的 URI。
UrlStringhttps://bkt-test.tos-s3-cn-beijing.ivolces.com/testdir/test.push.com/live/stest_en/1779106221662.srt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKTP0U******HHigOXb9i6dNobGjK2CfS7uzOoGnYjAl%2F20260520%2Fcn-beijing%2Fs3%2Faws4_request&X-Amz-Date=20260520T094238Z&X-Amz-Expires=86400&X-Amz-Security-Token=nChBu******ZS3Q3.CiQKExxxxxx&X-Amz-SignedHeaders=host&X-Amz-Signature=114a57e795******带鉴权参数的字幕 SRT 文件下载 URL，可直接用于下载字幕文件。

Pagination

参数类型示例值描述
PageCurInteger1分页查询页码。
PageSizeInteger10分页查询数量。
PageTotalInteger1查询结果总页数。
TotalCountInteger1查询结果总数。

请求示例 

POST https://live.volcengineapi.com?Action=ListSpeechSubtitleSrt&Version=2023-01-01
{
    "TaskID": "ab5d68****257f3f",
    "StartTime": "2026-05-20 15:04:05.999999999 +0800 CST",
    "EndTime": "2026-05-20 16:04:05.999999999 +0800 CST",
    "PageCur": 1,
    "PageSize": 10
}

返回示例 

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListSpeechSubtitleSrt",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "List": [
            {
                "PushDomain": "push.example.com",
                "AppName": "live",
                "StreamName": "test",
                "SuffixName": "subtitle",
                "TaskID": "ab5d68****257f3f",
                "Bucket": "bucketa",
                "Region": "cn-beijing",
                "Time": "1779270470000",
                "Uri": "testdir/test.push.com/l******est_en/1779106221662.srt",
                "Url": "https://bkt-test.tos-s3-cn-beijing.ivolces.com/testdir/test.push.com/live/stest_en/1779106221662.srt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKTP0U******HHigOXb9i6dNobGjK2CfS7uzOoGnYjAl%2F20260520%2Fcn-beijing%2Fs3%2Faws4_request&X-Amz-Date=20260520T094238Z&X-Amz-Expires=86400&X-Amz-Security-Token=nChBu******ZS3Q3.CiQKExxxxxx&X-Amz-SignedHeaders=host&X-Amz-Signature=114a57e795******"
            }
        ],
        "Pagination": {
            "PageCur": 1,
            "PageSize": 10,
            "PageTotal": 1,
            "TotalCount": 1
        }
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2026.05.20 22:32:02
这个页面对您有帮助吗？
有用
有用
无用
无用