云客服-查询知识详情接口:响应说明

时间：2024-09-24 14:46:28

云客服接口说明

响应说明

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

表3 响应消息体参数说明
序号	名称	参数类型	说明
1	resultCode	String	请求返回的结果码。取值范围： 0为成功。 1为失败。
2	description	String	请求结果描述。
3	data	Object	请求结果对象，参数说明详见表4

表4 data对象参数说明
序号	名称	参数类型	说明
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	kngContent	String	知识内容。
4.35	kngFiles	List	附件列表。参数说明详见表6
4.36	relaKngs	List	关联知识列表。参数说明详见表7

表5 pre/next对象参数说明
序号	名称	参数类型	说明
1	coluKngId	String	栏目知识id。
2	coluKngName	String	栏目知识名称。
3	coluKngType	Number	栏目知识类型。取值范围： 1：栏目 2：普通知识 3：问答知识

表6 kngFiles对象参数说明
序号	名称	参数类型	说明
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	附件类型。

表7 relaKngs对象参数说明
序号	名称	参数类型	说明
1	coluKngId	String	栏目知识id。
2	coluKngName	String	栏目知识名称。
3	coluKngType	Number	栏目知识类型。取值范围： 1：栏目 2：普通知识 3：问答知识
4	serviceStatus	Number	业务状态。取值范围： 1：普通 2：热点 3：新业务 4：更新业务 5：过期