Skip to content

修改知识库

该接口用于修改知识库。

Tip: 注意事项: user_access_token 访问,需要操作者是当前服务台的客服、管理员或所有者

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/helpdesk/v1/faqs/:id
HTTP MethodPATCH
接口频率限制特殊频控
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用helpdesk:all 更新服务台资源详情

请求头

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

Tip: 服务台请求Header中还需添加“服务台token”参数:

Key: X-Lark-Helpdesk-Authorization

Value: base64(helpdesk_id:helpdesk_token),通过base64加密将helpdesk_id和helpdesk_token用':'连接而成的字符串。

了解更多:获取与使用服务台token

路径参数

名称类型描述
idstring知识库ID
示例值:"6856395634652479491"

请求体

名称类型必填描述
faqfaq_update_info修改的知识库内容
  └ category_idstring知识库分类ID
示例值:"6836004780707807251"
  └ questionstring问题
示例值:"问题"
  └ answerstring答案
示例值:"答案"
  └ answer_richtextrichtext\[\]富文本答案和答案必须有一个必填。Json Array格式,富文本结构请见了解更多: 富文本
示例值:[{"content":"答案","type":"text"},{"content":"\n","type":"text"}]
    └ contentstring内容
示例值:"这是一个答案"
    └ typestring内容类型。可选值:text、hyperlink、img、line break
示例值:"text"
  └ tagsstring\[\]相似问题
示例值:["测试","问题"]

请求体示例

json
{
    "faq": {
        "category_id": "6836004780707807251",
        "question": "问题",
        "answer": "答案",
        "answer_richtext": [
            {
                "content": "这是一个答案",
                "type": "text"
            }
        ],
        "tags": [
            "测试",
            "问题"
        ]
    }
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码错误码描述排查建议
400154000Bad request, please check your request body请求不合法,请检查参数
403154003Please check you have the correct access检查是否申请正确权限
404154004Resource not found资源不存在,请检查ID值
500155000Internal error内部错误,请联系我们

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