# 查询知识详情接口 #### 场景描述 调用该接口，查询指定知识的详情。 #### 接口方法 该接口仅支持POST方法。 #### 接口URI https://域名/apiaccess/ccikbs/v1/columnkngapi/queryKngDetail，例如域名是service.besclouds.com。 #### 请求说明 表1请求消息头参数说明 | 序号 | 名称 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | Content-Type | String | True | 固定填 application/json;charset=UTF-8（两种鉴权方式都填写）。 | | 2 | x-app-key | string | True | appKey字段，用户标识，请联系运营人员获取appKey。 | | 3 | Authorization | String | True | 鉴权信息， 格式如下所示。 Bearer *Access Token*。 Access Token的生成方式参见[C1 系统配置类接口鉴权方式](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0100.html#ZH-CN_TOPIC_0000002481113506)。 | 表2请求消息体参数说明 | 序号 | 名称 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | coluKngId | String | True | 栏目知识ID。只有普通知识或问答知识的coluKngId可用于查询，请使用根据[查询栏目接口](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0941.html#ZH-CN_TOPIC_0000002513073857)获取coluKngType为2或3的coluKngId。 | | 2 | userName | String | True | 用于在AICC系统中查询知识详情的操作员账号，该账号在AICC侧必须拥有"知识库 \> 知识栏目"和"知识库 \> 知识主页"中至少一个权限。 | | 3 | openType | String | True | 知识打开途径。取值范围： - 1：快捷入口 - 2：搜索 - 3：栏目 - 4：收藏夹 - 5：关联知识 | | 4 | openKng | String | False | openType为5时必填。关联知识ID。 | | 5 | searchRank | String | False | openType为2时必填。检索结果序号。 | | 6 | searchSortType | String | False | openType为2时必填。检索排序方式，取值范围： - hit：命中率 - modifyTime：更新时间 - clickNum：点击量 - bidRankId：竞价排行 | | 7 | searchWord | String | False | openType为2时必填。关键字。 | | 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]。 | 表4data对象参数说明 | 序号 | 名称 | 参数类型 | 说明 | |:---|:---|:---|:---| | 4.1 | relVersionNum | String | 发布版本号。 | | 4.2 | coluType | String | 栏目类型。取值范围： - 1：正常栏目 - 2：历史栏目 (只有栏目知识类型为栏目时才有意义) | | 4.3 | code | String | 栏目编码。为栏目或者知识在栏目知识树上的节点编码。 | | 4.4 | coluKngType | Number | 栏目知识类型。取值范围： - 1：栏目 - 2：普通知识 - 3：问答知识 | | 4.5 | creationTime | Number | 创建时间。 | | 4.6 | releaseTimes | Number | 知识发布次数。 | | 4.7 | orderId | Number | 排序编号。 | | 4.8 | kngStatus | Number | 知识状态。取值范围： - 1：新建 - 2：审核 - 3：发布 - 4：更新 - 5：驳回 | | 4.9 | kngSize | Number | 知识内容的大小。单位为KB。 | | 4.10 | creatorId | String | 创建人工号。 | | 4.11 | modifierId | String | 修改人工号。 | | 4.12 | beyondColuPath | String | 所属栏目路径。首层栏目所属路径为/。 | | 4.13 | coluKngName | String | 栏目知识名称。 | | 4.14 | modifyTime | Number | 修改时间。 | | 4.15 | validEndTime | Number | 有效期结束时间。 | | 4.16 | summaryInfo | String | 概要信息。 | | 4.17 | serviceStatus | Number | 业务状态。取值范围： - 1：普通 - 2：热点 - 3：新业务 - 4：更新业务 - 5：过期 | | 4.18 | clickNum | Number | 点击次数。 | | 4.19 | servicesEndTime | Number | 业务有效期结束时间。 | | 4.20 | keyword | String | 关键字。 | | 4.21 | coluKngId | String | 栏目知识ID。 | | 4.22 | curVersionNum | Number | 当前版本号。 | | 4.23 | validStartTime | Number | 有效期开始时间。 | | 4.24 | displayFlag | Number | 栏目知识展示标志。取值范围： - 0：不展示 - 1：展示 | | 4.25 | kngPath | String | 知识路径。 | | 4.26 | superCode | String | 栏目上级编码。 | | 4.27 | beyondColuId | String | 所属栏目ID。首层栏目的所属栏目ID为0。 | | 4.28 | servicesStartTime | Number | 业务有效期开始时间。 | | 4.29 | partdbId | String | 分区id。 | | 4.30 | tenantId | String | 租户id。 | | 4.31 | creatorName | String | 创建人名称。 | | 4.32 | pre | Object | 上一个知识。参数说明详见[表5] | | 4.33 | next | Object | 下一个知识。参数说明详见[表5] | | 4.34 | kngFiles | List | 附件列表。参数说明详见[表6] | | 4.35 | relaKngs | List | 关联知识列表。参数说明详见[表7] | 表5pre/next对象参数说明 | 序号 | 名称 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | coluKngId | String | 栏目知识id。 | | 2 | coluKngName | String | 栏目知识名称。 | | 3 | coluKngType | Number | 栏目知识类型。取值范围： - 1：栏目 - 2：普通知识 - 3：问答知识 | | 4 | maintenancegroup | String | 可管理该栏目知识的用户群组ID，通过逗号分割。用户群组在AICC配置中心的员工中心菜单下。 | | 5 | browsinggroup | String | 可浏览该栏目知识的用户群组ID，通过逗号分割。用户群组在AICC配置中心的员工中心菜单下。 | | 6 | id | String | 该栏目知识在数据库中存放的索引ID。 | 表6kngFiles对象参数说明 | 序号 | 名称 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | adjKey | String | 附件key。 | | 2 | creationTime | String | 创建时间戳。 | | 3 | orderId | String | 排序编号。 | | 4 | versionNum | Number | 版本号。 | | 5 | adjId | String | 附件ID。 | | 6 | kngId | String | 知识ID。 | | 7 | creatorId | String | 创建人工号。 | | 8 | adjName | String | 附件名称。 | | 9 | adjClass | Number | 附件类别。取值范围： - 1：内置（属于知识的一部分，比如插入到知识内容中的图片、FLASH文件） - 2：外置（上传的知识附件） | | 10 | adjSize | Number | 文件大小。 | | 11 | partdbId | Number | 分区id。 | | 12 | tenantId | String | 租户id。 | | 13 | adjType | String | 附件类型。 | 表7relaKngs对象参数说明 | 序号 | 名称 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | coluKngId | String | 栏目知识ID。 | | 2 | coluKngName | String | 栏目知识名称。 | | 3 | coluKngType | Number | 栏目知识类型。取值范围： - 1：栏目 - 2：普通知识 - 3：问答知识 | | 4 | serviceStatus | Number | 业务状态。取值范围： - 1：普通 - 2：热点 - 3：新业务 - 4：更新业务 - 5：过期 | #### 报文样例 - 请求头 ``` x-app-key: b*************c7b Authorization: Bearer 1fea*************1d6a15 Content-Type: application/json ``` - 请求参数 ``` { "coluKngId": "1286316841328705539", "openType": "1", "openKng": "1286999404577816579" } ``` - 响应参数 ``` { "returnCode": "0", "description": "success", "data": { "coluType": 1, "coluKngType": 2, "orderId": 7, "modifierId": "1659333863849146111", "modifyRemark": "", "modifyTime": 1659426736000, "recycleBinFlag": 0, "summaryInfo": "概要信息", "servicesEndTime": 1662025222000, "keyword": "热点", "coluKngId": "1291062494307024899", "superCode": "001", "beyondColuId": "1290527839128387593", "indexNeedUpdate": "1", "relVersionNum": 1, "code": "001007", "creationTime": 1659426503000, "releaseTimes": 1, "kngStatus": 3, "kngSize": 1, "creatorId": "1659333863849146111", "passProcecWay": 1, "beyondColuPath": "/一级栏目", "coluKngName": "全普通知识", "validEndTime": 1662025227000, "serviceStatus": 2, "kngContent": "

