获取全部知识库详情

该接口用于获取服务台知识库详情。

请求

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

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_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

查询参数

名称	类型	必填	描述
category_id	string	否	知识库分类ID 示例值：6856395522433908739
status	string	否	搜索条件: 知识库状态 1:在线 0:删除，可恢复 2：删除，不可恢复 示例值：1
search	string	否	搜索条件: 关键词，匹配问题标题，问题关键字，用户姓名 示例值：点餐
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：6856395634652479491
page_size	int	否	示例值：10 默认值：20 数据校验规则： - 最大值：100

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ has_more	boolean	是否还有更多项
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ page_size	int	实际返回的FAQ数量
└ total	int	总数
└ items	faq\[\]	知识库列表
└ faq_id	string	知识库ID
└ id	string	知识库旧版ID，请使用faq_id
└ helpdesk_id	string	服务台ID
└ question	string	问题
└ answer	string	答案
└ answer_richtext	richtext\[\]	富文本答案。该字段支持 text、hyperlink、img、line break 四种类型，不同类型包含的参数信息可能不同，详情可参见富文本。
└ content	string	内容
└ type	string	类型
└ create_time	int	创建时间
└ update_time	int	修改时间
└ categories	category\[\]	分类
└ category_id	string	知识库分类ID
└ id	string	知识库分类ID，（旧版，请使用category_id）
└ name	string	名称
└ parent_id	string	父知识库分类ID
└ helpdesk_id	string	服务台ID
└ language	string	语言
└ tags	string\[\]	相似问题列表
└ expire_time	int	失效时间
└ update_user	ticket_user	更新用户
└ id	string	用户ID
└ avatar_url	string	用户头像url
└ name	string	用户名
└ department	string	所在部门名称
└ city	string	城市
└ country	string	国家代号(CountryCode)，参考：http://www.mamicode.com/info-detail-2186501.html
└ create_user	ticket_user	创建用户
└ id	string	用户ID
└ avatar_url	string	用户头像url
└ name	string	用户名
└ department	string	所在部门名称
└ city	string	城市
└ country	string	国家代号(CountryCode)，参考：http://www.mamicode.com/info-detail-2186501.html

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "has_more": true,
        "page_token": "6856395634652479491",
        "page_size": 100,
        "total": 200,
        "items": [
            {
                "faq_id": "6936004780707807231",
                "id": "6936004780707807231",
                "helpdesk_id": "6936004780707807251",
                "question": "问题",
                "answer": "答案",
                "answer_richtext": [
                    {
                        "content": "我的答案",
                        "type": "text"
                    }
                ],
                "create_time": 1596379008,
                "update_time": 1596379008,
                "categories": [
                    {
                        "category_id": "6948728206392295444",
                        "id": "6948728206392295444",
                        "name": "创建团队和邀请成员",
                        "parent_id": "0",
                        "helpdesk_id": "6939771743531696147",
                        "language": "zh_cn"
                    }
                ],
                "tags": [
                    "问题"
                ],
                "expire_time": 1596379008,
                "update_user": {
                    "id": "ou_37019b7c830210acd88fdce886e25c71",
                    "avatar_url": "https://xxxx",
                    "name": "abc",
                    "department": "用户部门名称(有权限才展示)",
                    "city": "城市",
                    "country": "国家"
                },
                "create_user": {
                    "id": "ou_37019b7c830210acd88fdce886e25c71",
                    "avatar_url": "https://xxxx",
                    "name": "abc",
                    "department": "用户部门名称(有权限才展示)",
                    "city": "城市",
                    "country": "国家"
                }
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
404	154004	Resource not found	资源不存在，请检查ID值
500	155000	Internal error	内部错误，请联系我们