查询Q&A列表

POST /sdk/knowledgeItems/search

Body 请求参数

{
  "pageSize": 10,
  "pageNum": 1,
  "knowledgeBaseId": "12246",
  "status": 1,
  "orderFlag": 1,
  "templateId": 0,
  "tagIds": []

}

请求参数

名称 位置 类型 必选 中文名 说明
knowledgeBaseId query integer 知识空间id
Content-Type header string none
body body object none
» pageNum body integer 页号 页号
» pageSize body integer 页面大小 页面大小
» orderFlag body integer 排序 排序:1
» tagIds body [integer] 标签列表 none
» knowledgeBaseId body integer 空间ID none
» status body integer 知识状态 知识状态,固定传1查询已发布知识
» templateId body integer 模板id 模板id,固定传0查非模板知识

示例

请求

curl --location --request POST 'https://knowledgeservice.s4.udesk.cn/api/sdk/knowledgeItems/search' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzM3MDYsImFwcElkIjoiNmYwZDMwNWItZmNhMS00MDU2LTY1YzQtNjNhN2RlOWY0N2VjIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDMwNTk5LCJpYXQiOjE3NjI0Mjc1OTksInVzZXJJZCI6Mn0.bzZPWBD-qVaB2CpG5V7psO6UY7-dq0radv_2FN_I_n3AkTiTlahZT5A7iPwlyQ4jTCjlvgeHntW94biJ2U9T6LZA_5WHT4PJ0vnr2ZWhWl6oovzd_dREy2hxa_SL0L0myMQBxQoVR-BVKQX7LS9-ehNdNa9sgyeF5yUTneR7rjw' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Cache-Control: no-cache' \
--header 'Host: knowledgeservice.s4.udesk.cn' \
--header 'Connection: keep-alive' \
--header 'Cookie: kcs-session-id=ae042aa8-1ad6-44bc-8434-7681d0192fe8' \
--data-raw '{"pageSize": 10,
  "pageNum": 1,
  "knowledgeBaseId": "12246",
  "status": 1,
  "orderFlag": 1,
  "templateId": 0,
  "tagIds": []

}'