1、产品描述-》AICC 产品描述   中英文
2、特性描述-》AICC 特性描述   中英文
3、AICC-操作指南 (总)  中英文
4、运营配置指南   中英文
5、配置文件   中文
6、数据文件参考   中英文
7、AICC CC-CMS 接口参考   中英文

", "clickNum": 2, "curVersionNum": 1, "validStartTime": 1659346816000, "displayFlag": 1, "kngReleaseWay": 1, "servicesStartTime": 1659346820000, "partdbId": 0, "tenantId": "202208016593", "creatorName": "caoyun0802", "pre": { "coluKngId": "1290628927894585391", "coluKngName": "1123", "coluKngType": 2, "maintenancegroup": "", "browsinggroup": "", "id": "caBE000001ShNiOF0VP6" }, "next": { "coluKngId": "1291066079866519597", "coluKngName": "34567", "coluKngType": 2, "maintenancegroup": "", "browsinggroup": "", "id": "caBE000001TkNiOF0KS8" }, "kngFiles": [ { "adjKey": "ccikbs/file/202208016593/5c105100-a8fe-4244-8920-02185bab58e8", "creationTime": 1659426504000, "orderId": 1, "versionNum": 1, "adjId": "1291062496118964228", "kngId": "1291062494307024899", "creatorId": "1659333863849146111", "adjName": "Content20220729 (1).xlsx", "adjClass": 2, "adjSize": 9146, "partdbId": 0, "tenantId": "202208016593", "adjType": "xlsx" } ], "relaKngs": [ { "coluKngId": "1290612589302120476", "coluKngName": "已采集问答", "coluKngType": 3, "serviceStatus": 2 }, { "coluKngId": "1290628927894585391", "coluKngName": "1123", "coluKngType": 2, "serviceStatus": 1 } ] } } ```