DescribeTranscodeStatus

POST

https://docs-api.zego.im/

注意

本文档 API 接口均为最新服务端 API v2 接口，后续相关功能的新增都会在此更新。为了给开发者带来更好的体验，ZEGO 推荐开发者使用最新 API v2 接口。
文件转码旧版 API 仅供 2021-09-10 前接入的旧用户维护使用。旧版接口文档请参考旧版服务端 API。

描述

通过本接口查询文件转码任务状态。

说明

调用频率限制：10 次/秒。

Request

Query Parameters

Action string必填

可选值: [DescribeTranscodeStatus]

接口原型参数

https://docs-api.zego.im/?Action=DescribeTranscodeStatus

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

TaskId string必填

文件转码任务 ID。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code int64

错误码。

以下仅列出了接口业务相关的返回码，公共返回码请参考公共返回码。

返回码	说明
60013	文件已经完成转码。
60014	不存在的文件转码任务 ID。
60015	不支持的源文件类型。

Message string

错误描述。

RequestId string

请求 ID。

Data object

响应对象。

FileHash string

源文件哈希。

FileType int64

源文件类型参数，可设置为 1、2、4、8、16、32，各参数值说明如下：

1：ppt/pptx（静态文件，目标文件类型对应 256；动态文件，目标文件类型对应 512）
2：doc/docx（目标文件类型对应 256）
4：xls/xlsx（目标文件类型对应 256）
8：PDF（目标文件类型对应 256）
16：jpg/jpeg/png/bmp（目标文件类型对应 16）
32：txt（目标文件类型对应 256）

DestinationFileType int64

目标文件类型参数，可设置为 16、256、512，各参数值说明如下：

16：jpg/jpeg/png/bmp
256：向量和图片
512：动态 PPT

FileName string

源文件名称。

FileSize int64

源文件大小，单位为字节。

Status int64

文件转码状态，详情请参考 status 字段说明表。

Status 字段取值说明如下

状态码	描述
1	未上传。
2	已上传。
4	排队中。
8	转码中。
16	转码成功。
32	转码失败。
64	转码任务已取消。
128	受密码保护的文档。
256	文件内容过大，例如文档页数过多。
512	Excel 文件标签数过多。
1024	文件内容为空。例如：PPT 内无幻灯片。
2048	转码服务器打开文件失败。
4096	不支持的目标文件类型。
8192	源文件为只读文件。
16384	转码服务器下载源文件失败。可能的原因如下：无法从请求参数中的源文件 URL 下载文件。请求参数中的文件哈希值不是 32 位的 MD5 哈希值。请求参数中的文件哈希值和根据文件计算的哈希值不匹配。
32768	检测到源文件中包含了转码工具无法处理的元素，如墨迹涂鸦等，请去掉这些元素后再进行转码。
32769	检测到 Word、Excel 和 PowerPoint 文件格式不合法，请确保源文件可以使用 Office 打开再进行转码。
32770	要转码的文件存在安全隐患，无法正常打开转码。请确保使用 Office 打开文件时不会提示编辑此文件可能会损害您的计算机
32771	动态 PPT 转码结束后，检测到有图片、音视频文件未正常导出，转码服务器将重试转码。
32772	文件大小过大，无法转码，请确保文件大小在限制的范围之内。
32773	打开文件时弹需要修复文件提示框（文件损坏）。
32774	EOF 错误（文件内容不完整）。

FileId string

转码成功后返回的文件 ID。

{
  "Code": 0,
  "Message": "succeed",
  "RequestId": "abcd123",
  "Data": {
    "FileHash": "abc",
    "FileType": 1,
    "DestinationFileType": 256,
    "FileName": "demo.pptx",
    "FileSize": 1024,
    "Status": 8,
    "FileId": "fiaaaa"
  }
}

{
  "Code": 0,
  "Message": "succeed",
  "RequestId": "abcd123",
  "Data": {
    "FileHash": "abc",
    "FileType": 1,
    "DestinationFileType": 256,
    "FileName": "demo.pptx",
    "FileSize": 1024,
    "Status": 8,
    "FileId": "fiaaaa"
  }
}