获取词条详情

通过词条 id 拉取对应的词条详情信息。

Tip: 也支持通过 provider 和 outer_id 返回对应实体的详情数据。此时路径中的 entity_id 为固定的 enterprise_0

请求

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

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
entity_id	string	词条 ID 示例值："enterprise_515879"

查询参数

名称	类型	必填	描述
provider	string	否	外部系统 示例值：星云 数据校验规则： - 长度范围：2 ～ 32 字符
outer_id	string	否	词条在外部系统中对应的唯一 ID 示例值：123aaa 数据校验规则： - 长度范围：1 ～ 64 字符
user_id_type	string	否	用户 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

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ entity	entity	词条
└ id	string	词条 ID （需要更新某个词条时填写，若是创建新词条可不填写）
└ main_keys	term\[\]	词条名
└ key	string	名称
└ display_status	display_status	展示状态
└ allow_highlight	boolean	是否允许在 IM 和 Doc 等场景进行高亮提示
└ allow_search	boolean	是否允许在飞书中被搜索到
└ aliases	term\[\]	别名
└ key	string	名称
└ display_status	display_status	展示状态
└ allow_highlight	boolean	是否允许在 IM 和 Doc 等场景进行高亮提示
└ allow_search	boolean	对应名称是否在搜索结果中展示
└ description	string	纯文本格式词条释义。注：description 和 rich_text 至少有一个，否则会报错：1540001
└ creator	string	创建者
└ create_time	string	词条创建时间（秒级时间戳）
└ updater	string	最近一次更新者
└ update_time	string	最近一次更新词条时间（秒级时间戳）
└ related_meta	related_meta	更多相关信息
└ users	referer\[\]	相关联系人
└ id	string	对应相关信息 ID
└ title	string	对应相关信息的描述，如相关联系人的描述、相关链接的标题
└ url	string	链接地址
└ chats	referer\[\]	相关服务中的相关公开群
└ id	string	对应相关信息 ID
└ title	string	对应相关信息的描述，如相关联系人的描述、相关链接的标题
└ url	string	链接地址
└ docs	referer\[\]	相关云文档
└ title	string	对应相关信息的描述，如相关联系人的描述、相关链接的标题
└ url	string	链接地址
└ oncalls	referer\[\]	相关服务中的相关值班号
└ id	string	对应相关信息 ID
└ title	string	对应相关信息的描述，如相关联系人的描述、相关链接的标题
└ url	string	链接地址
└ links	referer\[\]	相关链接
└ title	string	对应相关信息的描述，如相关联系人的描述、相关链接的标题
└ url	string	链接地址
└ abbreviations	abbreviation\[\]	相关词条
└ id	string	相关词条 ID
└ classifications	classification\[\]	当前词条所属分类 词条只能属于二级分类，且每个一级分类下只能选择一个二级分类。
└ id	string	二级分类 ID
└ father_id	string	父级分类的 ID
└ images	baike_image\[\]	上传的图片
└ token	string	通过文件接口上通过文件接口上传图片后，获得的图片 token后的图片 token
└ statistics	statistics	当前词条收到的反馈数据
└ like_count	int	累计点赞
└ dislike_count	int	当前词条版本收到的负反馈数量
└ outer_info	outer_info	外部系统关联数据
└ provider	string	外部系统（不能包含中横线 "-"）
└ outer_id	string	词条在外部系统中对应的唯一 ID（不能包含中横线 "-"）
└ rich_text	string	富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考飞书词典指南中的释义部分
└ source	int	词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建
└ i18n_descs	i18n_entry_desc\[\]	国际化的词条释义
└ language	int	语言类型 可选值有： - 1: 中文 - 2: 英文 - 3: 日文
└ description	string	纯文本释义
└ rich_text	string	富文本描述

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "entity": {
            "id": "enterprise_402***21",
            "main_keys": [
                {
                    "key": "飞书词典",
                    "display_status": {
                        "allow_highlight": true,
                        "allow_search": true
                    }
                }
            ],
            "aliases": [
                {
                    "key": "词典",
                    "display_status": {
                        "allow_highlight": true,
                        "allow_search": true
                    }
                }
            ],
            "description": "词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通",
            "rich_text": "词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通",
            "i18n_descs": [
                {
                    "language": 1,
                    "description": "国际化中文释义",
                    "rich_text": "国际化中文释义"
                }
            ],
            "related_meta": {
                "users": [
                    {
                        "id": "ou_30b07b63089e***18789914dac63d36",
                        "title": "负责人"
                    },
                    {
                        "id": "ou_b292c0d285c1***639fa4501e80c36a",
                        "title": ""
                    }
                ],
                "chats": [
                    {
                        "id": "oc_c13831833eaa8c92***cfa759ea4806"
                    },
                    {
                        "id": "oc_c8161c9109966a24***e73b10233b295"
                    }
                ],
                "docs": [
                    {
                        "title": "猜你想问 / FAQs",
                        "url": "https://example.feishu.cn/wiki/wikcnZ8Lq4***CDOtdcIzCUjAh"
                    },
                    {
                        "title": "快速了解飞书文档 | Introducing Feishu Docs",
                        "url": "https://example.feishu.cn/docs/doccnxlVCs***sJE15I7PLAjIWc"
                    }
                ],
                "links": [
                    {
                        "title": "飞书官网",
                        "url": "https://feishu.cn"
                    }
                ],
                "oncalls": [
                    {
                        "id": "70236890***45548034"
                    },
                    {
                        "id": "70240637***60910850"
                    }
                ],
                "abbreviations": [
                    {
                        "id": "enterprise_4450***890"
                    },
                    {
                        "id": "enterprise_703481***74354564"
                    },
                    {
                        "id": "enterprise_703659***06796547"
                    }
                ],
                "classifications": [
                    {
                        "id": "70496069***2837761",
                        "father_id": "70496069***02837777"
                    }
                ],
                "images": [
                    {
                        "token": "boxbcEcmKiD***vgqWTpvdc7jc"
                    }
                ]
            },
            "statistics": {
                "like_count": 100,
                "dislike_count": 20
            },
            "outer_info": {
                "provider": "星云",
                "outer_id": "client_6539***498d"
            },
            "create_time": "1627540853",
            "update_time": "1627541853"
        }
    }
}

错误码

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