You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

查询文档转码进度 WbTranscodeQuery

最近更新时间：2024.03.26 16:19:49

首次发布时间：2024.03.26 15:20:24

我的收藏

使用说明

接口行为

发起文档转码任务，可以通过调用 WbTranscodeQuery 查询转码任务的进度。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

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

请求说明

  • 请求方式：GET
  • 请求地址：https://rtc.volcengineapi.com?Action=WbTranscodeQuery&Version=2023-11-01

请求参数

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

Query

参数名称
数据类型
是否必选
示例值
描述
Action
String
是
WbTranscodeQuery
接口名称。当前 API 的名称为 WbTranscodeQuery。
Version
String
是
2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
AppId
String
是
600000000000000000000000
your_app_id
TaskId
String
是
0000000000
成功调用 WbTranscodeQuery后返回的任务ID

返回参数

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

参数
类型
示例值
描述
Status
String
2

转码任务状态

  • 0：未开始
  • 1：进行中
  • 2：已完成
  • 3：失败
Progress
String
100
静态转码进度。100 表示已完成。
动态转码恒定为 0。
ErrCodeN
String
0
错误码
ErrCode
String
错误信息
ErrMsg
String
错误信息

请求示例

GET https://rtc.volcengineapi.com?Action=WbTranscodeQuery&Version=2023-11-01&AppId=600000000000000000000000&TaskId=0000000000

返回示例

{
    "ResponseMetadata": {
        "RequestId": "your_request_id",
        "Service": "rtc",
        "Region": "cn-north-1",
        "Action": "WbTranscodeQuery",
        "Version": "2023-11-01"
    },
    "Result": {
        "Status": 2, // 0：未开始，1:进行中，2:已完成：3:失败
        "Progress": 100, 
        "ErrCodeN": 0,
        "ErrCode": "",
        "ErrMsg": ""
    }
}

错误码

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