1. 接口描述
接口请求域名： lcic.tencentcloudapi.com 。
创建房间内可以使用的文档。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDocument。 |
| Version | 是 | String | 公共参数，本接口取值：2022-08-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SdkAppId | 是 | Integer | 低代码互动课堂的SdkAppId。 示例值：36718212 |
| DocumentUrl | 是 | String | 文档地址。 示例值：https://www.baidu.com |
| DocumentName | 是 | String | 文档名称。 示例值：课程文档 |
| Owner | 是 | String | 文档所有者的Id 示例值：Tom |
| TranscodeType | 否 | Integer | 转码类型，可以有如下取值： 0 无需转码（默认），bmp，jpg，jpeg，png，gif 1 需要转码的文档，ppt，pptx，pdf，doc，docx，xls，xlsx 2 需要转码的视频，mp4，3pg，mpeg，avi，flv，wmv，rm，h264等 2 需要转码的音频，mp3，wav，wma，aac，flac，opus 请注意，待录制的页面中任何视频的分辨率不能超过页面录制最大分辨率（1920*1080），否则将导致录制失败。 - ppt课件内嵌视频或纯视频课件，在上传课件时，云api会进行转码，以确保视频分辨率不超过页面录制最大分辨率。 - h5课件中内嵌音视频内容时，由于平台无法获取视频内容，因此在制作环节需确保视频分辨率不超过页面录制最大分辨率。 示例值：1 |
| Permission | 否 | Integer | 权限，可以有如下取值： 0 私有文档（默认） 1 公共文档 示例值：1 |
| DocumentType | 否 | String | 文档后缀名。 示例值：doc |
| DocumentSize | 否 | Integer | 文档大小，单位 字节 示例值：486 |
| AutoHandleUnsupportedElement | 否 | Boolean | 是否对不支持元素开启自动处理的功能。默认关闭。 自动处理的元素如下： 1. 墨迹：移除不支持的墨迹（例如WPS墨迹） 2. 自动翻页：移除PPT上所有自动翻页设置，并设置为单击鼠标翻页 3. 已损坏音视频：移除PPT上对损坏音视频的引用 示例值：false |
| MinScaleResolution | 否 | String | 转码后文档的最小分辨率，不传、传空字符串或分辨率格式错误则使用文档原分辨率。该参数仅对TranscodeType=1的课件生效。示例：1280x720，注意分辨率宽高中间为英文字母"xyz"的"x" 示例值：1280x720 示例值：1280x720 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DocumentId | String | 文档ID。 示例值：klopq |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建文档
输入示例
POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDocument
<公共请求参数>
{
"SdkAppId": 329013,
"DocumentUrl": "http://4323ba94-27a5bca82d6b.doc",
"DocumentName": "课堂文档",
"Owner": "Tom",
"TranscodeType": 1,
"Permission": 1,
"DocumentType": "doc",
"DocumentSize": 1,
"AutoHandleUnsupportedElement": true
}输出示例
{
"Response": {
"DocumentId": "wuplop",
"RequestId": "bb9c8d-4236-419b-8c39-572234jifsns7"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.RequestTimedOut | 请求超时 |
| InternalError | 内部错误。 |
| InvalidParameter.SdkAppId | SdkAppId参数错误。 |
| ResourceNotFound.User | 用户不存在。 |
