文档首页/ 云客服/ API参考/ 知识库管理/ 接口说明/ 查询栏目接口
更新时间：2023-09-27 GMT+08:00
查看PDF

查询栏目接口

场景描述

调用该接口，查询栏目信息。

接口方法

该接口仅支持POST方法。

接口URI

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

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

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

请求说明

表1 请求消息头参数说明

序号

名称

参数类型

是否必选

默认值

说明

1

Content-Type

String

True

无

固定填 application/json;charset=UTF-8（两种鉴权方式都填写）。

2

X-TenantSpaceID

String

True

无

租户id（SIA鉴权填写）。

3

X-Access-Token

String

True

无

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

4

Authorization

String

True

无

生成方式参见知识库类接口鉴权方式（AKSK鉴权填写）。
表2 请求消息体参数说明

序号

名称

参数类型

是否必选

默认值

说明

1

beyondColuId

String

True

无

所属栏目ID。首层栏目的所属栏目ID为0

2

ccId

Number

False

无

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

3

vdn

Number

False

无

vdnId。AKSK鉴权必填。

响应说明

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

表3 响应消息体参数说明

序号

名称

参数类型

说明

1

resultCode

String

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

  • 0为成功
  • 1为失败

2

description

String

请求结果描述。

3

datas

List

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

序号

名称

参数类型

说明

1

coluKngId

String

栏目知识id。

2

coluKngName

String

栏目知识名称。

3

coluKngType

String

栏目知识类型。

4

beyondColuId

Number

所属栏目ID。首层栏目的所属栏目ID为0

5

beyondColuPath

Number

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

6

coluType

Number

栏目类型。

7

code

Number

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

8

superCode

Number

栏目上级编码。

9

id

String

AppCube id。

报文样例

  • 请求头
    Content-Type: application/json;charset=UTF-8
X-TenantSpaceID：********
Authorization: ******************
  • 请求参数
    {
    "beyondColuId": "0"
}
  • 响应参数
    {
    "returnCode": "0",
    "description": "success",
    "datas": [
        {
            "coluKngName": "lzd0916父栏目",
            "code": "001",
            "coluType": 1,
            "coluKngType": 1,
            "superCode": "-1",
            "id": "caBE000000wqY7oYeYPA",
            "beyondColuId": "0",
            "beyondColuPath": "/",
            "coluKngId": "63e3e4b42c94482b95e04e911f497fbb"
        }
    ]
}
父主题： 接口说明