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

获取转码输出链接 WbTranscodeGet

最近更新时间：2024.02.20 20:26:11

首次发布时间：2024.02.20 17:26:09

我的收藏

使用说明

接口行为

文档转码任务完成后，你可以通过 WbTranscodeGet 获取文档转码后的链接。

调用接口

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

注意事项

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

请求说明

  • 请求方式：GET
  • 请求地址：https://rtc.volcengineapi.com?Action=WbTranscodeGet&Version=2020-12-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是WbTranscodeGet接口名称。当前 API 的名称为 WbTranscodeGet。
VersionString是2020-12-01接口版本。当前 API 的版本为 2020-12-01。
app_idString是600000000000000000000000应用的唯一标志。你可以通过控制台查看和复制你的 app_id。或通过调用 ListApps 接口获取。
task_idString是0000000000成功调用 WbTranscodeQuery后返回的任务ID

返回参数

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

参数类型示例值描述
file_nameStringcs.pptx转码文件名
file_idString6fdf4372f87fd90e63cc705eca7338动态转码结果 file_id，使用动态转码结果时在 SDK 接口传入
widthInteger1920转码后的页面宽度，单位为像素
heightInteger1080转码后的页面高度，单位为像素

transcode_mode

Integer

0

转码类型

  • 0: 静态转码
  • 1: 动态转码
imagesArray of Images静态转码图片详情

Images

参数类型示例值描述
page_idInteger2页码 ID
imgStringhttps://result2.com转码图片 URL
thumbnail_urlStringhttps://result2_thm.com缩略图 URL

请求示例

GET https://rtc.volcengineapi.com?Action=WbTranscodeGet&Version=2020-12-01&app_id=600000000000000000000000&task_id=0000000000

返回示例

{
    "ResponseMetadata": {
        "RequestId": "your_request_id",
        "Service": "rtc",
        "Region": "cn-north-1",
        "Action": "WbTranscodeGet",
        "Version": "2020-12-01"
    },
    "Result": {
        "file_name": "cs.pptx",
        "width": 1920,
        "height": 1080,
        "transcode_mode": 0,
        "images": [
            {
                "page_id": 1,
                "img": "https://result1.com",
                "thumbnail_url": "https://result1_thm.com"
            },
            {
                "page_id": 2,
                "img": "https://result2.com",
                "thumbnail_url": "https://result2_thm.com"
            }
        ],
        "h5_url": ""
    }
}

错误码

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