文档首页> 云客服> API参考> 知识库管理> 接口说明> 查询知识列表接口
更新时间：2024-05-16 GMT+08:00
查看PDF
分享

查询知识列表接口

场景描述

调用该接口，查询知识列表。

接口方法

该接口仅支持POST方法。

接口URI

SIA鉴权：https://ip:port/rest/ccikbs/v1/columnkngapi/advancedSearch

AKSK鉴权：https://ip:port/rest/ccikbs/v1/columnkngapi/advancedSearchByAKSK

其中，ip、port为NSLB服务器机机接口接入地址。

请求说明

表1 请求消息头参数说明

序号

名称

参数类型

是否必选

默认值

说明

1

Content-Type

String

True

无

固定填 application/json;charset=UTF-8。

2

X-TenantSpaceID

String

True

无

租户id。

3

X-Access-Token

String

True

无

生成方式参见SIA鉴权（SIA鉴权填写）。

4

Authorization

String

True

无

生成方式参见知识库类接口鉴权方式（AKSK鉴权填写）。

5

userId

String

True

无

用户ID。
表2 请求消息体参数说明

序号

名称

参数类型

是否必选

默认值

说明

1

keyword

String

True

无

关键字。

2

offset

Number

True

无

分页查询偏移量，默认值0，即不需要偏移。

3

limit

Number

True

无

分页查询时单页最多的记录条数。

4

code

String

False

无

栏目编码。为栏目或者知识在栏目知识树上的节点编码。

5

coluKngType

String

False

无

栏目知识类型。取值范围：

  • 1：栏目
  • 2：普通知识
  • 3：问答知识

6

startTime

Number

False

无

开始时间。(时间戳)

7

endTime

Number

False

无

结束时间。(时间戳)

8

ccId

Number

False

无

呼叫中心id。AKSK鉴权必填。

9

vdn

Number

False

无

vdnId。AKSK鉴权必填。

响应说明

当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表3。

表3 响应消息体参数说明

序号

名称

参数类型

说明

1

resultCode

String

请求返回的结果码。取值范围：

  • 0为成功
  • 1为失败

2

description

String

请求结果描述。

3

data

Object

请求结果对象，参数说明详见表4
表4 data对象参数说明

序号

名称

参数类型

说明

1

total

String

查询数量。

2

results

List

参数说明详见表5
表5 results对象参数说明

序号

名称

参数类型

说明

1

adjs

String

栏目知识附件。

2

code

String

栏目编码。为栏目或者知识在栏目知识树上的节点编码。

3

coluKngType

String

栏目知识类型。取值范围：

  • 1：栏目
  • 2：普通知识
  • 3：问答知识

4

orderId

String

排序编号。

5

creatorId

String

创建人工号。

6

modifierId

String

修改人工号。

7

creatorName

String

创建人名称。

8

beyondColuPath

String

所属栏目路径。首层栏目所属路径为/。

9

contentInfo

String

知识内容。

10

coluKngName

String

栏目知识名称。

11

modifyTime

Number

修改时间。

12

validEndTime

Number

有效期结束时间。

13

summaryInfo

String

概要信息。

14

serviceStatus

Number

业务状态。取值范围：

  • 1：普通
  • 2：热点
  • 3：新业务
  • 4：更新业务
  • 5：过期

15

clickNum

Number

点击次数。

16

keyword

String

关键字。

17

coluKngId

String

栏目知识id。

18

curVersionNum

Number

当前版本号。

19

validStartTime

Number

有效期开始时间。

20

kngPath

String

知识路径。

21

superCode

String

栏目上级编码。

22

beyondColuId

String

父栏目id。

23

createTime

Number

创建时间。

24

kngAdj

String

栏目知识附件。

25

tenantId

String

租间id。

报文样例

  • 请求头
    Content-Type: application/json;charset=UTF-8
X-TenantSpaceID：********
Authorization: ******************
userId:*******************
  • 请求参数
    {
    "keyword": "001",
    "offset": 0,
    "limit": 10,
    "code": "001",
    "coluKngType": "2",
    "startTime": 1658474893000,
    "endTime": 1658820502000
}
  • 响应参数
    {
    "returnCode": "0",
    "description": "success",
    "data": {
        "total": 1,
        "results": [
            {
                "adjs": null,
                "code": "001004",
                "coluKngType": 2,
                "orderId": 3,
                "creatorId": "1662469040313943431",
                "modifierId": "1662469040313943431",
                "creatorName": "lzd0906003",
                "beyondColuPath": "/lzd0916父栏目",
                "contentInfo": "业务知识 ",
                "coluKngName": "lzd父栏目0916005下的知识<font color = red>001</font color = red>",
                "modifyTime": "20220916153223",
                "validEndTime": "2022-12-16 14:22:34",
                "summaryInfo": "",
                "serviceStatus": 1,
                "clickNum": 0,
                "keyword": "",
                "coluKngId": "342ffe28003147f28b47da7d729d10e5",
                "curVersionNum": 1,
                "validStartTime": "2022-09-16 14:22:34",
                "kngPath": null,
                "superCode": "001",
                "beyondColuId": "63e3e4b42c94482b95e04e911f497fbb",
                "createTime": "2022-09-16 15:32:00",
                "kngAdj": null,
                "tenantId": "202209065604"
            }
        ]
    }
}
父主题： 接口说明
分享：

    相关文档

    相关产品