所有api接口都需要鉴权规则,具体详情前往新平台鉴权规则查看

1、新增知识库目录接口

  • 请求路径 /im-km/openapi/catalog/create
  • 请求参数
字段名称 字段类型 是否必填 字段描述
account string 账户编号
agentId string 座席编号
label string 目录名称(不能重复)
level Number 目录等级(如果传一级分类,这个字段默认传1, 二级目录传2,以此类推)
parentId string 上级目录id(一级目录的parentId默认为0, 一级目录id为二级目录的parentId,以此类推)
  • 请求示例
curl --location --request POST 'http://v7openapi.7moor.com/im-km/openapi/catalog/create' \
--header 'm7-appkey: 2000100' \
--header 'm7-nonce: 111922' \
--header 'm7-sign: lmwwrahWCRO0x+3DhlMMVgB2V5ytUXp5GxbLTW9wOig=' \
--header 'm7-timestamp: 1609226863021' \
--header 'content-type: application/json' \
--data-raw '{
    "account": "2100040",
    "agentId": "6008192e58151c00119ab181",
    "label": "测试目录test1",
    "parentId": "0", 
    "level": 1
}'
  • 返回示例
{
    "success":true,
    "message":"200 ok!",
    "data":{
        "catalogId": "4d8a0b5d-b38f-4b81-aca2-728ede0a1fbc"
            }
}
  • 返回参数
字段名称 字段类型 字段描述
catalogId string 目录编号

2.查询知识库目录接口

  • 请求路径 /im-km/openapi/catalog/list
  • 请求参数
字段名称 字段类型 是否必填 字段描述
account string 账户编号
  • 请求示例
curl --location --request POST 'http://v7openapi.7moor.com/im-km/openapi/catalog/list' \
--header 'm7-appkey: 2000100' \
--header 'm7-nonce: 111922' \
--header 'm7-sign: lmwwrahWCRO0x+3DhlMMVgB2V5ytUXp5GxbLTW9wOig=' \
--header 'm7-timestamp: 1609226863021' \
--header 'content-type: application/json' \
--data-raw '{
    "account": "2100040"
}'
  • 返回示例
{
    "success":true,
    "message":"200 ok!",
    "data":{"tree":[{"_id":"4d8a0b5d-b38f-4b81-aca2-728ede0a1fbc","account":"2100040","parentId":"0","label":"测试目录test","level":1,"showDepartmentIds":[],"sortNum":0,"createTime":"2022-02-21 11:19:33","createTimestamp":1645413573892,"updateTime":"2022-02-21 11:19:33","updateTimestamp":1645413573892,"createUser":"6008192e58151c00119ab181","createAgentNumber":"8238","updateUser":"6008192e58151c00119ab181","updateAgentNumber":"8238"}]}} 
  • 返回参数
字段名称 字段类型 字段描述
_id string 目录编号
account string 账户编号
parentId string 上级目录id(一级目录的parentId默认为0)
label string 目录名称
level Number 目录等级
showDepartmentIds String[] 可视部门
sortNum Number 目录序号
createTime string 创建时间
createTimestamp string 创建时间戳
updateTime string 更新时间
updateTimestamp string 更新时间戳
createUser string 创建座席编号
createAgentNumber string 创建座席工号
updateUser string 更新座席编号
updateAgentNumber string 更新座席工号

3.修改知识库目录接口

  • 请求路径 /im-km/openapi/catalog/list
  • 请求参数
字段名称 字段类型 是否必填 字段描述
account string 账户编号
agentId string 座席编号
catalogId string 目录编号
label string 目录名称(不能重复)
level Number 目录等级(如果传一级分类,这个字段默认传1, 二级目录传2,以此类推)
parentId string 上级目录id(一级目录的parentId默认为0, 一级目录id为二级目录的parentId,以此类推)
  • 请求示例
curl --location --request POST 'http://v7openapi.7moor.com/im-km/openapi/catalog/list' \
--header 'm7-appkey: 2000100' \
--header 'm7-nonce: 111922' \
--header 'm7-sign: lmwwrahWCRO0x+3DhlMMVgB2V5ytUXp5GxbLTW9wOig=' \
--header 'm7-timestamp: 1609226863021' \
--header 'content-type: application/json' \
--data-raw '{
    "account": "2100040",
    "agentId": "6008192e58151c00119ab181",
    "label": "测试restapi修改名称",
    "level": 1,
    "parentId": "0",
    "catalogId": "4d8a0b5d-b38f-4b81-aca2-728ede0a1fbc"
}'
  • 返回示例
{"success":true,"message":"200 ok!"}

4.新增知识库知识点接口

  • 请求路径 /im-km/openapi/kmItem/create
  • 请求参数
