Help Center/ Cognitive Engagement Center/ API Reference/ Recording and CDR Interface Reference/ CDR Download and Recording Playback and Download/ Data Access Interface/ Downloading IVR Voice Messages
Updated on 2023-09-27 GMT+08:00
View PDF

Downloading IVR Voice Messages

Description

This interface is invoked to download a recording file of IVR voice messages.

Usage Description

  • Prerequisites
    • You have passed the authorization and obtained the access URL.
  • Usage restrictions

    Developers can download only files under their own accounts. The VDN ID corresponding to the developer account (appId) must contain the VDN ID in the recording file name (fileName) of IVR voice messages.

Interface Method

POST

URI

https://ip:port/CCFS/resource/ccfs/downloadIVRRecordFile?locationId={locationId}

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.

Table 1 Parameters in the URL

No.

Name

Value Type

Mandatory

Description

1

locationId

Integer

No

Node ID. The value can be obtained using the session record query interface https://IP:PORT/oifde/rest/api/queryRecordHistory.

Request

Table 2 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 3 request parameters in the request body

No.

Name

Value Type

Mandatory

Default Value

Description

1

version

String (1–32)

Yes

2.0

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

No.

Name

Value Type

Mandatory

Default Value

Description

1

fileName

String (1–225)

Yes

None

Recording file name of IVR voice messages.

Parameter format: {Recording drive letter}:/{VDN ID}/record/{yyyymmdd}/{Main file name}.wav

Example: Y:/39/record/20201015/10233946082696733.wav

Note: {VDN ID} indicates the VDN ID, {yyyymmdd} indicates the date when the recording file of IVR voice messages is generated, and {Main file name} indicates the name of the recording file. The directory after {VDN ID} must be the value of the system parameter Directory next to vdnId in IVR message recording files. Contact the system administrator to obtain the value of the system parameter in Configuration Center > System Management > System Parameter Configuration > System parameters > File storage service > Path Configuration > Directory next to vdnId in IVR message recording files. The default value is record.

Response

If the interface is successfully invoked, the system obtains the binary data of the file from the HTTP response message to generate a recording file. The file name extension is .wav. 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 the following table. resultData is a reserved field and is left empty by default.

Table 5 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.

Example

  • Request header
    POST /CCFS/resource/ccfs/downloadRecordFile HTTP/1.1
Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/
eb453f68e858******************196c509c4913
Accept: */*
Content-Type: application/json;charset=UTF-8
Content-Length: 193
  • Request parameters
    {
    "request": {
        "version": "2.0"
    },
    "msgBody": {
        "fileName": "Y:/39/record/20201015/10233946082696733.wav"
    }
}
Parent topic: Data Access Interface