结果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "paging": {
    "pageNum": 1,
    "pageSize": 10,
    "total": 21
  },
  "data": [
    {
      "id": 362625,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-11-04 10:11:11",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-11-06 19:13:02",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        78852
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回归测试(勿动)",
      "categoryIdList": [
        78852
      ],
      "templateId": 0,
      "name": "测试知识2025-11-04 10:11:10更新更新",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-11-06T19:13:02",
      "content": "测试知识测试知识2025-11-04 10:11:10更新更新",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "browseCount": 1,
      "uvCount": 1,
      "source": 0,
      "deletePerson": false,
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 673526
    },
    {
      "id": 362624,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-11-04 09:59:20",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-11-04 09:59:20",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        75772
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回归测试(勿动)",
      "categoryIdList": [
        75772
      ],
      "templateId": 0,
      "name": "测试知识2025-11-04 09:59:19",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-11-04T09:59:20",
      "content": "测试知识2025-11-04 09:59:19",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 671240
    },
    {
      "id": 362623,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-11-04 09:54:00",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-11-04 09:54:00",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        75772
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回归测试(勿动)",
      "categoryIdList": [
        75772
      ],
      "templateId": 0,
      "name": "测试知识2025-11-04 09:53:58",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-11-04T09:53:59",
      "content": "测试知识2025-11-04 09:53:58",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 671238
    },
    {
      "id": 360423,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-30 19:37:40",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-30 19:37:40",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回归测试(勿动)",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "创建提问1761824256",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-10-30T19:37:40",
      "content": "回复问题创建提问1761824256",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 668458
    },
    {
      "id": 360394,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-30 10:06:30",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-30 10:06:30",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回归测试(勿动)",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "创建提问1761789985",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-10-30T10:06:29",
      "content": "回复问题创建提问1761789985",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 668383
    },
    {
      "id": 360337,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-29 10:14:42",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-29 15:39:28",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回归测试(勿动)",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "新建的知识点存草稿",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 1,
      "approveUserId": 2,
      "approveTime": "2025-10-29T15:39:27",
      "content": "<p>新建的知识点存草稿</p>",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 1,
      "uvCount": 1,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 668339
    },
    {
      "id": 360264,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-28 15:15:29",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-28 15:15:29",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回归测试(勿动)",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "新建Q&A-1761635727",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-10-28T15:15:28",
      "content": "<p>新建Q&amp;A的答案-1761635727</p>",
      "tags": [
        {
          "tagId": 3237,
          "tagName": "新增标签1757939200",
          "deleteFlag": 0
        }
      ],
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 668115
    },
    {
      "id": 360099,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-23 20:32:06",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-23 20:32:06",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回归测试(勿动)",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "新建Q&A永久有效仅对内-1761222725",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 1,
      "approveUserId": 2,
      "approveTime": "2025-10-23T20:32:06",
      "content": "<p>新建Q&amp;A的答案-1761222725</p>",
      "tags": [
        {
          "tagId": 3234,
          "tagName": "新增标签1757937914",
          "deleteFlag": 0
        }
      ],
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 667713
    },
    {
      "id": 360098,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-23 20:30:06",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-23 20:30:06",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回归测试(勿动)",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "新建Q&A-1761222605",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-10-23T20:30:06",
      "content": "<p>新建Q&amp;A的答案-1761222605</p>",
      "tags": [
        {
          "tagId": 3234,
          "tagName": "新增标签1757937914",
          "deleteFlag": 0
        }
      ],
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 667712
    },
    {
      "id": 360097,
      "createUserId": 2,
      "createUserUsername": "Alex",
      "createTime": "2025-10-23 20:16:14",
      "updateUserId": 2,
      "updateUserUsername": "Alex",
      "updateTime": "2025-10-23 20:16:14",
      "deleteFlag": 0,
      "categoryIdMultiple": [
        48470
      ],
      "knowledgeCreateBool": true,
      "knowledgeManageBool": true,
      "knowledgeBaseId": 12246,
      "knowledgeBaseName": "Apifox回归测试(勿动)",
      "categoryIdList": [
        48470
      ],
      "templateId": 0,
      "name": "创建提问1761221769",
      "status": 1,
      "availableTimeType": 0,
      "accessLevel": 0,
      "approveUserId": 2,
      "approveTime": "2025-10-23T20:16:14",
      "content": "回复问题创建提问1761221769",
      "share": {
        "canShare": true,
        "shareOutside": true,
        "robotFlag": false,
        "backGround": true,
        "addWatermark": false,
        "allowCopy": true
      },
      "commentCount": 0,
      "attachmentDownload": false,
      "canEdit": false,
      "topFlag": 0,
      "topTime": "1970-01-01 01:01:01",
      "favoriteCount": 0,
      "likeCount": 0,
      "disLikeCount": 0,
      "sdkSendFlag": 0,
      "sdkUseFlag": 0,
      "browseCount": 0,
      "uvCount": 0,
      "source": 0,
      "deletePerson": false,
      "langCode": "ZH-CN",
      "valid": true,
      "uagentSyncStatus": 0,
      "uagentSyncRetryTimes": 0,
      "historyId": 667711
    }
  ],
  "extra": {
    "searchStatistics": {
      "userStatistics": [
        {
          "id": 2,
          "name": "Alex",
          "count": 21
        }
      ],
      "tagStatistics": [
        {
          "id": 3234,
          "name": "新增标签1757937914",
          "count": 9
        },
        {
          "id": 3237,
          "name": "新增标签1757939200",
          "count": 1
        }
      ]
    }
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» succeed boolean true none none
» code integer true none none
» bizCode string true none none
» message string true none none
» visible boolean true none none
» paging object true none none
»» pageNum integer true none none
»» pageSize integer true none none
»» total integer true none none
» data [object] true none none
»» id integer false none 知识ID none
»» createUserId integer false none 创建用户ID none
»» createUserUsername string false none 创建用户名称 none
»» createTime string false none 创建时间 none
»» updateUserId integer false none 更新用户ID none
»» updateUserUsername string false none 更新用户名称 none
»» updateTime string false none 更新时间 none
»» deleteFlag integer false none 删除标志 none
»» categoryIdMultiple [object] false none 分类 none
»» knowledgeCreateBool boolean false none 权限标志 none
»» knowledgeManageBool boolean false none 权限标志 none
»» knowledgeBaseId integer false none 空间ID none
»» knowledgeBaseName string false none 空间名称 none
»» categoryIdList [object] false none 分类 none
»» templateId integer false none 模板id none
»» name string false none QA名称 none
»» status integer false none 状态 none
»» availableTimeType integer false none 生效标志 none
»» accessLevel integer false none 访问权限,0:可对外,1:仅内部 none
»» approveUserId integer false none 审批人 none
»» approveTime string false none 审批时间 none
»» content string true none QA内容 none
»» share [object] true none 分享 none
»»» canShare boolean true none 能否分享 none
»»» shareOutside boolean true none 能否分享到外部 none
»»» robotFlag boolean true none 是否有机器人配置 none
»»» backGround boolean true none 背景开关 none
»»» addWatermark boolean true none 添加水印(0添加水印,1不添加水印) none
»»» allowCopy boolean true none 允许复制(0允许复制,1不允许复制) none
»» commentCount integer true none 评论量 none
»» attachmentDownload boolean true none 附件下载权限 none
»» canEdit boolean true none 是否可以修改 none
»» topFlag integer true none 置顶标识(0未置顶,1已置顶) none
»» topTime string true none 置顶时间 none
»» favoriteCount integer true none 收藏量 none
»» likeCount integer true none 点赞量 none
»» disLikeCount integer true none 点踩量 none
»» browseCount integer true none 观看量 none
»» uvCount integer true none none none
»» source integer true none 来源 none
»» deletePerson boolean true none true:可删除,false:不可删除(展示反馈按钮) none
»» valid boolean true none 是否有效 none
»» uagentSyncStatus integer true none uagent同步状态(0未同步,1已同步) none
»» uagentSyncRetryTimes integer true none 同步Agent重试次数 none
»» historyId integer true none 搜索历史记录id none

新增Q&A

POST /sdk/knowledgeItems

Body 请求参数

{
  "name": "测试知识2025-11-06 20:13:35",
  "categoryId": 78850,
  "content": "<p>测试知识2025-11-06 20:13:35</p>",
  "availableTimeType": 0,
  "templateId": 0,
  "status": 1,
  "channelManagements": [
    {
      "id": null
    }
  ],
  "knowledgeBaseId": "12246"

}

请求参数

名称 位置 类型 必选 中文名 说明
knowledgeBaseId query integer 知识空间id
systemType query string 系统类型
Content-Type header string none
body body object none
» name body string QA名称 QA名称
» regulation body string 无说明,传空
» categoryId integer false none 分类ID none
» content body string QA内容 QA内容
» availableTimeType body integer 有效期,固定传0永久有效 有效期,固定传0永久有效
» templateId body integer 模板id 模板id,固定传0查非模板知识
» status integer false none 状态 none
» channelManagements [object] true none 渠道 none
»» id integer true none 渠道id none
» knowledgeBaseId integer false none 空间ID none

示例

请求

curl --location --request POST 'https://knowledgeservice.s4.udesk.cn/api/sdk/knowledgeItems' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzM3MDYsImFwcElkIjoiNmYwZDMwNWItZmNhMS00MDU2LTY1YzQtNjNhN2RlOWY0N2VjIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDM0MjE1LCJpYXQiOjE3NjI0MzEyMTUsInVzZXJJZCI6Mn0.qUgSnW8Tca6jbWpdAbqVUe-XhFNPVjDycOlyLyiiuV8KMODMdsD5nHtv5anxqkJElbHaVIi2IP43LVwEuKfo7RDChOSrgdrNa-r0DZG9EwA0zM-avIX17VqssARfOLQ4rHwbCAmMprYrIdC7Jy-uNlmjUnmXX5TiUZgKw4v6YVc' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Cache-Control: no-cache' \
--header 'Host: knowledgeservice.s4.udesk.cn' \
--header 'Connection: keep-alive' \
--header 'Cookie: kcs-session-id=ef7f8ed1-83dc-4bdc-9a9f-8b0717587c90' \
--data-raw '{
  "name": "测试知识2025-11-06 20:13:35",
  "categoryId": 78850,
  "content": "<p>测试知识2025-11-06 20:13:35</p>",
  "availableTimeType": 0,
  "templateId": 0,
  "status": 1,
  "channelManagements": [
    {
      "id": null
    }
  ],
  "knowledgeBaseId": "12246"

}'

