发起文档转换
更新时间不可用
发起一个文档转换任务。
https://api.netless.link/v5/services/conversion/taskstokenstringSDK Token，可以通过以下方式获取：
-
在声网控制台生成用于测试的 SDK Token，详见获取互动白板项目的安全密钥。
-
调用服务端 RESTful API， 详见生成 SDK Token。
-
在 App 服务端用代码生成，详见在 App 服务端生成 Token。
regionstring指定处理该请求的数据中心，取值如下：
-
cn-hz：中国杭州，服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。 -
us-sv：美国硅谷，服务区覆盖北美洲、南美洲。 -
sg：新加坡，服务区覆盖新加坡、东亚、东南亚。 -
in-mum：印度孟买，服务区覆盖印度。 -
eu：欧洲（法兰克福），服务区覆盖欧洲。
resourcestring待转换的源文件 URL。
typestring转换任务类型，取值如下：
-
dynamic：动态文档转换，即文档转网页。 -
static：静态文档转换，即文档转图片。
previewboolean是否需要生成预览图：
-
true：是。 -
false：否。 该参数仅在type设为dynamic时生效。
scalenumber图片缩放比例。数值越大，图片越清晰。该参数仅在 type 设为 static 时生效。
outputFormatstring输出图片格式，取值如下：
-
png：PNG 格式。 -
jpg：JPG 格式。 -
jpeg：JPEG 格式。 -
qpdf：QPDF 格式。仅 PDF 文件（以%PDF开头的文件）支持转换为 QPDF 格式。你可以使用 @netless-app-pdfjs 插件展示到基于 Fastboard SDK 的互动白板 App 中。 该参数仅在type设为static时生效。
packboolean进行静态文档转换时，是否生成资源包：
-
true：生成资源包。该参数设为true时，声网服务端会将所有转换后的图片打包成{uuid}.zip文件，并上传到你指定的存储路径中。 -
false：（默认）不生成资源包。
说明
该参数仅在 type 设为 static 时生效。当 type 设为 dynamic 时，声网服务端会自动生成 {uuid}.zip 资源包。
canvasVersionboolean进行动态文档转换时，除将源文档转换为常规的 DOM 元素外，是否额外转换为 canvas 元素：
-
true：将源文档转换为常规的 DOM 元素和canvas元素。 该选项适用于源文档包含复杂动画效果的情况，例如，切页动画。转换为canvas元素后，动画的渲染效果和性能更佳，但是转换速度会降低。 设置canvasVersion为true后，你可以使用 Whiteboard SDK，也可以使用 Fastboard SDK 渲染并展示转换后的文档。使用 Whiteboard SDK 可以读取转换结果中的 DOM 元素，并将其渲染为 DOM 网页，部分动画效果可能无法被渲染；使用 Fastboard SDK 可以读取转换结果中的canvas元素，并将其渲染为 canvas 页面，并保留完整的动画效果。 -
false：（默认）仅将源文档转换为 DOM 元素。 该选项适用于除源文档包含复杂动画效果外的几乎所有情况，且转换速度快。但是，当源文档包含复杂动画时（例如，切页动画），转换为 DOM 元素后，部分动画效果可能无法被渲染，且渲染时可能出现卡顿。 未设置canvasVersion参数或设置canvasVersion为false后，仅可以使用 Whiteboard SDK 渲染并展示转换后的文档。使用 Fastboard SDK 将无法读取转换结果。
说明
该参数仅在 type 设为 dynamic 时生效。
响应
若返回的状态码为 201 则表示请求成功。响应 Body 中包含本次请求的结果。
若返回的状态码不为 201 则表示请求失败。你可以参考响应状态码了解可能的原因。
响应 Body
uuidstring转换任务的 UUID，即转换任务的唯一标识符。
typestring转换任务类型，取值如下：
-
dynamic：动态文档转换，即文档转网页。 -
static：静态文档转换，即文档转图片。
statusstring转换任务的状态：
-
Waiting：等待转换。 -
Converting：转换中。 -
Finished：已完成。 -
Fail：失败。
请求示例
curl --request POST \
--url "https://api.netless.link/v5/services/conversion/tasks" \
--header 'token: <string>' \
--header 'region: cn-hz' \
-H 'Content-Type: application/json' \
-d '{
"resource": "https://docs-test-xx.oss-cn-hangzhou.aliyuncs.com/xxx",
"type": "static",
"preview": true,
"scale": 1,
"outputFormat": "jpg"
}'响应示例
{
"uuid": "2fd2dxxxxx367e",
"type": "static",
"status": "Waiting"
}