Help Center/ Cognitive Engagement Center/ API Reference/ Recording and CDR Interface Reference/ CDR Download and Recording Playback and Download/ Data Access Interface/ Downloading Indexes of Agent Operation Details
Updated on 2023-09-27 GMT+08:00
View PDF

Downloading Indexes of Agent Operation Details

Description

This interface is invoked to download the .zip package of agent operation detail record indexes (yyyymmdd_ responseId). You can view the agent operation details (yyyymmddhhmmssSSS+Three-digit random number_agentOprInfo.csv) corresponding to each .zip package.

Usage Description

  • Prerequisites
    • Files have been generated at the backend by invoking the interface for generating indexes of agent operation details.
    • You have passed the authorization and obtained the access URL.
  • Usage restrictions

    Developers can only download files under their own accounts. The developer account (appId) must correspond to the data record file name (agentOprInfoFileName).

    The developer account (appId) is contained in the authentication string. For details, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.

Interface Method

POST

URI

https://ip:port/CCFS/resource/ccfs/downloadAgentOprInfoFile

Set ip to the IP address of the server where the CC-FS is installed and port to the HTTPS port number of the CC-FS.

If the request is routed through the NSLB, set ip to the IP address of the NSLB server and port to the HTTPS port number of the CC-FS service mapped on the NSLB.

Request

Table 1 Parameters in the request header

No.

Name

Value Type

Mandatory

Default Value

Description

1

Content-Type

String

Yes

None

The value is fixed to application/json; charset=UTF-8.

2

Authorization

String

Yes

None

For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.
Table 2 request parameters in the request body

No.

Name

Mandatory

Value Type

Default Value

Description

1

version

Yes

String (1–32)

2.0

Protocol version. Currently, the value is fixed to 2.0.
Table 3 msgBody parameters in the request body

No.

Name

Mandatory

Value Type

Default Value

Description

1

agentOprInfoFileName

Yes

String (1–49)

None

Index file name of agent operation details. The name is obtained by invoking the interface for generating indexes of agent operation details.

The value is in yyyyMMdd_{responseId}.zip format.

For example, if the interface for generating indexes of agent operation details has been invoked on 2018-07-02, and if the obtained recording index responseId is 9239cb50a8384bb0ab503441bf08944, the value of this parameter is 20180702_9239cb50a8384bb0ab503441bf089446.zip.

Response

If the interface is successfully invoked, the system obtains the binary data of the file from the HTTP response message to generate a CDR file. The file name extension is .zip. For details about the parameters in the file, see Definitions of CDR and Recording Index Files. In the response message, the value of content-type is Application/Octet-stream;charset=UTF-8.

If the interface fails to be invoked, an error code is returned. For details about the error code data structure, see Table 4. resultData is a reserved field and is left empty by default.

Table 4 Parameters in the response

No.

Name

Value Type

Description

1

resultCode

String

Result code returned. For details, see Error Code Reference.

2

resultDesc

String

Request result description.

3

resultData

Object

Response data.

4

response

Object

Request result object. For details, see Table 5.

This field is reserved for compatibility with earlier versions and is not recommended.
Table 5 Parameters in a response message

No.

Name

Value Type

Description

4.1

version

String (1–32)

Protocol version, for example, 2.0.

4.2

resultCode

String (1–32)

Result code returned. For details, see Error Code Reference.

4.3

resultMsg

String

Request result description.

Example

  • Request header
    POST /CCFS/resource/ccfs/downloadAgentOprInfoFile HTTP/1.1
Authorization: auth-v2/ak/2018-07-02T02:43:08Z/content-length;content-type;host
/ae066c2f5de******************afc161cb7e66f5d
Accept: */*
Host: 10.154.198.164
Content-Type: application/json;charset=UTF-8
Content-Length: 193
  • Request parameters
    {
    "request": {
        "version": "2.0"
    },
    "msgBody": {
        "agentOprInfoFileName": "20180702_9239cb50a8384bb0ab503441bf089446.zip"
    }
}
Parent topic: Data Access Interface