结果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": {
    "deleteFlag": 0,
    "categoryIdMultiple": [],
    "knowledgeBaseId": 12246,
    "categoryId": 78850,
    "categoryIdList": [],
    "templateId": 0,
    "name": "测试知识2025-11-06 20:13:35",
    "status": 1,
    "availableTimeType": 0,
    "accessLevel": 0,
    "content": "测试知识2025-11-06 20:13:35",
    "channelManagements": [
      {
        "deleteFlag": 0,
        "synchronousSend": 0
      }
    ],
    "canEdit": false,
    "topFlag": 0,
    "sdkSendFlag": 0,
    "sdkUseFlag": 0,
    "deletePerson": false,
    "langCode": "ZH-CN",
    "valid": true,
    "uagentSyncStatus": 0
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» succeed boolean true none none
» code integer true none none
» bizCode string true none none
» message string true none none
» visible boolean true none none
» data [object] true none none
»» deleteFlag boolean false none 删除标志 none
»» categoryIdMultiple [object] false none 分类 none
»» knowledgeBaseId integer false none 空间ID none
»» categoryId integer false none 分类ID none
»» categoryIdList [object] false none 分类ID none
»» templateId integer false none 模板id none
»» name string false none QA名称 none
»» status integer false none 状态 none
»» availableTimeType integer false none 生效标志 none
»» accessLevel integer false none 访问权限,0:可对外,1:仅内部 none
»» content string true none QA内容 none
»» channelManagements [object] true none 渠道 none
»»» deleteFlag integer true none 删除标志 none
»»» synchronousSend integer true none 同步标志 none
»» canEdit boolean true none 是否可以修改 none
»» topFlag integer true none 置顶标识(0未置顶,1已置顶) none
»» sdkSendFlag string true none SDK发送开关 none
»» sdkUseFlag integer true none SDK使用开关 none
»» deletePerson boolean true none true:可删除,false:不可删除(展示反馈按钮) none
»» langCode body string 默认ZH-CN
»» valid boolean true none 是否有效 none
»» uagentSyncStatus integer true none uagent同步状态(0未同步,1已同步) none

