1. 接口描述
接口请求域名： lcic.tencentcloudapi.com 。
批量获取文档详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：BatchDescribeDocument。 |
| Version | 是 | String | 公共参数，本接口取值：2022-08-17。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SdkAppId | 是 | Integer | 低代码互动课堂的SdkAppId。 示例值：123456 |
| Page | 是 | Integer | 分页查询当前页数，从1开始递增 示例值：1 |
| Limit | 是 | Integer | 每页数据量，最大200 示例值：100 |
| Permission.N | 是 | Array of Integer | 课件权限。[0]：获取owner的私有课件；[1]：获取owner的公开课件; [0,1]：则获取owner的私有课件和公开课件；[2]：获取owner的私有课件和所有人(包括owner)的公开课件 示例值：[0] |
| Owner | 否 | String | 课件所有者的user_id，不填默认获取SdkAppId下所有课件 示例值：abc123 |
| Keyword | 否 | String | 课件名称搜索词 示例值：课件1 |
| DocumentId.N | 否 | Array of String | 课件id列表，从列表中查询，忽略错误的id 示例值：doc123 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 符合查询条件文档总数 示例值：50 |
| Documents | Array of DocumentInfo | 文档信息列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
批量获取文档详情
输入示例
POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchDescribeDocument
<公共请求参数>
{
"SdkAppId": 1,
"Page": 0,
"Limit": 0,
"Permission": [
1
],
"Owner": "abc",
"Keyword": "abc",
"DocumentId": [
"abc"
]
}输出示例
{
"Response": {
"Total": 0,
"Documents": [
{
"DocumentId": "abc",
"DocumentUrl": "abc",
"DocumentName": "abc",
"Owner": "abc",
"SdkAppId": 1,
"Permission": 1,
"TranscodeResult": "abc",
"TranscodeType": 1,
"TranscodeProgress": 1,
"TranscodeState": 1,
"TranscodeInfo": "abc",
"DocumentType": "abc",
"DocumentSize": 1,
"UpdateTime": 1,
"Pages": 1,
"Width": 1,
"Height": 1,
"Cover": "abc",
"Preview": "abc",
"Resolution": "1280*720",
"MinScaleResolution": "1280*720"
}
],
"RequestId": "abc"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.SdkAppId | SdkAppId参数错误。 |