You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/互动白板/Open API 参考/文档转码/获取转码输出链接 WbTranscodeGet
获取转码输出链接 WbTranscodeGet
最近更新时间：2024.07.11 19:05:15首次发布时间：2024.03.26 15:20:24
我的收藏
有用
有用
无用
无用

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

注意事项

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

请求说明

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

调试

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

请求参数

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

Query

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

返回参数

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

参数
类型
示例值
描述
TranscodeMode
Integer
0

转码模式。

  • 0: 静态转码
  • 1: 动态转码
FileName
String
your_file.pptx
文件名
FileId
String
6fdf4372f87fd90e63cc705eca7338
动态转码结果 FileId，使用动态转码结果时在 SDK 接口传入。仅动态转码时返回。
Width
Integer
1920
转码后的页面分辨率宽度，单位为像素
Height
Integer
1080
转码后的页面分辨率高度，单位为像素
ThumbnailWidth
Integer
800
缩略图分辨率宽，单位为像素
ThumbnailHeight
Integer
600
缩略图分辨率高，单位为像素
Images
Object[]
-
静态转码图片结果，仅静态转码时返回。
PageId
Float
2
页码 ID
ImgUrl
String
https://result2.com
转码图片 URL
ThumbnailUrl
String
https://result2_thm.com
缩略图 URL
Warning
String
message
异常提示信息。如果该页异常，会转为空白图片，并在此给出提示信息

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "your_request_id",
        "Service": "rtc",
        "Region": "cn-north-1",
        "Action": "WbTranscodeGet",
        "Version": "2023-11-01"
    },
    "Result": {
        "FileName": "cs.pptx",
        "Width": 1920,
        "Height": 1080,
        "TranscodeMode": 0,
        "Images": [
            {
                "PageId": 1,
                "ImgUrl": "https://result1.com",
                "ThumbnailUrl": "https://result1_thm.com"
            },
            {
                "PageId": 2,
                "ImgUrl": "https://result2.com",
                "ThumbnailUrl": "https://result2_thm.com"
            }
        ]
    }
}

错误码

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