更新Q&A

PUT /sdk/knowledgeItems/{id:^[1-9]\d*$}

Body 请求参数

{
  "id": "258013",
  "historyId": 16892,
  "contentUuid": "e2c3cfe4-9e7b-4989-8a70-72e9b6dedbfc",
  "langCode": "ZH-CN",
  "name": "带富文本内容的QA",
  "regulation": "",
  "similarQuestions": [],
  "tags": [],
  "accessLevel": 0,
  "status": 1,
  "availableTimeType": 0,
  "relevances": [],
  "channelContents": [],
  "kcs": {
    "libraries": []
  },
  "atomIds": "",
  "contentAnswerShowFlag": 0,
  "contentAnswerList": [],
  "referenceItemIds": "257566",
  "templateId": 0,
  "attachments": [],
  "content": "<p>1321,引用其他知识点</p>\n<div style=\"display: inline-block;\">\n<p class=\"udesk-kcs-react-udesk-wfe-tinymce-knowledge-link\" style=\"cursor: pointer; color: #0000ee; padding: 0 6px; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; user-select: none;\" contenteditable=\"false\" data-id=\"257566\" data-name=\"E300硬盘盒怎么安装\" data-historyid=\"-1\" data-allowmanage=\"0\" data-templateid=\"0\" data-knowledgebaseid=\"281\">E300硬盘盒怎么安装</p>\n<p>123</p>\n</div>\n<p>&nbsp;</p>",
  "sdkSendFlag": 0,
  "sdkUseFlag": 0,
  "knowledgeBaseId": "281",
  "recordId": "",
  "channelManagements": [],
  "draftFlag": null,
  "categoryIdList": [
    11913
  ]
}

