1新增知识库目录接口

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20210827/km/addCatalog/{ACCOUNTID}?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

请求参数:

字段 类型 是否必须 参数说明
name string 目录名称
pid String 上级目录id(传"0"表示创建顶级目录)
order number 目录排序(传0表示默认顺序,值越大,位置越高)
kmType String 知识库类型(限制传"inner"表示内部知识库,传"outer"表示外部知识库)
showDepartment array[string] 可见部门id列表(不传则全部人可见)
showAgents array[string] 可见坐席id列表(不传则全部人可见)

其他限制条件: pid传送错误时(非"0" 或 上级pid不存在),返回报错 创建目录层级超出时,返回报错(内部知识库3层,外部知识库1层) 同一层级目录下,目录名称不可重复

请求体示例

{
    "name":"接口新增知识库顶级目录",
    "pid":"0",
    "order":0,
    "kmType":"inner",
    "showDepartment":"",
    "showAgents":""
}

返回参数

参数名称 参数类型 参数说明
success Boolean 接口调用成功与否
message string 接口提示信息
code number 接口返回值
_id string 当前新增目录的id

返回示例

{
 "code": 200,
    "success": true,
    "message": "200 OK",
    "_id": "9aa97670-a4f6-11ec-bbe5-ef9a1a1c7d87"
}

2查询知识库目录接口

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20210827/km/queryCatalogList/{ACCOUNTID}?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

请求参数:

字段 类型 是否必须 参数说明
kmType string 知识库类型(限制传"inner"表示内部知识库,传"outer"表示外部知识库)

其他限制条件: pid传送错误时(非"0" 或 上级pid不存在),返回报错 创建目录层级超出时,返回报错(内部知识库3层,外部知识库1层) 同一层级目录下,目录名称不可重复

请求体示例

{
    "kmType":"inner"
}

返回参数

参数名称 参数类型 参数说明
success Boolean 接口调用成功与否
message string 接口提示信息
code number 接口返回值
tree Array 目录树

返回示例

{
    "code": 200,
    "success": true,
    "message": "200 OK",
    "tree": [
        {
            "_id": "4ae87570-a177-11ea-b174-7f2e1dccb991",
            "name": "1",
            "pid": "0",
            "order": 7,
            "kmType": "inner",
            "accountId": "T00000001849",
            "childs": [
                {
                    "_id": "5b50f430-a361-11ec-8a66-11c2274b04f7",
                    "name": "2",
                    "pid": "4ae87570-a177-11ea-b174-7f2e1dccb991",
                    "order": 0,
                    "kmType": "inner",
                    "accountId": "T00000001849",
                    "childs": []
                }
            ]
        },
        {
            "_id": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "name": "大米",
            "pid": "0",
            "order": 6,
            "kmType": "inner",
            "accountId": "T00000001849",
            "childs": []
        },
        {
            "_id": "70a17180-8c46-11eb-b534-9338639c75e6",
            "name": "中卡科技被接口修改",
            "pid": "0",
            "order": 1,
            "kmType": "inner",
            "accountId": "T00000001849",
            "childs": []
        },
        {
            "_id": "9aa97670-a4f6-11ec-bbe5-ef9a1a1c7d87",
            "accountId": "T00000001849",
            "order": 0,
            "name": "接口新增知识库顶级目录",
            "pid": "0",
            "kmType": "inner",
            "childs": []
        }
    ]
}

3修改知识库目录接口

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20210827/km/updateCatalog/{ACCOUNTID}?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

请求参数:

字段 类型 是否必须 参数说明
_id string 目录_id
name string 目录名称
pid String 上级目录id(传"0"表示创建顶级目录)
order number 目录排序(传0表示默认顺序,值越大,位置越高)
kmType String 知识库类型(限制传"inner"表示内部知识库,传"outer"表示外部知识库)
showDepartment array[string] 可见部门id列表(不传则全部人可见)
showAgents array[string] 可见坐席id列表(不传则全部人可见)

其他限制条件:

pid传送错误时(非"0" 或 上级pid不存在),返回报错 修改目录层级超出时,返回报错(内部知识库3层,外部知识库1层) 同一层级目录下,目录名称不可重复 上送目录pid出现循环时 报错 上送_id不存在时,报错 需要注意上行层级没超过 下行层级超过3层的情况 TODO

请求体示例

{
     "_id":"70a17180-8c46-11eb-b534-9338639c75e6",
    "kmType":"inner",
    "name":"中卡科技被接口修改",
    "order":0,
    "pid":"0",
    "showAgents":"",
    "showDepartment":""
}

返回参数

参数名称 参数类型 参数说明
success Boolean 接口调用成功与否
message string 接口提示信息
code number 接口返回值
_id string 当前新增目录的id

返回示例

{
 "code": 200,
    "success": true,
    "message": "200 OK",
    "_id": "70a17180-8c46-11eb-b534-9338639c75e6"
}

4新增知识库知识点接口

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20210827/km/saveItem/{ACCOUNTID}?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

请求参数:

