1. 接口描述
接口请求域名： lke.tencentcloudapi.com 。
获取文档预览信息
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetDocPreview。 |
| Version | 是 | String | 公共参数，本接口取值：2023-11-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DocBizId | 是 | String | 文档BizID |
| BotBizId | 是 | String | 应用ID |
| TypeKey | 否 | String | 存储类型: offline:离线文件，realtime:实时文件；为空默认为offline 示例值：offline |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FileName | String | 文件名, 发布端固定使用这个名称 |
| FileType | String | 文件类型 |
| CosUrl | String | cos路径 |
| Url | String | cos临时地址 |
| Bucket | String | cos桶 |
| NewName | String | 存在文档重命名情况下的新名称, 评测端优先使用这个名称 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取文档预览相关信息
输入示例
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetDocPreview
<公共请求参数>
{
"DocBizId": "1681597542412103680",
"BotBizId": "1735129619995951104"
}输出示例
{
"Response": {
"FileName": "26种病虫害防治方法.docx",
"FileType": "docx",
"CosUrl": "/corp/1681586131361275904/1681597542412103680/doc/E0dQM9X41QmyAWiTQMkC-7807575532.docx",
"Url": "https://qi***an-q**t-12***16161.cos.ap-guangzhou.myqcloud.com/%2Fcorp/1737374492379124992/17986106392328008704/doc/pXaeDgJsQEEDjryWEKwU-1806238910230430080.md",
"Bucket": "",
"RequestId": "7814bdbe-da7e-401e-95c4-3e861d5298ee",
"NewName": ""
}
}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 | 操作失败。 |