请求参数

名称 位置 类型 必选 中文名 说明
id:^[1-9]\d*$ path string none
Authorization header string none
Content-Type header string none
body body object none
» id body string 知识ID
» historyId body integer 知识版本id
» contentUuid body string uuid
» langCode body string ZH-CN
» name body string QA名称
» regulation body string 无说明,传空
» similarQuestions body [string] 相似问,无传[]
» tags body [string] 无说明,传[]
» accessLevel body integer 固定传0
» status body integer 知识状态,固定传1发布知识
» availableTimeType body integer 有效期,固定传0永久有效
» relevances body [string] 无说明,传[]
» channelContents body [string] 无说明,传[]
» kcs body object 无说明,传空
»» libraries body [string] none
» atomIds body string 无说明,传空
» contentAnswerShowFlag body integer 固定传0
» contentAnswerList body [string] 无说明,传[]
» referenceItemIds body string 无说明,传空
» templateId body integer 模板id,固定传0查非模板知识
» attachments body [string] 无说明,传[]
» content body string QA答案
» sdkSendFlag body integer 固定传0
» sdkUseFlag body integer 固定传0
» knowledgeBaseId body string 知识空间id
» recordId body string 无说明,传空
» channelManagements body [string] 无说明,传[]
» draftFlag body integer 从草稿箱编辑 发布 存入草稿 这个flag为1
» categoryIdList body [integer] 分类集合id

示例

请求

curl --location --request PUT 'https://kcs.t1.in.tryudesk.com/api/sdk/knowledgeItems/258013' \
--header 'knowledgebaseid: 281' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzAwMDAwMDIsImFwcElkIjoiNDY3Yzk4N2EtMjk0YS00NDk2LTRhZDctYzIyM2Y4ZDdiZjhmIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDM1NDE5LCJpYXQiOjE3NjI0MzI0MTksInVzZXJJZCI6Mn0.bYhqESpi7QvuYW64BraWz74hHr9_kw6xmfNLf_IeMwwyW-wztuJDnsgNgohXl6CpStambeedokbx37EEFJMudaIi2lzgSTzht6RCTIg7ZrgB4Y-BuOcK0O-h8klAOj5Y8g67VuUEqaGuV4GoJR5CVbJAibgvdYntZIYCWFiNaz8' \
--header 'Content-Type: application/json' \
--data '{
    "id": "258013",
    "historyId": 16892,
    "contentUuid": "e2c3cfe4-9e7b-4989-8a70-72e9b6dedbfc",
    "langCode": "ZH-CN",
    "name": "带富文本内容的QA",
    "regulation": "",
    "similarQuestions": [],
    "tags": [],
    "accessLevel": 0,
    "status": 1,
    "availableTimeType": 0,
    "relevances": [],
    "channelContents": [],
    "kcs": {
        "libraries": []
    },
    "atomIds": "",
    "contentAnswerShowFlag": 0,
    "contentAnswerList": [],
    "referenceItemIds": "257566",
    "templateId": 0,
    "attachments": [],
    "content": "<p>1321,引用其他知识点</p>\n<div style=\"display: inline-block;\">\n<p class=\"udesk-kcs-react-udesk-wfe-tinymce-knowledge-link\" style=\"cursor: pointer; color: #0000ee; padding: 0 6px; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; user-select: none;\" contenteditable=\"false\" data-id=\"257566\" data-name=\"E300硬盘盒怎么安装\" data-historyid=\"-1\" data-allowmanage=\"0\" data-templateid=\"0\" data-knowledgebaseid=\"281\">E300硬盘盒怎么安装</p>\n<p>123</p>\n</div>\n<p>&nbsp;</p>",
    "sdkSendFlag": 0,
    "sdkUseFlag": 0,
    "knowledgeBaseId": "281",
    "recordId": "",
    "channelManagements": [],
    "draftFlag": null,
    "categoryIdList": [
        11913
    ]
}'

