使用说明

接口行为

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

调用接口

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

注意事项

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

请求说明

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

请求参数

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

Query

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

返回参数

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

参数	类型	示例值	描述
file_name	String	`cs.pptx`	转码文件名
file_id	String	`6fdf4372f87fd90e63cc705eca7338`	动态转码结果 file_id，使用动态转码结果时在 SDK 接口传入
width	Integer	`1920`	转码后的页面宽度，单位为像素
height	Integer	`1080`	转码后的页面高度，单位为像素
transcode_mode	Integer	`0`	转码类型 `0`: 静态转码 `1`: 动态转码
images	Array of Images		静态转码图片详情

Images

参数	类型	示例值	描述
page_id	Integer	`2`	页码 ID
img	String	`https://result2.com`	转码图片 URL
thumbnail_url	String	`https://result2_thm.com`	缩略图 URL

请求示例

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

返回示例

{
    "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": ""
    }
}
json

错误码

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