字段名称 字段类型 是否必填 字段描述
account string 账户编号
agentId string 座席编号
catalogId string 目录编号
title String 知识点标题
content string 知识点内容
validityPeriodType string 有效期类型(永久有效/无效/自定义有效期),
['permanent', 'invalid', 'custom']其中之一, 默认为'permanent'
validityPeriod [ ]String 自定义时间, 和validityPeriodType中custom配合使用
attachs [ ]Object 知识点附件列表, Object格式如下

{ 'url': 'renbao.xls', }|

  • 请求示例
curl --location --request POST 'http://v7openapi.7moor.com/im-km/openapi/kmItem/create' \
--header 'm7-appkey: 2000100' \
--header 'm7-nonce: 111922' \
--header 'm7-sign: lmwwrahWCRO0x+3DhlMMVgB2V5ytUXp5GxbLTW9wOig=' \
--header 'm7-timestamp: 1609226863021' \
--header 'content-type: application/json' \
--data-raw '{
    "account": "2100040",
    "agentId": "6008192e58151c00119ab181",
    "catalogId": "842d28c6-4856-42cc-8cc2-5e56219351d7",
    "title": "知识点名称",
    "content": "知识点内容"
}'
  • 返回示例
{"success":true,"message":"200 ok!","data":{"itemId": "1b1f9fce-be2e-41e5-b146-4f923be55fcf"}}
  • 返回参数
字段名称 字段类型 字段描述
itemId string 知识点编号

5.查询知识库知识点列表接口

  • 请求路径 /im-km/openapi/kmItem/list
  • 请求参数
字段名称 字段类型 是否必填 字段描述
account string 账户编号
agentId string 座席编号
page Number 页码,不传默认为1
limit Number 页面大小,不传默认为10
keywordsType string 匹配标识(仅匹配内容、仅匹配标题、同时匹配标题和内容), ['all', 'title', 'content']其中之一, 默认为 'all'
keywords String 搜索关键字
  • 请求示例
curl --location --request POST 'http://v7openapi.7moor.com/im-km/openapi/kmItem/list' \
--header 'm7-appkey: 2000100' \
--header 'm7-nonce: 111922' \
--header 'm7-sign: lmwwrahWCRO0x+3DhlMMVgB2V5ytUXp5GxbLTW9wOig=' \
--header 'm7-timestamp: 1609226863021' \
--header 'content-type: application/json' \
--data-raw '{
    "account": "2100040",
    "catalogId": "9a6dd1f9-050c-49e4-889e-d116c1e84053"
}'
  • 返回示例
{"success":true,"message":"200 ok!","data":{"list":[{"_id":"1b1f9fce-be2e-41e5-b146-4f923be55fcf","validityPeriod":[],"account":"2100040","catalogId":"9a6dd1f9-050c-49e4-889e-d116c1e84053","title":"知识点名称","hits":0,"attachs":[],"validityPeriodType":"permanent","createTime":"2022-02-21 11:13:53","createTimestamp":1645413233621,"updateTime":"2022-02-21 11:13:53","updateTimestamp":1645413233621,"createUser":"6008192e58151c00119ab181","createAgentNumber":"8238","updateUser":"6008192e58151c00119ab181","updateAgentNumber":"8238","status":"valid"}],"count":1}}  

  • 返回参数
字段名称 字段类型 字段描述
_id string 知识点编号
account string 账户编号
catalogId string 目录编号
title string 知识点名称
hits Number 点击量
validityPeriod String[] 自定义有效期时间
validityPeriodType string 有效期类型(永久有效/无效/自定义)
createTime string 创建时间
createTimestamp string 创建时间戳
updateTime string 更新时间
updateTimestamp string 更新时间戳
createUser string 创建座席编号
createAgentNumber string 创建座席工号
updateUser string 更新座席编号
updateAgentNumber string 更新座席工号
status string 知识点状态(valid, invalid)

6.根据知识点id查询知识点详细内容接口

  • 请求路径 /im-km/openapi/kmItem/show
  • 请求参数
字段名称 字段类型 是否必填 字段描述
itemId string 知识点编号
  • 请求示例