结果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": {
    "id": 258013,
    "deleteFlag": 0,
    "knowledgeBaseId": 281,
    "templateId": 0,
    "name": "带富文本内容的QA",
    "regulation": "",
    "status": 1,
    "availableTimeType": 0,
    "content": "1321,引用其他知识点\n\nE300硬盘盒怎么安装\n123\n\n&amp;nbsp;",
    "contentUuid": "e2c3cfe4-9e7b-4989-8a70-72e9b6dedbfc",
    "channelManagements": [],
    "attachments": [],
    "canEdit": false,
    "atomIds": "",
    "referenceItemIds": "257566",
    "sdkSendFlag": 0,
    "sdkUseFlag": 0,
    "accessLevel": 0,
    "contentAnswerList": [],
    "contentAnswerShowFlag": 0,
    "langCode": "ZH-CN",
    "translateRelBool": false,
    "systemType": 1,
    "categoryIds": "[11913]",
    "categoryIdList": [
      11913
    ]
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» succeed boolean true none none
» code integer true none none
» bizCode string true none none
» message string true none none
» visible boolean true none none
» data object true none none
»» id integer true none 知识ID none
»» deleteFlag integer true none 删除标志 none
»» knowledgeBaseId integer true none 知识空间 none
»» templateId integer true none 模版id none
»» name string true none 知识名称 none
»» regulation string true none none
»» status integer true none 状态 none
»» availableTimeType integer true none 生效标志 none
»» content string true none 内容 none
»» contentUuid string true none none
»» channelManagements [string] true none 渠道 none
»» attachments [object] true none none
»» canEdit boolean true none 是否可以修改 none
»» atomIds string true none none
»» referenceItemIds string true none none
»» sdkSendFlag integer true none 固定传0 none
»» sdkUseFlag integer true none 固定传0 none
»» accessLevel integer true none 固定传0 none
»» contentAnswerList [string] true none none
»» contentAnswerShowFlag integer true none none
»» transfer object true none none
»»» targetStatus integer true none none
»» langCode string true none none
»» translateRelBool boolean true none none
»» systemType integer true none none
»» categoryIds string true none none
»» categoryIdList string true none none

查询QA详情

GET /sdk/knowledgeItems/{id}

请求参数

名称 位置 类型 必选 中文名 说明
id path string 知识点id
Authorization header string none
Content-Type header string none
historyId header integer 知识版本id,默认为-1(为空时会默认等于-1)
knowledgeBaseId header integer 知识空间id none

示例

请求

curl --location 'https://kcs.t1.in.tryudesk.com/api/sdk/knowledgeItems/258013?historyId=-1' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzAwMDAwMDIsImFwcElkIjoiNDY3Yzk4N2EtMjk0YS00NDk2LTRhZDctYzIyM2Y4ZDdiZjhmIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDk3MTU4LCJpYXQiOjE3NjI0OTQxNTgsInVzZXJJZCI6Mn0.DYjYfagGxjK8ZHSw7Sq54hbfvCaxIH0nEoDnXmD98LRPJVJe2hOgcDT1HwRCBIB48ktAz8Ycpvcv8xmN0MFbaluWTBJ_SuiXf9GawQZQR0pQbjyq6bE6JSl3JbchgfrkIE1_ZwQ_LiSnuSld3tvgUf2rC4OsikFse0IhLdfIPWw' \
--data ''

