有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: tiw.tencentcloudapi.com 。

查询PPT检测任务的执行进度或结果,支持查询最近半年内的任务结果

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePPTCheck。
Version String 公共参数,本接口取值:2019-09-19。
Region String 公共参数,详见产品支持的 地域列表
SdkAppId Integer 客户的SdkAppId
示例值:1400000001
TaskId String 任务的唯一标识Id
示例值:g0jb42ps49vtebjshilb

3. 输出参数

参数名称 类型 描述
TaskId String 任务的唯一标识Id
示例值:0agdnligqtgtvkm65emb
IsOK Boolean PPT文件是否正常
示例值:false
ResultUrl String 修复后的PPT URL,只有创建任务时参数AutoHandleUnsupportedElement=true,才返回此参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://xxx/xxx/测试_fixed.ppt
Slides Array of PPTErrSlide 错误PPT页面列表
注意:此字段可能返回 null,表示取不到有效值。
Status String 任务的当前状态 - QUEUED: 正在排队等待 - PROCESSING: 执行中 - FINISHED: 执行完成
示例值:FINISHED
Progress Integer 当前进度,取值范围为0~100
示例值:100
Errs Array of PPTErr 错误列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询PPT检测任务异常

查询PPT检测任务,存在异常

输入示例

POST / HTTP/1.1
Host: tiw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePPTCheck
<公共请求参数>

{
    "TaskId": "g0jb42ps49vtebjshilb",
    "SdkAppId": "1400000001"
}

输出示例

{
    "Response": {
        "TaskId": "bj0mt2l23osdj300hl30",
        "IsOK": false,
        "Status": "FINISHED",
        "Progress": 100,
        "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "ResultUrl": "https://xxx/xxx/测试_fixed.ppt",
        "Slides": [
            {
                "Page": "幻灯片5",
                "Errs": [
                    {
                        "Name": "Ink 1",
                        "Type": 0,
                        "Detail": "wps墨迹"
                    }
                ]
            }
        ],
        "Errs": [
            {
                "Type": 0,
                "Detail": "wps墨迹"
            }
        ]
    }
}

示例2 查询PPT检测任务无异常

查询PPT检测任务,PPT无异常

输入示例

POST / HTTP/1.1
Host: tiw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePPTCheck
<公共请求参数>

{
    "TaskId": "g0jb42ps49vtebjshilb",
    "SdkAppId": "1400000001"
}

输出示例

{
    "Response": {
        "TaskId": "bj0mt2l23osdj300hl30",
        "IsOK": true,
        "Status": "FINISHED",
        "Progress": 100,
        "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "ResultUrl": null,
        "Slides": null,
        "Errs": null
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation.FileDownloadFail 文档下载失败,请检查请求参数中URL是否正确,或者如果您使用其他的文件存储服务,请检查文件存储服务的上传带宽,文档转码服务仅提供1分钟的下载时间,如果下载不成功本次的转码请求将以失败终止。
FailedOperation.FileFormatError 文档格式错误,不支持转换只读文档或者已加密的文档。
FailedOperation.FileOpenFail 文档打开失败,请检查提交转码的文档是否加密或有其他格式问题。
FailedOperation.FileUploadFail 转码后上传结果失败,请稍后重试。
FailedOperation.Preprocess 转码预处理失败,具体请参考错误描述或联系客服人员。
FailedOperation.PreprocessServerError 预处理服务出现内部错误,请稍后重试或联系客户人员。
InvalidParameter.BodyParameterTypeUnmatched 参数类型不匹配。
InvalidParameter.FileFormatUnsupported 文档后缀名对应的格式不支持。
InvalidParameter.PreprocessParameter 转码预处理参数格式不正确。
InvalidParameter.TaskNotFound 需要查询的任务不存在。
InvalidParameter.UrlFormatError 文档下载Url格式错误,请检查请求参数里的Url。
ResourceUnavailable.NotRegistered 未开通互动白板。
ResourceUnavailable.ServiceExpired 账户欠费或者互动白板服务已过期。
UnauthorizedOperation.SdkAppId SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。