字段 类型 是否必须 参数说明
title string 知识点标题
content string 知识点内容
cid String 关联目录id
kmType string 知识库类型(限制传"inner"表示内部知识库,传"outer"表示外部知识库)

其他限制条件:

查询关联目录id 未找到时报错

请求体示例

{
    "title":"接口新增知识点2",
    "content":"李教授",
    "cid":"06b8e340-99e6-11eb-94ae-69cfbd77255f",
    "kmType":"inner"
}

返回参数

参数名称 参数类型 参数说明
success Boolean 接口调用成功与否
message string 接口提示信息
code number 接口返回值
_id string 知识点id

返回示例

{
    "code": 200,
    "success": true,
    "message": "200 OK",
    "_id": "a3801e50-a4f8-11ec-9e00-c3a404439a27"
}

5查询知识库知识点接口

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20210827/km/queryKmDic/{ACCOUNTID}?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

请求参数:

字段 类型 是否必须 参数说明
key string 搜索关键字
kmType string 知识库类型(限制传"inner"表示内部知识库,传"outer"表示外部知识库)
cid String 目录id,在哪个目录下面检索
page number 页数(默认1)
limit number 单页查询几个(默认10)

其他限制条件:

查询关联目录id 未找到时返回空list 查询返回默认一页10条,需要自行根据返回的count进行翻页

请求体示例

{
    "key":"李教授",
    "kmType":"inner",
    "cid":"06b8e340-99e6-11eb-94ae-69cfbd77255f",
    "page":1,
    "limit":10
}

返回参数

参数名称 参数类型 参数说明
success Boolean 接口调用成功与否
message string 接口提示信息
code number 接口返回值
count number 查询结果总数
list array 知识点查询结果

返回示例

{
    "code": 200,
    "success": true,
    "message": "200 OK",
    "list": [
        {
            "_id": "a3801e50-a4f8-11ec-9e00-c3a404439a27",
            "accountId": "T00000001849",
            "title": "接口新增知识点2",
            "content": "教授",
            "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "lastTime": "2022-03-16 15:13:54",
            "kmType": "inner",
            "titleText": "接口新增知识点2",
            "contentTxt": "教授姓李"
        },
        {
            "_id": "a3a7af30-a366-11ec-914e-3942fe9fe1d0",
            "accountId": "T00000001849",
            "title": "接口新增知识点2",
            "content": "教授",
            "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "lastTime": "2022-03-14 15:16:16",
            "kmType": "inner",
            "titleText": "接口新增知识点2",
            "contentTxt": "教授姓李"
        },
        {
            "_id": "8c29bce0-a366-11ec-a3ba-11dca25c845d",
            "accountId": "T00000001849",
            "title": "接口新增知识点2",
            "content": "教授",
            "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "lastTime": "2022-03-14 15:15:37",
            "kmType": "inner",
            "titleText": "接口新增知识点2",
            "contentTxt": "教授姓李"
        }
    ],
    "count": 3
}

6查询知识点详细内容

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20210827/km/showItemEdit/{ACCOUNTID}?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

请求参数:

字段 类型 是否必须 参数说明
_id string 知识点id
kmType string 知识库类型(限制传"inner"表示内部知识库,传"outer"表示外部知识库)

请求体示例

{
    "_id":"a3a7af30-a366-11ec-914e-3942fe9fe1d0",
    "kmType":"inner"
}

返回参数

参数名称 参数类型 参数说明
success Boolean 接口调用成功与否
message string 接口提示信息
code number 接口返回值
count number 查询结果总数
list array 知识点查询结果

返回示例

{
    "code": 200,
    "success": true,
    "message": "200 OK",
    "row": {
        "_id": "a3a7af30-a366-11ec-914e-3942fe9fe1d0",
        "title": "接口新增知识点2",
        "kmType": "inner",
        "attachs": {},
        "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
        "accountId": "T00000001849",
        "publisher": "6d26bc20-4f04-11ea-8fd5-737675e52f77",
        "lastTime": "2022-03-14 15:16:16",
        "createTime": "2022-03-14 15:16:16",
        "hits": 1,
        "content": "
这是测试
",
        "catalog": {
            "_id": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "name": "大米",
            "pid": "0",
            "order": 7,
            "kmType": "inner",
            "accountId": "T00000001849"
        }
    }
}

7获取知识点列表接口

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20210827/km/queryItemList/{ACCOUNTID}?sig=sig

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

请求参数:

字段 类型 是否必须 参数说明
cid string 关联目录id
kmType string 知识库类型(限制传"inner"表示内部知识库,传"outer"表示外部知识库)
page number 页数(默认1)
limit number 单页查询几个(默认10)

请求体示例

{
    "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
    "kmType": "inner",
    "page": 1,
    "limit": 10
}

返回参数

参数名称 参数类型 参数说明
success Boolean 接口调用成功与否
message string 接口提示信息
code number 接口返回值
count number 查询结果总数
list array 知识点查询结果

返回示例

