有奖:语音产品征文挑战赛等你来> HOT

1. 接口描述

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

文档列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListDoc。
Version String 公共参数,本接口取值:2023-11-30。
Region String 公共参数,详见产品支持的 地域列表
BotBizId String 机器人ID
PageNumber Integer 页码
PageSize Integer 每页数量
Query String 查询内容
Status.N Array of Integer 文档状态: 7 审核中、8 审核失败、10 待发布、11 发布中、12 已发布、13 学习中、14 学习失败 20 已过期

3. 输出参数

参数名称 类型 描述
Total String 文档数量
List Array of ListDocItem 文档列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 文档列表

输入示例

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

{
    "BotBizId": "1727231073371148288",
    "PageNumber": 1,
    "PageSize": 10
}

输出示例

{
    "Response": {
        "List": [
            {
                "AttrLabels": [],
                "AttrRange": 1,
                "CosUrl": "/corp/137/doc/jkadslfjalkdfjaklsdfla.docx",
                "DocBizId": "1729099536210460672",
                "DocCharSize": "5",
                "FileName": "jkadslfjalkdfjaklsdfla.docx",
                "FileType": "docx",
                "IsAllowDelete": true,
                "IsAllowEdit": true,
                "IsAllowRefer": true,
                "IsAllowRestart": true,
                "IsCreatedQa": true,
                "IsCreatingQa": false,
                "IsDeleted": false,
                "IsDeletedQa": false,
                "IsRefer": false,
                "QaNum": 2,
                "Reason": "生成问答成功",
                "Source": 1,
                "SourceDesc": "网页导入",
                "Status": 12,
                "StatusDesc": "已发布",
                "WebUrl": "",
                "ReferUrlType": 0,
                "UpdateTime": "1701425246"
            }
        ],
        "RequestId": "5526c65b-308d-4e84-b6b3-6b21d5c106b2",
        "Total": "1"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码