搜索知识库

GET

/helpdesk/v1/faqs/search

该接口用于搜索服务台知识库。

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

Key: X-Lark-Helpdesk-Authorization

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

错误码

HTTP状态码	错误码	描述	排查建议
400	154000	Bad request, please check your request body	请求不合法，请检查参数
401	154001	Unauthorized, please check you have the correct access	检查Authorization 和 X-Lark-Helpdesk-Authorization 是否正确，应用和服务台属于同一租户
500	155000	Internal error	内部错误，请联系我们

请求参数

Authorization

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET '/helpdesk/v1/faqs/search?query=wifi&base64=5bel5Y2V&page_token=6936004780707807251&page_size=10' \
--header 'Authorization: Bearer <token>'

响应示例

{
    "code": 0,
    "data": {
        "has_more": false,
        "items": [
            {
                "answer": "建议根据公司实际情况编写，以文档形式答疑",
                "answer_richtext": [
                    {
                        "content": "建议根据公司实际情况编写，以文档形式答疑",
                        "type": "text"
                    }
                ],
                "categories": [
                    {
                        "category_id": "6975057629039083524",
                        "id": "6975057629039083524",
                        "name": "行政"
                    },
                    {
                        "category_id": "6986214055581122561",
                        "id": "6986214055581122561",
                        "name": "名片申请"
                    }
                ],
                "create_time": 1626604715,
                "create_user": {
                    "avatar_url": "https://xxxxx",
                    "id": "ou_f7dab73dda407c7cbc947bbf4fd49c45",
                    "name": "陈xxx"
                },
                "faq_id": "6986214054851346434",
                "helpdesk_id": "6946124090457505820",
                "id": "6986214054851346434",
                "question": "盒餐发放位置查询",
                "tags": [
                    "盒饭",
                    "盒餐"
                ],
                "update_time": 1631242057,
                "update_user": {
                    "avatar_url": "xxxxxxxxxx",
                    "id": "ou_43771a6f8dfa0815600a949779xxx",
                    "name": "戴xx"
                }
            },
            {
                "answer": "建议根据公司实际情况编写，以文档形式答疑",
                "answer_richtext": [
                    {
                        "content": "我的答案",
                        "type": "text"
                    }
                ],
                "categories": [
                    {
                        "category_id": "6975057629039083524",
                        "id": "6975057629039083524",
                        "name": "行政"
                    },
                    {
                        "category_id": "6986214054805159937",
                        "id": "6986214054805159937",
                        "name": "餐饮服务"
                    }
                ],
                "create_time": 1626604715,
                "create_user": {
                    "avatar_url": "xxxxxxxxxx",
                    "id": "xxxx",
                    "name": "陈xx"
                },
                "faq_id": "6986214054826147841",
                "helpdesk_id": "6946124090457505820",
                "id": "6986214054826147841",
                "question": "下午茶推送和选品推荐",
                "tags": [
                    "供餐",
                    "下午茶"
                ],
                "update_time": 1630063323,
                "update_user": {
                    "avatar_url": "xxxxxxxxxx",
                    "id": "ou_eb208c4799a1f3a86c12e0b03e5a54b1",
                    "name": "蔡xx"
                }
            }
        ],
        "page_size": 2,
        "page_token": "6986214054876479490",
        "total": 2
    },
    "msg": "ok"
}

修改于 2025-10-21 07:30:00

获取知识库图像

创建知识库分类

搜索知识库

错误码#

请求参数

返回响应

错误码