curl --location --request POST 'http://v7openapi.7moor.com/im-km/openapi/kmItem/show' \
--header 'm7-appkey: 2000100' \
--header 'm7-nonce: 111922' \
--header 'm7-sign: lmwwrahWCRO0x+3DhlMMVgB2V5ytUXp5GxbLTW9wOig=' \
--header 'm7-timestamp: 1609226863021' \
--header 'content-type: application/json' \
--data-raw '{
    "itemId": "1b1f9fce-be2e-41e5-b146-4f923be55fcf"
}'
  • 返回示例
{"success":true,"message":"200 ok!","data":{"row":{"_id":"1b1f9fce-be2e-41e5-b146-4f923be55fcf","validityPeriod":[],"account":"2100040","catalogId":"9a6dd1f9-050c-49e4-889e-d116c1e84053","title":"知识点名称","hits":0,"attachs":[],"validityPeriodType":"permanent","createTime":"2022-02-21 11:13:53","createTimestamp":1645413233621,"updateTime":"2022-02-21 11:13:53","updateTimestamp":1645413233621,"createUser":"6008192e58151c00119ab181","createAgentNumber":"8238","updateUser":"6008192e58151c00119ab181","updateAgentNumber":"8238","status":"valid","content":"知识点内容"}}}

  • 返回参数
字段名称 字段类型 字段描述
_id string 知识点编号
account string 账户编号
catalogId string 目录编号
title string 知识点名称
hits Number 点击量
attachs String[] 附件列表
validityPeriod String[] 自定义有效期时间
validityPeriodType string 有效期类型(永久有效/无效/自定义)
createTime string 创建时间
createTimestamp string 创建时间戳
updateTime string 更新时间
updateTimestamp string 更新时间戳
createUser string 创建座席编号
createAgentNumber string 创建座席工号
updateUser string 更新座席编号
updateAgentNumber string 更新座席工号
status string 知识点状态(valid, invalid)
content string 知识点内容

7.修改知识点接口

  • 请求路径 /im-km/openapi/kmItem/update
  • 请求参数
字段名称 字段类型 是否必填 字段描述
account string 账户编号
agentId string 座席编号
catalogId string 目录编号
itemId string 知识点编号
title String 知识点标题
content string 知识点内容
validityPeriodType string 有效期类型(永久有效/无效/自定义有效期),

['permanent', 'invalid', 'custom']其中之一, 默认为'permanent'| |validityPeriod|[ ]String|否|自定义时间, 和validityPeriodType中custom配合使用,类似

["2021-08-01 00:00:00","2021-08-31 00:00:00"]| |attachs|[ ]Object|否|知识点附件列表, Object格式如下

{ 'url': 'renbao.xls', }|

  • 请求示例
curl --location --request POST 'http://v7openapi.7moor.com/im-km/openapi/kmItem/update' \
--header 'm7-appkey: 2000100' \
--header 'm7-nonce: 111922' \
--header 'm7-sign: lmwwrahWCRO0x+3DhlMMVgB2V5ytUXp5GxbLTW9wOig=' \
--header 'm7-timestamp: 1609226863021' \
--header 'content-type: application/json' \
--data-raw '{
    "account": "2100040",
    "agentId": "6008192e58151c00119ab181",
    "catalogId": "9a6dd1f9-050c-49e4-889e-d116c1e84053",
    "itemId": "1b1f9fce-be2e-41e5-b146-4f923be55fcf",
    "title": "知识点名称",
    "content": "知识点内容修改"
}'
  • 返回示例
{"success":true,"message":"200 ok!"}

8.删除知识点接口

  • 请求路径 /im-km/openapi/kmItem/delete
  • 请求参数
字段名称 字段类型 是否必填 字段描述
account string 账户编号
itemIds [ ]String 需要删除的知识点编号列表
- 请求示例
curl --location --request POST 'http://v7openapi.7moor.com/im-km/openapi/kmItem/delete' \
--header 'm7-appkey: 2000100' \
--header 'm7-nonce: 111922' \
--header 'm7-sign: lmwwrahWCRO0x+3DhlMMVgB2V5ytUXp5GxbLTW9wOig=' \
--header 'm7-timestamp: 1609226863021' \
--header 'content-type: application/json' \
--data-raw '{
    "account": "2100040",
    "itemIds": ["1b1f9fce-be2e-41e5-b146-4f923be55fcf"]
}'
  • 返回示例
{"success":true,"message":"200 ok!"}

9.删除目录接口

  • 请求路径 /im-km/openapi/catalog/delete
  • 请求参数
字段名称 字段类型 是否必填 字段描述
account string 账户编号
catalogId String 需要删除的目录编号
- 请求示例
curl --location --request POST 'http://v7openapi.7moor.com/im-km/openapi/catalog/delete' \
--header 'm7-appkey: 2000100' \
--header 'm7-nonce: 111922' \
--header 'm7-sign: lmwwrahWCRO0x+3DhlMMVgB2V5ytUXp5GxbLTW9wOig=' \
--header 'm7-timestamp: 1609226863021' \
--header 'content-type: application/json' \
--data-raw '{
    "account": "2100040",
    "catalogId": "4d8a0b5d-b38f-4b81-aca2-728ede0a1fbc"
}'
  • 返回示例
{"success":true,"message":"200 ok!"}