Help Center/ Customer Engagement Center/ API Reference/ Monitoring Interface Reference/ Interface Description/ Downloading Inspection Recording Files
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Downloading Inspection Recording Files

Scenario

This interface is invoked to download recording files by call IDs.

If no recording file is found, an error is returned. If there are multiple files, the files are compressed into a ZIP package.

This interface is provided for third-party systems to invoke in the backend.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

Request URL

https://ip:port/rest/cmsapp/v1/openapi/hisindex/downloadRecordFile

In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.

In a non–public cloud environment where the NSLB service is configured, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.

Request Description

Table 1 Parameters in the request header

No.

Parameter

Value Type

Mandatory

Description

1

Content-Type

String

Yes

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

2

Authorization

String

Yes

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

No.

Parameter

Value Type

Mandatory

Description

1

callID

String

Yes

Call SN.

2

workNo

String

No

Agent ID.

3

beginTime

String

No

Call start time.

Format: yyyyMMddHHmmss

4

callerNo

String

No

Calling number.

5

calleeNo

String

No

Called number.

Response Description

Table 3

No.

Parameter

Value Type

Mandatory

Description

1

resultCode

String

Yes

Result code returned for a request. 0: success; other values: failure

2

resultDesc

String

Yes

Request result description.

3

resultData

Object

Yes

Binary data of an inspection recording file.

Note: If the download fails, the three parameters are displayed. If the download is successful, only binary data is returned.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters 
    {
    "callID": "1748587841-77268",
    "workNo": "",
    "beginTime": "",
    "callerNo": "",
    "calleeNo": ""
}
  • Response parameters 
    {
    "resultData": "",
    "resultCode": "1",
    "resultDesc": "Record List is empty"
}
Parent topic: Interface Description