创建PPT检测任务

最近更新时间:2024-03-12 01:56:25

我的收藏

1. 接口描述

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

检测PPT文件,识别PPT中包含的动态转码任务(Transcode)不支持的元素

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreatePPTCheckTask。
Version String 公共参数,本接口取值:2019-09-19。
Region String 公共参数,详见产品支持的 地域列表
SdkAppId Integer 客户的SdkAppId
示例值:1400000001
Url String 经过URL编码后的PPT文件地址。URL 编码会将字符转换为可通过因特网传输的格式,例如文档地址为http://example.com/测试.pptx,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pptx。为了提高URL解析的成功率,请对URL进行编码。
示例值:http://example.com/%E6%B5%8B%E8%AF%95.pptx
AutoHandleUnsupportedElement Boolean 是否对不支持元素开启自动处理的功能,默认不开启。
true -- 开启
false -- 不开启

当设置为true时,可配合AutoHandleUnsupportedElementTypes参数使用,具体有哪些不兼容元素类型,可参考AutoHandleUnsupportedElementTypes参数的说明。
示例值:true
AutoHandleUnsupportedElementTypes.N Array of Integer 此参数仅在AutoHandleUnsupportedElement参数为true的情况下有效。

指定需要自动处理的不兼容元素类型,默认对所有不兼容的元素进行自动处理。

目前支持检测的不兼容元素类型及对应的自动处理方式如下:
0: 不支持的墨迹类型
-- 自动处理方式:移除墨迹

1: 自动翻页
-- 自动处理方式:移除自动翻页设置,并修改为单击切换

2: 已损坏音视频
-- 自动处理方式:移除对损坏音视频的引用

3: 不可访问资源
-- 自动处理方式:移除对不可访问的资源的引用

4: 只读文件
-- 自动处理方式:移除只读设置

5: 不支持的元素编辑锁定状态
-- 自动处理方式:移除锁定状态

6: 可能有兼容问题的字体
-- 自动处理方式: 不支持处理

7: 设置了柔化边缘的GIF图片
-- 自动处理方式:移除柔化边缘设置

8: 存在不兼容的空格下划线
-- 自动处理方式:通过调整空格下划线前后文本的字体语言体系,保证空格下划线表现正常

9: 存在设置了分段动画的数学公式和文本混合内容
-- 自动处理方式: 不支持处理

10: 存在设置了分段动画的渐变色文本
-- 自动处理方式: 不支持处理

11: 存在不兼容的分散对齐方式
-- 自动处理方式: 不支持处理

12: 存在不兼容的多倍行距设置
-- 自动处理方式: 不支持处理
示例值:[0, 1, 2]

3. 输出参数

参数名称 类型 描述
TaskId String 检测任务的唯一标识Id,用于查询该任务的进度以及检测结果
示例值:g6ls63ps49vteb8bk1mb
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建PPT检测任务

创建PPT检测任务,识别动态转码不支持的元素列表

输入示例

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

{
    "Url": "http://example.com/%E6%B5%8B%E8%AF%95.pptx",
    "SdkAppId": "1400000001"
}

输出示例

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "TaskId": "g6ls63ps49vteb8bk1mb"
    }
}

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.Preprocess 转码预处理失败,具体请参考错误描述或联系客服人员。
InvalidParameter.BodyParameterTypeUnmatched 参数类型不匹配。
InvalidParameter.FileFormatUnsupported 文档后缀名对应的格式不支持。
InvalidParameter.PreprocessParameter 转码预处理参数格式不正确。
InvalidParameter.SdkAppIdNotFound SdkAppId不存在或格式错误。
LimitExceeded.TaskConcurrency 转码或录制任务并发数量超过限制,请参考错误描述或稍后重试。
ResourceUnavailable.NotRegistered 未开通互动白板。
ResourceUnavailable.ServiceExpired 账户欠费或者互动白板服务已过期。
UnauthorizedOperation.SdkAppId SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。