# 查询转换任务进度 (/zh-CN/api-reference/api-ref/whiteboard/restful/get-file-conversion-task)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

查询七天内创建的文档转换任务的进度。

- OpenAPI: /openapi/whiteboard/restful-wb.zh-CN.yaml
- Operation ID: get-v5-projector-tasks-uuid
- Method: GET
- Path: /v5/projector/tasks/{uuid}
- Endpoint: https://api.netless.link/v5/projector/tasks/{uuid}

## Servers

- https://api.netless.link

:::warning[注意]
调用文档转换 API 前，请确保：

- 已在[声网控制台](https://console.shengwang.cn/)开启**文档转图片**或**文档转网页**服务并添加存储配置。详见[开启互动白板配套服务](/zh-CN/realtime-media/whiteboard/fastboard-sdk/build/setup-and-access/enable-service#开启互动白板配套服务)。

- 已为待转换的文档生成一个公网可访问的 URL 地址。
:::

## Parameters

- `token` (header, required, string) - Task Token，可通过以下方式获取：

- 调用服务端 RESTful API， 详见[生成 Task Token](generate-task-token)。

- 在 app 服务端用代码生成，详见[在 App 服务端生成 Token](/zh-CN/realtime-media/whiteboard/fastboard-sdk/build/setup-and-access/generate-token#在-app-服务端生成-token)。
- `region` (header, required, string) - 指定处理该请求的数据中心，取值如下：

- `cn-hz`：中国杭州，服务区覆盖中国大陆地区及其他数据中心未覆盖的区域。

- `us-sv`：美国硅谷，服务区覆盖北美洲、南美洲。

- `sg`：新加坡，服务区覆盖新加坡、东亚、东南亚。

- `in-mum`：印度孟买，服务区覆盖印度。

- `eu`：欧洲（法兰克福），服务区覆盖欧洲。
  - Allowed: `cn-hz` | `us-sv` | `sg` | `in-mum` | `eu`
- `uuid` (path, required, string) - 转换任务的 UUID，即转换任务的唯一标识符，可通过调用[发起文档转换 API](start-file-conversion) 获取。

## Request body

No request body.

## Responses

### 200

若返回的状态码为 `200` 则表示请求成功。响应 Body 中包含本次请求的结果。

若返回的状态码不为 `200` 则表示请求失败。你可以参考[响应状态码](/zh-CN/realtime-media/whiteboard/fastboard-sdk/reference/response-code)了解可能的原因。

- `uuid` (string) - 转换任务的 UUID，即转换任务的唯一标识符。
- `status` (string) - 转换任务的状态：

- `Waiting`：等待转换。

- `Converting`：转换中。

- `Finished`：已完成。

- `Fail`：失败。
- `type` (string) - 转换任务类型，取值如下：

- `dynamic`：动态文档转换，即文档转网页。

- `static`：静态文档转换，即文档转图片。
  - Default: `dynamic`
- `convertedPercentage` (number) - 转换进度百分比。
- `prefix` (string) - 转换结果文件地址前缀路径。
- `pageCount` (number) - 文档页数，转换任务失败时没有该字段。
- `previews` (object) - 转换后的文档预览图地址，每页对应一个预览图地址。该参数仅在[发起文档转换](start-file-conversion)时，请求 Body 中的 `preview` 设为 `true `，且 `type` 设为 `dynamic` 时才生效。
  - `previews.id` (string)
- `note` (string) - 从文档中提取出的备注内容，只包含有备注的页面。
- `images` (object) - 文档转图片结果的地址，每页对应一张图片。该参数仅在该参数仅在[发起文档转换](start-file-conversion)时，请求 Body 中的 `type` 设为 `static` 时才生效。
  - `images.id` (string)
- `errorCode` (string) - 错误码。仅在转换任务失败时，才会返回该字段。所有可能的错误码详见[文档转换错误码](/zh-CN/realtime-media/whiteboard/fastboard-sdk/reference/response-code)。
- `errorMessage` (string) - 错误码对应的错误消息，描述出错的原因。仅在转换任务失败时，才会返回该字段。
- `zip` (string) - 该链接可下载一个包含 ppt 的转换结果全部集合的压缩包，其中包括 PPT 预览图和渲染需要的所有资源，可配合 SDK 提供的 API 重定向到本地资源，实现全部预加载，而不是每次加载 PPT 资源时向服务器请求，从而减少用户查看 PPT 和切页时的等待时间。
- `resources` (array) - 所有渲染所需资源的下载链接列表，可用于私有云存储做批量链接签名，以便安全地分享或访问这些资源。
  - `resources.items` (string)

## Response examples

### 200

```json
{
  "uuid": "dc11fe9e1xxxxxx7cd7ca3670a",
  "type": "dynamic",
  "status": "Finished",
  "convertedPercentage": 100,
  "pageCount": 2,
  "previews": {
    "1": "https://xxx/flat/dynamicConvert/xxx/1.png",
    "2": "https://xxx/flat/dynamicConvertxxx/2.png"
  },
  "note": "https://xxx/jsonOutput/note.json",
  "prefix": "https://xxx/flat/dynamicConvert",
  "zip": "https://xxx.com/flat/dynamicConvert/xxx.zip",
  "resources": [
    "https://xxx/jsonOutput/note.json",
    "https://xxx/flat/dynamicConvert/xxx/1.png",
    "https://xxx/flat/dynamicConvert/xxx/2.png"
  ]
}
```