{
    "code": 200,
    "success": true,
    "message": "200 OK",
    "count": 6,
    "list": [
        {
            "_id": "a3801e50-a4f8-11ec-9e00-c3a404439a27",
            "title": "接口新增知识点2",
            "kmType": "inner",
            "attachs": {},
            "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "accountId": "T00000001849",
            "publisher": "restApi",
            "lastTime": "2022-03-16 15:13:54",
            "createTime": "2022-03-16 15:13:54",
            "hits": 0
        },
        {
            "_id": "9c2bbb10-ca78-11eb-8e02-e10948366fc5",
            "title": "用户案例",
            "kmType": "inner",
            "attachs": {},
            "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "accountId": "T00000001849",
            "publisher": "6d26bc20-4f04-11ea-8fd5-737675e52f77",
            "lastTime": "2022-03-14 16:16:22",
            "createTime": "2021-06-11 13:48:12",
            "hits": 0,
            "updateUser": "restApi"
        },
        {
            "_id": "a3a7af30-a366-11ec-914e-3942fe9fe1d0",
            "title": "接口新增知识点2",
            "kmType": "inner",
            "attachs": {},
            "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "accountId": "T00000001849",
            "publisher": "6d26bc20-4f04-11ea-8fd5-737675e52f77",
            "lastTime": "2022-03-14 15:16:16",
            "createTime": "2022-03-14 15:16:16",
            "hits": 1
        },
        {
            "_id": "8c29bce0-a366-11ec-a3ba-11dca25c845d",
            "title": "接口新增知识点2",
            "kmType": "inner",
            "attachs": {},
            "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "accountId": "T00000001849",
            "publisher": "restApi",
            "lastTime": "2022-03-14 15:15:37",
            "createTime": "2022-03-14 15:15:37",
            "hits": 1
        },
        {
            "_id": "266c1f40-99e6-11eb-8e79-6f9075586953",
            "title": "大米产品喷码有两种形式",
            "kmType": "inner",
            "attachs": {},
            "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "accountId": "T00000001849",
            "publisher": "cb546670-0ad5-11eb-b16c-afcf8c038d5e",
            "lastTime": "2021-04-10 18:18:53",
            "createTime": "2021-04-10 18:18:53",
            "hits": 0
        },
        {
            "_id": "17212cb0-99e6-11eb-8f0f-35bd2516410a",
            "title": "产品标签",
            "kmType": "inner",
            "attachs": {},
            "cid": "06b8e340-99e6-11eb-94ae-69cfbd77255f",
            "accountId": "T00000001849",
            "publisher": "cb546670-0ad5-11eb-b16c-afcf8c038d5e",
            "lastTime": "2021-04-10 18:18:27",
            "createTime": "2021-04-10 18:18:27",
            "hits": 0
        }
    ]
}

8修改知识点

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20210827/km/updateItem/{ACCOUNTID}?sig=sig

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

请求参数:

字段 类型 是否必须 参数说明
_id string 知识点id
title string 知识点标题
content string 是/td> 知识点内容
kmType string 知识库类型(限制传"inner"表示内部知识库,传"outer"表示外部知识库)
cid string 是/td> 关联目录id

请求体示例

{

    "_id": "feda0c50-a365-11ec-bb49-2b7d07054918",
    "title": "用户案例11",
    "content": "用户案例内容",
    "kmType": "inner",
    "cid": "70a17180-8c46-11eb-b534-9338639c75e6"

}

返回参数

参数名称 参数类型 参数说明
success Boolean 接口调用成功与否
message string 接口提示信息
code number 接口返回值
_id string 知识点id

返回示例

{
    "code": 200,
    "success": true,
    "message": "200 OK",
    "_id": "feda0c50-a365-11ec-bb49-2b7d07054918"
}

9删除知识点

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20210827/km/delItem/{ACCOUNTID}?sig=sig

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

请求参数:

字段 类型 是否必须 参数说明
_id string 知识点id
kmType string 知识库类型(限制传"inner"表示内部知识库,传"outer"表示外部知识库)

请求体示例

{
    "_id": "feda0c50-a365-11ec-bb49-2b7d07054918",
    "kmType": "inner"
}

返回参数

参数名称 参数类型 参数说明
success Boolean 接口调用成功与否
message string 接口提示信息
code number 接口返回值

返回示例

{
    "code": 200,
    "success": true,
    "message": "200 OK"
}

10删除目录接口

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20210827/km/delCatalog/{ACCOUNTID}?sig=sig

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

请求参数:

字段 类型 是否必须 参数说明
_id string 知识点id
kmType string 知识库类型(限制传"inner"表示内部知识库,传"outer"表示外部知识库)

请求体示例

{
    "_id":"9aa97670-a4f6-11ec-bbe5-ef9a1a1c7d87",
    "kmType":"inner"
}

返回参数

参数名称 参数类型 参数说明
success Boolean 接口调用成功与否
message string 接口提示信息
code number 接口返回值
count number 查询结果总数
list array 知识点查询结果

返回示例

{
    "code": 200,
    "success": true,
    "message": "200 OK"
}