Skip to content

获取知识库分类

该接口用于获取知识库分类。

请求

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

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

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

Key: X-Lark-Helpdesk-Authorization

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

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

路径参数

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

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
datacategory-
  └ category_idstring知识库分类ID
  └ idstring知识库分类ID,(旧版,请使用category_id)
  └ namestring名称
  └ helpdesk_idstring服务台ID
  └ languagestring语言

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "category_id": "6948728206392295444",
        "id": "6948728206392295444",
        "name": "创建团队和邀请成员",
        "helpdesk_id": "6939771743531696147",
        "language": "zh_cn"
    }
}

错误码

HTTP状态码错误码描述排查建议
401154001Unauthorized, please check you have the correct access检查Authorization 和 X-Lark-Helpdesk-Authorization 是否正确,应用和服务台属于同一租户
404154004Resource not found资源不存在,请检查ID值
500155000Internal error内部错误,请联系我们

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