Downloading an Intelligent IVR Recording File

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

View PDF

Description

This interface is invoked to download an intelligent IVR recording file.

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 intelligent IVR recording file name (fileName).

Interface Method

POST

URI

https://ip:port/CCFS/resource/ccfs/downloadOiapRecord?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
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–127)	Yes	None	Name of an intelligent IVR recording file. Parameter format: 1: {Recording drive letter}:/{record}/{VDN ID}/{odfsrecord}/{yyyymmdd}/{Main file name}.wav Example: Y:/record/39/odfsrecord/20201015/10233946082696733.wav 2: {Recording drive letter}:/{VDN ID}/{odfsrecord}/{yyyymmdd}/{Main file name}.wav Example: Y:/39/odfsrecord/20201015/10233946082696733.wav 3: {Recording drive letter}:/{record}/{VDN ID}/{yyyymmdd}/{Main file name}.wav Example: Y:/record/39/20201015/10233946082696733.wav 4: {Recording drive letter}:/{VDN ID}/{transferrecord}/{yyyymmdd}/{Main file name}.wav Example: Y:/39/transferrecord/20201015/10233946082696733.wav Note: {VDN ID} indicates the VDN ID, {yyyymmdd} indicates the date when the intelligent IVR recording file is generated, and {Main file name} indicates the name of the recording file.

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 Table 5. 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.
4	response	Object	Request result object. For details, see Table 6. This field is reserved for compatibility with earlier versions and is not recommended.

**Table 6** 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/downloadOiapRecordHTTP/1.1
Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/
eb453f68e******************96c509c4913
Accept: */*
Content-Type: application/json;charset=UTF-8
Content-Length: 193

Request parameters

{
    "request": {
        "version": "2.0"
    },
    "msgBody": {
        "fileName": "Y:/39/odfsrecord/20201019/1603089033-1205143033.wav"
    }
}

Parent topic: Data Access Interface

Previous topic: Playing Back a Recording File

Next topic: Downloading IVR Voice Messages

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot