Querying an Attachment Download Address

Updated on 2023-09-27 GMT+08:00

View PDF

Scenario

This interface is invoked to query an attachment download address.

Method

This interface supports only the POST method.

URI

SIA authentication: https://ip:port/rest/ccikbs/v1/knowledge/download

AK/SK authentication: https://ip:port/rest/ccikbs/v1/knowledge/downloadByAKSK

In the URL, ip and port indicate the machine-machine interface access address of the NSLB server.

Request Description

**Table 1** Request header parameters
No.	Parameter	Type	Mandatory or Not	Default Value	Description
1	Content-Type	String	Yes	None	The value is fixed at application/json;charset=UTF-8 (both authentication modes).
2	X-TenantSpaceID	String	Yes	None	Tenant ID (required for SIA authentication).
3	X-Access-Token	String	Yes	None	For details about the generation mode, see SIA Authentication (required for SIA authentication).
4	Authorization	String	Yes	None	For details about the generation method, see Authentication Mode of Knowledge Base Interfaces (required for AK/SK authentication).

**Table 2** Request body parameters
No.	Parameter	Type	Mandatory or Not	Default Value	Description
1	kngId	String	Yes	None	Knowledge ID. The value is the same as that of AICC_kngId_CST in a data table of the AppCube database. Query the AICC__Ikbs_Kngadjedit__CST, AICC__Ikbs_Columnknghis__CST, or AICC__Ikbs_Kngadjpre__CST table based on the knowledge status.
2	fileKey	String	Yes	None	File ID. The value is the same as that of AICC_adjKey_CST in a data table of the AppCube database. Query the AICC__Ikbs_Kngadjedit__CST, AICC__Ikbs_Columnknghis__CST, or AICC__Ikbs_Kngadjpre__CST table based on the knowledge status.
3	ccId	Number	No	None	Call center ID. This parameter is mandatory for AK/SK authentication.
4	vdn	Number	No	None	VDN ID. This parameter is mandatory for AK/SK authentication.

Response Description

If this interface fails to be called, the corresponding error code is returned. For details about the error code response data structure, see Table 3.

**Table 3** Response body parameters
No.	Parameter	Type	Description
1	resultCode	String	Result code. The options are as follows: 0: success 1: failure
2	description	String	Request result description.
3	data	Object	Request result object. For details, see Table 4.

**Table 4** Object parameters of data
No.	Parameter	Type	Description
1	url	String	OBS address from which the current knowledge attachment can be downloaded.

Example

Request header

Content-Type: application/json;charset=UTF-8
X-TenantSpaceID: ********
Authorization: ******************

Request parameters

{
    "fileKey": "1286999405181796356",
    "kngId": "1286999404577816579"
}

Response parameters

{
    "returnCode": "0",
    "description": "success",
    "url": "https://aicc-develop-lab.obs.cn-north-1.myhuaweicloud.com:443/ccikbs/file/202209065604/9bda03e5-a538-404a-b719-869575b56edd?AccessKeyId=22QW**********B0GF&Expires=1665650432&Signature=tQMT**********pE%3D"
}

Parent topic: Interface Description

Previous topic: Querying the Knowledge List

Next topic: Chatbot Management Interface Reference