飞书开放平台 Server API 文档

主题

创建草稿 ​

草稿并非词条，而是指通过 API 发起创建新词条或更新现有词条的申请。 词典管理员审核通过后，草稿将变为新的词条或覆盖已有词条。

Error: 为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至新版本>>

Warning: 以用户身份创建草稿（即 Authorization 使用 user_access_token），对应用户将收到由飞书词典 Bot 发送的审核结果；以应用身份创建草稿（即 Authorization 使用 tenant_access_toke），不会收到任何通知。

Tip: - 创建新的词条时，无需传入 entity_id 字段

  • 更新已有词条时，请传入对应词条的 entity_id 或 outer_info

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/baike/v1/drafts
HTTP MethodPOST
接口频率限制100 次/分钟
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可baike:entity 查看、创建、编辑、删除飞书词典词条 baike:entity:exempt_review 创建、更新飞书词典免审词条
字段权限要求> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头 ​

名称类型必填描述
Authorizationstring是tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Typestring是固定值："application/json; charset=utf-8"

查询参数 ​

名称类型必填描述
user_id_typestring否用户 ID 类型
示例值：open_id
可选值有：
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？
默认值：open_id
当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体 ​

名称类型必填描述
idstring否词条 ID （需要更新某个词条时填写，若是创建新词条可不填写）
示例值："enterprise_40217521"
main_keysterm\[\]是词条名
数据校验规则：
- 最大长度：1
  └ keystring是名称的值
示例值："飞书词典"
  └ display_statusdisplay_status是名称展示范围
    └ allow_highlightboolean是对应名称是否在消息/云文档高亮
示例值：true
    └ allow_searchboolean是对应名称是否在搜索结果中展示
示例值：true
aliasesterm\[\]否别名
数据校验规则：
- 最大长度：10
  └ keystring是名称的值
示例值："飞书词典"
  └ display_statusdisplay_status是名称展示范围
    └ allow_highlightboolean是对应名称是否在消息/云文档高亮
示例值：true
    └ allow_searchboolean是对应名称是否在搜索结果中展示
示例值：true
descriptionstring否纯文本格式词条释义。注：description 和 rich_text 至少有一个，否则会报错：1540001
示例值："词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通"
数据校验规则：
- 最大长度：5000 字符
related_metarelated_meta否更多相关信息
  └ usersreferer\[\]否相关联系人
    └ idstring是对应相关信息 ID
示例值："格式请看请求体示例"
    └ titlestring否对应相关信息的描述，如相关联系人的描述、相关链接的标题
示例值："飞书词典帮助中心"
  └ chatsreferer\[\]否相关服务中的相关公开群
    └ idstring是对应相关信息 ID
示例值："格式请看请求体示例"
  └ docsreferer\[\]否相关云文档
    └ titlestring否对应相关信息的描述，如相关联系人的描述、相关链接的标题
示例值："飞书词典帮助中心"
    └ urlstring否链接地址
