修改文档

最近更新时间:2024-06-21 01:56:39

我的收藏

1. 接口描述

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

修改文档

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyDoc。
Version String 公共参数,本接口取值:2023-11-30。
Region String 公共参数,详见产品支持的 地域列表
BotBizId String 应用ID
DocBizId String 文档ID
IsRefer Boolean 是否引用链接
AttrRange Integer 属性标签适用范围 1:全部,2:按条件
LoginUin String 登录用户主账号(集成商模式必填)
示例值:6000005624511
LoginSubAccountUin String 登录用户子账号(集成商模式必填)
示例值:6000005624511
AttrLabels.N Array of AttrLabelRefer 适用范围,关联的属性标签
WebUrl String 网页(或自定义链接)地址
ReferUrlType Integer 外部引用链接类型 0:系统链接 1:自定义链接
值为1时,WebUrl 字段不能为空,否则不生效。
ExpireStart String 有效开始时间,unix时间戳
ExpireEnd String 有效结束时间,unix时间戳,0代表永久有效

3. 输出参数

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

4. 示例

示例1 修改文档

修改文档

输入示例

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

{
    "BotBizId": "1696822786072117248",
    "DocBizId": "1697208584570261504",
    "IsRefer": true,
    "AttrRange": 1,
    "WebUrl": "",
    "ReferUrlType": 0
}

输出示例

{
    "Response": {
        "RequestId": "780fda73-174d-4f81-9dce-80038117fe87"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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