结果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": {
    "id": 258013,
    "createUserId": 2,
    "createUserUsername": "Admin123456",
    "createTime": "2025-10-21 16:16:46",
    "updateUserId": 2,
    "updateUserUsername": "Admin123456",
    "updateTime": "2025-11-06 20:34:03",
    "deleteFlag": 0,
    "categoryIdMultiple": [
      11913
    ],
    "knowledgeCreateBool": true,
    "knowledgeManageBool": true,
    "knowledgeBaseId": 281,
    "knowledgeBaseName": "UAgent便捷创建知识空间",
    "categoryIdList": [
      11913
    ],
    "templateId": 0,
    "priority": 0,
    "name": "带富文本内容的QA",
    "regulation": "",
    "status": 1,
    "size": 0,
    "availableTimeType": 0,
    "accessLevel": 0,
    "approveUserId": 2,
    "approveUserUsername": "Admin123456",
    "approveTime": "2025-11-06T20:34:03",
    "content": "1321,引用其他知识点\n\nE300硬盘盒怎么安装\n123\n\n&amp;nbsp;",
    "channelManagements": [],
    "managePermissionDto": {},
    "attachmentDownload": true,
    "canEdit": true,
    "topFlag": 0,
    "topTime": "1970-01-01 01:01:01",
    "entourage": {
      "catalogueList": [],
      "knowledgeAssociation": {
        "qaAssociationList": []
      }
    },
    "favoriteCount": 0,
    "likeCount": 0,
    "disLikeCount": 0,
    "sdkSendFlag": 0,
    "sdkUseFlag": 0,
    "contentId": 16264,
    "contentUuid": "e2c3cfe4-9e7b-4989-8a70-72e9b6dedbfc",
    "contentAnswerShowFlag": 0,
    "deletePerson": true,
    "langCode": "ZH-CN",
    "valid": true,
    "uagentSyncStatus": 0,
    "historyId": 17190
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» succeed boolean true none none
» code integer true none none
» bizCode string true none none
» message string true none none
» visible boolean true none none
» data object true none none
»» id integer true none 知识id none
»» createUserId integer false none 创建用户ID none
»» createUserUsername string false none 创建用户名称 none
»» createTime string false none 创建时间 none
»» updateUserId integer false none 更新用户ID none
»» updateUserUsername string false none 更新用户名称 none
»» updateTime string false none 更新时间 none
»» deleteFlag integer false none 删除标志 none
»» categoryIdMultiple [object] false none 分类 none
»» knowledgeCreateBool boolean false none 权限标志 none
»» knowledgeManageBool boolean false none 权限标志 none
»» knowledgeBaseId integer false none 空间ID none
»» knowledgeBaseName string false none 空间名称 none
»» categoryIdList [object] false none 分类 none
»» templateId integer false none 模板id none
»» priority integer true none 置顶显示优先级 none
»» name string true none QA名称 none
»» regulation string true none none
»» status integer true none 状态 none
»» size integer true none 大小 none
»» availableTimeType integer true none 生效标志 none
»» accessLevel integer false none 访问权限,0:可对外,1:仅内部 none
»» approveUserId integer false none 审批人ID none
»» approveUserUsername string false none 审批人 none
»» approveTime string false none 审批时间 none
»» content string true none QA内容 none
» channelManagements [object] true none 渠道 none
»» id integer true none 渠道id none
»» relevances [object] true none 相关问题列表 none
»»» relevantItemId integer true none 相关知识点ID none
»»» relevantItemName string true none 相关知识点名称 none
»» managePermissionDto [object] true none 权限列表 none
»» attachmentDownload boolean true none 附件下载权限 none
»» canEdit boolean true none 是否可以修改 none
»» topFlag integer true none 置顶标识(0未置顶,1已置顶) none
»» topTime string true none 置顶时间 none
»» entourage [object] true none 随录数据补充信息 none
»»» catalogueList [object] true none 目录 none
»»» knowledgeAssociation [object] true none 知识关联 none
»»»» qaAssociationList [object] true none 知识点关联 none
»» favoriteCount integer true none 收藏量 none
»» likeCount integer true none 点赞量 none
»» disLikeCount integer true none 点踩量 none
»» sdkSendFlag string true none SDK发送开关 none
»» sdkUseFlag integer true none SDK使用开关 none
»» contentId integer true none 内容id none
» contentUuid body string uuid
» contentAnswerShowFlag body integer 固定传0
»» deletePerson boolean true none true:可删除,false:不可删除(展示反馈按钮) none
»» langCode body string 默认ZH-CN
»» valid boolean true none 是否有效 none
»» uagentSyncStatus integer true none uagent同步状态(0未同步,1已同步) none
»» historyId integer true none 搜索历史记录id none