示例值："https://www.feishu.cn/hc/zh-CN"
数据校验规则：
- 正则校验：`(https?
  └ oncallsreferer\[\]否相关服务中的相关值班号
    └ idstring是对应相关信息 ID
示例值："格式请看请求体示例"
  └ linksreferer\[\]否相关链接
    └ titlestring否对应相关信息的描述，如相关联系人的描述、相关链接的标题
示例值："飞书词典帮助中心"
    └ urlstring否链接地址
示例值："https://www.feishu.cn/hc/zh-CN"
数据校验规则：
- 正则校验：`(https?
  └ abbreviationsabbreviation\[\]否相关词条
    └ idstring否相关词条 ID
示例值："enterprise_51527260"
  └ classificationsclassification\[\]否当前词条所属分类 词条只能属于二级分类，且每个一级分类下只能选择一个二级分类。
    └ idstring是二级分类 ID
示例值："7049606926****37761"
    └ father_idstring否对应一级分类 ID
示例值："7049606926****37777"
  └ imagesbaike_image\[\]否上传的图片
数据校验规则：
- 最大长度：10
    └ tokenstring是通过文件接口上传图片后，获得的图片 token
示例值："boxbcEcmKiDia3evgqWTpvdc7jc"
outer_infoouter_info否外部系统关联数据
  └ providerstring是外部系统（不能包含中横线 "-"）
示例值："星云"
数据校验规则：
- 长度范围：2 ～ 32 字符
  └ outer_idstring是词条在外部系统中对应的唯一 ID（不能包含中横线 "-"）
示例值："client_653267498d"
数据校验规则：
- 长度范围：1 ～ 64 字符
rich_textstring否富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考飞书词典指南中的释义部分
示例值："<b>加粗</b><i>斜体</i><p><a href="https://feishu.cn">链接</a></p><p><span>词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通</span></p>"
数据校验规则：
- 最大长度：5000 字符

请求体示例 ​

json
{
    "id": "enterprise_40217521",
    "main_keys": [
        {
            "key": "飞书词典",
            "display_status": {
                "allow_highlight": true,
                "allow_search": true
            }
        }
    ],
    "aliases": [
        {
            "key": "飞书词典",
            "display_status": {
                "allow_highlight": true,
                "allow_search": true
            }
        }
    ],
    "description": "词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通",
    "related_meta": {
        "users": [
            {
                "id": "格式请看请求体示例",
                "title": "飞书词典帮助中心"
            }
        ],
        "chats": [
            {
                "id": "格式请看请求体示例"
            }
        ],
        "docs": [
            {
                "title": "飞书词典帮助中心",
                "url": "https://www.feishu.cn/hc/zh-CN"
            }
        ],
        "oncalls": [
            {
                "id": "格式请看请求体示例"
            }
        ],
        "links": [
            {
                "title": "飞书词典帮助中心",
                "url": "https://www.feishu.cn/hc/zh-CN"
            }
        ],
        "abbreviations": [
            {
                "id": "enterprise_51527260"
            }
        ],
        "classifications": [
            {
                "id": "7049606926****37761",
                "father_id": "7049606926****37777"
            }
        ],
        "images": [
            {
                "token": "boxbcEcmKiDia3evgqWTpvdc7jc"
            }
        ]
    },
    "outer_info": {
        "provider": "星云",
        "outer_id": "client_653267498d"
    },
    "rich_text": "<b>加粗</b><i>斜体</i><p><a href=\"https://feishu.cn\">链接</a></p><p><span>词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通</span></p>"
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ draftdraft草稿信息
    └ draft_idstring草稿 ID
    └ entityentity词条信息
      └ idstring词条 ID （需要更新某个词条时填写，若是创建新词条可不填写）
      └ main_keysterm\[\]词条名
        └ keystring名称的值
        └ display_statusdisplay_status名称展示范围
          └ allow_highlightboolean对应名称是否在消息/云文档高亮
          └ allow_searchboolean对应名称是否在搜索结果中展示
      └ aliasesterm\[\]别名
        └ keystring名称的值
        └ display_statusdisplay_status名称展示范围
          └ allow_highlightboolean对应名称是否在消息/云文档高亮
          └ allow_searchboolean对应名称是否在搜索结果中展示
      └ descriptionstring纯文本格式词条释义。注：description 和 rich_text 至少有一个，否则会报错：1540001
      └ creatorstring词条创建者的 user id
      └ create_timestring词条创建时间
      └ updaterstring词条最近更新者的 user id
      └ update_timestring词条最近更新时间
      └ related_metarelated_meta外部系统关联数据
        └ usersreferer\[\]外部系统（不能包含中横线 "-"）
          └ idstring数据 id
          └ titlestring标题
          └ urlstring链接地址
        └ chatsreferer\[\]词条在外部系统中对应的唯一 ID（不能包含中横线 "-"）
          └ idstring数据 id
          └ titlestring标题
          └ urlstring链接地址
        └ docsreferer\[\]关联文档信息
          └ titlestring标题
          └ urlstring链接地址
        └ oncallsreferer\[\]关联值班者信息
          └ idstring数据 id
          └ titlestring标题
          └ urlstring链接地址
        └ linksreferer\[\]关联链接信息
          └ titlestring标题
          └ urlstring链接地址
        └ abbreviationsabbreviation\[\]相关词条信息
          └ idstring相关其他词条 id
        └ classificationsclassification\[\]所属分类信息（不支持传入一级分类。词条不可同时属于同一个一级分类下的多个二级分类，一级分类下的二级分类互斥）
          └ idstring唯一分类 ID
          └ namestring分类名称
          └ father_idstring父级分类的 ID
        └ imagesbaike_image\[\]上传的相关图片
          └ tokenstring通过文件接口上传后的图片 token
      └ statisticsstatistics富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考飞书词典指南中的释义部分
        └ like_countint点赞数量
        └ dislike_countint点踩数量
      └ outer_infoouter_info外部 id 关联数据
        └ providerstring数据提供方（不能包含中横线 "-"）
        └ outer_idstring唯一标识，可用来和其他平台的内容进行绑定。需保证和百科词条唯一对应（不能包含中横线 "-"）
      └ rich_textstring富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考企业百科指南中的释义部分
      └ sourceint词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "draft": {
            "draft_id": "54*7",
            "entity": {
                "id": "enterprise_40****21",
                "main_keys": [
                    {
                        "key": "飞书词典",
                        "display_status": {
                            "allow_highlight": true,
                            "allow_search": true
                        }
                    }
                ],
                "aliases": [
                    {
                        "key": "飞书词典",
                        "display_status": {
                            "allow_highlight": true,
                            "allow_search": true
                        }
                    }
                ],
                "description": "词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通",
                "create_time": "1627540853",
                "update_time": "1627541853",
                "related_meta": {
                    "abbreviations": [
                        {
                            "id": "enterprise_44***90"
                        },
                        {
                            "id": "enterprise_70348****374354564"
                        },
                        {
                            "id": "enterprise_70365****3106796547"
                        }
                    ],
                    "chats": [
                        {
                            "id": "oc_c13831833ea****2c52befa759ea4806"
                        },
                        {
                            "id": "oc_c8161c910996****127e73b10233b295"
                        }
                    ],
                    "docs": [
                        {
                            "title": "猜你想问 / FAQs",
                            "url": "https://bytedance.feishu.cn/wiki/w*****8Lq4f9DMCDOtdcIzCUjAh"
                        },
                        {
                            "title": "快速了解飞书文档 | Introducing Feishu Docs",
                            "url": "https://bytedance.feishu.cn/docs/doccnxlVCCFjMsJE15I****jIWc"
                        }
                    ],
                    "links": [
                        {
                            "title": "飞书官网",
                            "url": "https://feishu.cn"
                        }
                    ],
                    "oncalls": [
                        {
                            "id": "702368****445548034"
                        },
                        {
                            "id": "702406378****910850"
                        }
                    ],
                    "users": [
                        {
                            "id": "ou_30b07b63089****518789914dac63d36",
                            "title": "负责人"
                        },
                        {
                            "id": "ou_b292c0d285c****4639fa4501e80c36a",
                            "title": ""
                        }
                    ],
                    "classifications": [
                        {
                            "id": "7049606926****37761",
                            "father_id": "7049606926****37777"
                        }
                    ],
                    "images": [
                        {
                            "token": "boxbcEcmKi****HvgqWTpvdc7jc"
                        }
                    ]
                },
                "statistics": {
                    "like_count": 100,
                    "dislike_count": 20
                },
                "outer_info": {
                    "provider": "星云",
                    "outer_id": "client_6539i3498d"
                },
                "rich_text": "词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通"
            }
        }
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
4001540001invalid param参数错误，参考文档检查输入参数
5001540002network anomaly, please try again多数请求是服务超时，请重新请求，少数是服务异常请咨询客服

内容来源：飞书开放平台 · 自动爬取整理

本镜像仅供学习与查阅，文档版权归飞书所有