创建免审词条
通过此接口创建的词条,无需经过词典管理员审核,直接写入词库。因此,调用此接口时,应当慎重操作。
Error: 为了更好地提升接口文档的的易理解性,我们对文档进行了升级,请尽快迁移至新版本>>
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/baike/v1/entities |
| HTTP Method | POST |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | baike:entity:exempt_review 创建、更新词典免审词条 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
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 |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
main_keys | term\[\] | 是 | 词条名 数据校验规则: - 最大长度: 1 |
└ key | string | 是 | 名称的值 示例值:"飞书词典" |
└ display_status | display_status | 是 | 名称展示范围 |
└ allow_highlight | boolean | 是 | 对应名称是否在消息/云文档高亮 示例值:true |
└ allow_search | boolean | 是 | 对应名称是否在搜索结果中展示 示例值:true |
aliases | term\[\] | 否 | 别名 数据校验规则: - 最大长度: 10 |
└ key | string | 是 | 名称的值 示例值:"飞书词典" |
└ display_status | display_status | 是 | 名称展示范围 |
└ allow_highlight | boolean | 是 | 对应名称是否在消息/云文档高亮 示例值:true |
└ allow_search | boolean | 是 | 对应名称是否在搜索结果中展示 示例值:true |
description | string | 否 | 纯文本格式词条释义。注:description 和 rich_text 至少有一个,否则会报错:1540001 示例值:"词典是飞书提供的一款知识管理工具,通过飞书词典可以帮助企业将分散的知识信息进行聚合,并通过UGC的方式,促进企业知识的保鲜和流通" 数据校验规则: - 最大长度: 5000 字符 |
related_meta | related_meta | 否 | 更多相关信息 |
└ users | referer\[\] | 否 | 相关联系人 |
└ id | string | 是 | 对应相关信息 ID 示例值:"格式请看请求体示例" |
└ title | string | 否 | 对应相关信息的描述,如相关联系人的描述、相关链接的标题 示例值:"飞书词典帮助中心" |
└ chats | referer\[\] | 否 | 相关服务中的相关公开群 |
└ id | string | 是 | 对应相关信息 ID 示例值:"格式请看请求体示例" |
└ docs | referer\[\] | 否 | 相关云文档 |
└ title | string | 否 | 对应相关信息的描述,如相关联系人的描述、相关链接的标题 示例值:"飞书词典帮助中心" |
└ url | string | 否 | 链接地址 示例值:"https://www.feishu.cn/hc/zh-CN" 数据校验规则: - 正则校验:`(https? |
└ oncalls | referer\[\] | 否 | 相关服务中的相关值班号 |
└ id | string | 是 | 对应相关信息 ID 示例值:"格式请看请求体示例" |
└ links | referer\[\] | 否 | 相关链接 |
└ title | string | 否 | 对应相关信息的描述,如相关联系人的描述、相关链接的标题 示例值:"飞书词典帮助中心" |
└ url | string | 否 | 链接地址 示例值:"https://www.feishu.cn/hc/zh-CN" 数据校验规则: - 正则校验:`(https? |
└ abbreviations | abbreviation\[\] | 否 | 相关词条 |
└ id | string | 否 | 相关词条 ID 示例值:"enterprise_51527260" |
└ classifications | classification\[\] | 否 | 当前词条所属分类 词条只能属于二级分类,且每个一级分类下只能选择一个二级分类。 |
└ id | string | 是 | 二级分类 ID 示例值:"7049606926****37761" |
└ father_id | string | 否 | 对应一级分类 ID 示例值:"7049606926****37777" |
└ images | baike_image\[\] | 否 | 上传的图片 数据校验规则: - 最大长度: 10 |
└ token | string | 是 | 通过文件接口上传图片后,获得的图片 token 示例值:"boxbcEcmKiDia3evgqWTpvdc7jc" |
outer_info | outer_info | 否 | 外部系统关联数据 |
└ provider | string | 是 | 外部系统(不能包含中横线 "-") 示例值:"星云" 数据校验规则: - 长度范围: 2 ~ 32 字符 |
└ outer_id | string | 是 | 词条在外部系统中对应的唯一 ID(不能包含中横线 "-") 示例值:"client_653267498d" 数据校验规则: - 长度范围: 1 ~ 64 字符 |
rich_text | string | 否 | 富文本格式(当填写富文本内容时,description字段将会失效可不填写),支持的格式参考飞书词典指南中的释义部分 注意:富文本格式至少需要包含一个 `` 标签,否则请求会报错。 示例值:"<b>加粗</b><i>斜体</i><p><a href="https://feishu.cn">链接</a></p><p><span>词典是飞书提供的一款知识管理工具,通过飞书词典可以帮助企业将分散的知识信息进行聚合,并通过UGC的方式,促进企业知识的保鲜和流通</span></p>" 数据校验规则: - 最大长度: 5000 字符 |
请求体示例
json
{
"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": {
"abbreviations": [
{
"id": "enterprise_44***90"
},
{
"id": "enterprise_70348****374354564"
},
{
"id": "enterprise_70365****3106796547"
}
],
"chats": [
{
"id": "oc_c13831833e****92c52befa759ea4806"
},
{
"id": "oc_c8161c910****a24127e73b10233b295"
}
],
"docs": [
{
"title": "猜你想问 / FAQs",
"url": "https://bytedance.feishu.cn/wiki/wikcnZ8Lq4f9DMCDOtdcIzCUjAh"
},
{
"title": "快速了解飞书文档 | Introducing Feishu Docs",
"url": "https://bytedance.feishu.cn/docs/doccnxlVCCFjMsJE15I7PLAjIWc"
}
],
"links": [
{
"title": "飞书官网",
"url": "https://feishu.cn"
}
],
"oncalls": [
{
"id": "702368904****548034"
},
{
"id": "70240637****0910850"
}
],
"users": [
{
"id": "ou_30b07b6****ea46518789914dac63d36",
"title": "负责人"
},
{
"id": "ou_b292c0****c14754639fa4501e80c36a",
"title": ""
}
],
"classifications": [
{
"id": "7049606926****37761",
"father_id": "7049606926****37777"
}
],
"images": [
{
"token": "boxbcEcmKiD3SGHvgqWTpvdc7jc"
}
]
},
"outer_info": {
"provider": "星云",
"outer_id": "client_653****98d"
},
"rich_text": "词典是飞书提供的一款知识管理工具,通过飞书词典可以帮助企业将分散的知识信息进行聚合,并通过UGC的方式,促进企业知识的保鲜和流通"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ entity | entity | 词条信息 |
└ id | string | 词条 ID (需要更新某个词条时填写,若是创建新词条可不填写) |
└ main_keys | term\[\] | 词条名 |
└ key | string | 名称的值 |
└ display_status | display_status | 名称展示范围 |
└ allow_highlight | boolean | 对应名称是否在消息/云文档高亮 |
└ allow_search | boolean | 对应名称是否在搜索结果中展示 |
└ aliases | term\[\] | 别名 |
└ key | string | 名称的值 |
└ display_status | display_status | 名称展示范围 |
└ allow_highlight | boolean | 对应名称是否在消息/云文档高亮 |
└ allow_search | boolean | 对应名称是否在搜索结果中展示 |
└ description | string | 纯文本格式词条释义。注:description 和 rich_text 至少有一个,否则会报错:1540001 |
└ create_time | 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 |
└ name | string | 二级分类名称 |
└ father_id | string | 对应一级分类 ID |
└ images | baike_image\[\] | 上传的图片 |
└ token | string | 通过文件接口上传图片后,获得的图片 token |
└ statistics | statistics | 当前词条收到的反馈数据 |
└ like_count | int | 累计点赞 |
└ dislike_count | int | 当前词条版本收到的负反馈数量 |
└ outer_info | outer_info | 外部系统关联数据 |
└ provider | string | 外部系统(不能包含中横线 "-") |
└ outer_id | string | 词条在外部系统中对应的唯一 ID(不能包含中横线 "-") |
└ rich_text | string | 富文本格式(当填写富文本内容时,description字段将会失效可不填写),支持的格式参考飞书词典指南中的释义部分 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"entity": {
"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的方式,促进企业知识的保鲜和流通",
"create_time": "1627540853",
"update_time": "1627541853",
"related_meta": {
"abbreviations": [
{
"id": "enterprise_4450890"
},
{
"id": "enterprise_703481393374354564"
},
{
"id": "enterprise_7036598993106796547"
}
],
"chats": [
{
"id": "oc_c13831833eaa8c92c52befa759ea4806"
},
{
"id": "oc_c8161c9109966a24127e73b10233b295"
}
],
"docs": [
{
"title": "猜你想问 / FAQs",
"url": "https://bytedance.feishu.cn/wiki/wikcnZ8Lq4f9DMCDOtdcIzCUjAh"
},
{
"title": "快速了解飞书文档 | Introducing Feishu Docs",
"url": "https://bytedance.feishu.cn/docs/doccnxlVCCFjMsJE15I7PLAjIWc"
}
],
"links": [
{
"title": "飞书官网",
"url": "https://feishu.cn"
}
],
"oncalls": [
{
"id": "7023689049445548034"
},
{
"id": "7024063787560910850"
}
],
"users": [
{
"id": "ou_30b07b63089ea46518789914dac63d36",
"title": "负责人"
},
{
"id": "ou_b292c0d285c14754639fa4501e80c36a",
"title": ""
}
],
"classifications": [
{
"id": "7049606926702837761",
"father_id": "7049606926702837777"
}
],
"images": [
{
"token": "boxbcEcmKiD3SGHvgqWTpvdc7jc"
}
]
},
"statistics": {
"like_count": 100,
"dislike_count": 20
},
"outer_info": {
"provider": "星云",
"outer_id": "client_6539i3498d"
},
"rich_text": "词典是飞书提供的一款知识管理工具,通过飞书词典可以帮助企业将分散的知识信息进行聚合,并通过UGC的方式,促进企业知识的保鲜和流通"
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1540001 | invalid param | 参数错误,参考文档检查输入参数 |
| 500 | 1540002 | network anomaly, please try again | 多数请求是服务超时,请重新请求,少数是服务异常请咨询客服 |