查询系统中是否存在重复Q&A

POST /sdk/knowledgeItems/checkRepeat

Body 请求参数

{
  "name":"测试知识2025-11-06 20:13:35更新",
  "knowledgeBaseId": "12246",
  "type":1,
  "editionId":null,
  "id":362625

}

请求参数

名称 位置 类型 必选 中文名 说明
id body integer 知识id
editionId body integer 验重时,需要忽略的知识版本id 验重时,需要忽略的知识版本id
knowledgeBaseId body integer 空间ID 空间ID
name body string 知识名称 知识名称
type body integer 模板id 1默认模板 2自定义模板

示例

请求

curl --location --request POST 'https://knowledgeservice.s4.udesk.cn/api/sdk/knowledgeItems/checkRepeat' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJrbSIsImNvbXBhbnlJZCI6MzM3MDYsImFwcElkIjoiNmYwZDMwNWItZmNhMS00MDU2LTY1YzQtNjNhN2RlOWY0N2VjIiwiaXNzIjoia20iLCJ1c2VyVHlwZSI6MiwiZXhwIjoxNzYyNDM0MjE1LCJpYXQiOjE3NjI0MzEyMTUsInVzZXJJZCI6Mn0.qUgSnW8Tca6jbWpdAbqVUe-XhFNPVjDycOlyLyiiuV8KMODMdsD5nHtv5anxqkJElbHaVIi2IP43LVwEuKfo7RDChOSrgdrNa-r0DZG9EwA0zM-avIX17VqssARfOLQ4rHwbCAmMprYrIdC7Jy-uNlmjUnmXX5TiUZgKw4v6YVc' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Cache-Control: no-cache' \
--header 'Host: knowledgeservice.s4.udesk.cn' \
--header 'Connection: keep-alive' \
--header 'Cookie: kcs-session-id=ef7f8ed1-83dc-4bdc-9a9f-8b0717587c90' \
--data-raw '{

  "name":"测试知识2025-11-06 20:13:35更新",
  "knowledgeBaseId": "12246",
"type":1,
"editionId":null,
"id":362625

}'

结果

{
  "succeed": true,
  "code": 200,
  "bizCode": "000000",
  "message": "OK",
  "visible": false,
  "data": {
    "id": 362624,
    "deleteFlag": 0,
    "categoryIdMultiple": [],
    "knowledgeBaseId": 12246,
    "categoryIdList": [],
    "templateId": 0,
    "name": "测试知识2025-11-06 19:17:48更新",
    "attachmentDownload": false,
    "itemType": 1,
    "canEdit": false,
    "topFlag": 0,
    "favoriteCount": 0,
    "likeCount": 0,
    "disLikeCount": 0,
    "deletePerson": false,
    "valid": true,
    "uagentSyncStatus": 0,
    "historyId": 673531
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» succeed boolean true none none
» code integer true none none
» bizCode string true none none
» message string true none none
» visible boolean true none none
» data [object] true none none
»» id integer false none 知识ID none
»» deleteFlag integer false none 删除标志 none
»» categoryIdMultiple [object] false none 分类 none
»» knowledgeBaseId integer false none 空间ID none
»» categoryIdList [object] false none 分类 none
»» templateId integer false none 模板id none
»» name string false none QA名称 none
»» attachmentDownload boolean true none 附件下载权限 none
»» itemType integer true none 知识类型 none
»» canEdit boolean true none 是否可以修改 none
»» topFlag integer true none 置顶标识(0未置顶,1已置顶) none
»» favoriteCount integer true none 收藏量 none
»» likeCount integer true none 点赞量 none
»» disLikeCount integer true none 点踩量 none
»» deletePerson boolean true none true:可删除,false:不可删除(展示反馈按钮) none
»» valid boolean true none 是否有效 none
»» uagentSyncStatus integer true none uagent同步状态(0未同步,1已同步) none
»» historyId integer true none 搜索历史记录id none