Downloading Recordings
Prerequisites
- The file server has been mounted to the gateway, and the recording download function has been enabled.
- The mapping has been configured for the CC-Gateway.
- The mount directory is configured in the configuration file.
- The agent has signed in.
Description
This interface is used to download recording files from the file server. (You are not advised to use this interface to download recording files larger than 30 MB.)
The downloaded data contains personal data. Exercise caution when processing the downloaded data to prevent personal data leakage and abuse.
Interface Method
The request method must be set to GET. This interface supports only the GET method.
URI
https://ip:port/agentgateway/resource/recordfile/{agentid}?recordId= xxx&filetype=1
Example: https://ip:port/agentgateway/resource/recordfile/102?recordId=y:\1\0\20181217\120\1524488.V3
In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.
No. |
Parameter |
Value Type |
Mandatory (Yes/No) |
Description |
---|---|---|---|---|
1 |
agentid |
String |
Yes |
ID of the agent who signs in. |
2 |
recordId |
String |
Yes |
Path and name of a recording file. The path and name of the recording file are generated when AgentMediaEvent_Record is triggered and are returned in fileName. For details about the recording file path format, see the following description. |
3 |
filetype |
String |
No |
Type of a recording file. The options are as follows:
NOTE:
1. The format of the path of an IVR voice message recording file is as follows: Drive letter:/VDN ID/record/****. Example: y:/1/record/20190412/playvoice1551276018824.wav 2. The format of the path of a third-party voice message recording file is as follows: Drive letter:/3rdfile/VDN ID/record/****. Example: y:/3rdfile/1/record/20190408/515/1633022.V3 The default value is 1 (agent call recording file). |
4 |
locationId |
Number |
No |
Node ID, which is mandatory in CTI pool mode and is generated when AgentMediaEvent_Record is triggered. |
Method Name in Logs
downloadRecordFile
Request Description
- Message header
Table 2 Parameters in the request message header No.
Parameter
Value Type
Mandatory (Yes/No)
Description
1
Content-Type
String
Yes
Coding mode of the message body. The default value is application/json; charset=UTF-8.
2
Guid
String
Yes
GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).
Response Description
The following provides an example of the response message body of this interface:
- If the download fails:
Message header: Content-Type: application/json;charset=UTF-8
For details about the message body example, see Example.
Table 3 Parameters in the message body No.
Parameter
Value Type
Description
1
message
String
Description.
2
retcode
String
Error code. The options are as follows:
0: success
Other values: failure
3
result
Object
Reserved field.
- If the download is successful:
Message header: Content-Type: application/octet-stream;charset=utf-8
Message body: file stream
Triggered Event
After an agent signs in, the recording download interface is invoked.
Error Code
- 104-001
- 104-005
- 104-010
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot