Downloading Recordings (Extended)
Prerequisites
- The download function has been enabled for the CC-Gateway. (VIDEO_DOWNLOAD_FLAG has been set to ON. The configuration file path is /home/elpis/tomcat/webapps/agentgateway/WEB-INF/config/basic.properties.)
- The agent has signed in.
- The VoiceCyber recording mode is enabled. (All SRS-related configurations are enabled. The configuration file path is /home/elpis/tomcat/webapps/agentgateway/WEB-INF/config/basic.properties.) For details, see "Commissioning Guide > (Optional) Commissioning Advanced Businesses > Commissioning the Connection Between the CC-Gateway and VoiceCyber Recording Server" in the product documentation.
Description
This interface is used to download recorded voice and video files in VoiceCyber recording mode. It can download voice dual-track recording files and video recording files.
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}/recordfiledownloadEx?callId= xxx&hwFileName=1
Example: https://10.244.154.23:8043/agentgateway/resource/recordfile/4977/recordfiledownloadEx?callId=1621413752-2011&hwFileName=Y:/90/0/20210519/4977/1642329.mp4
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 |
callId |
String |
Yes |
Call ID. |
3 |
hwFileName |
String |
No |
File path. If the value of hwFileName is not transferred, an audio file is downloaded. If hwFileName is specified, a video file is downloaded, for example, Y:/90/0/20210519/4977/1642329.mp4. |
4 |
workNo |
String |
No |
ID of an inspected agent. This parameter must be transferred when the sign-in agent is an inspector and hwFileName is empty. |
Method Name in Logs
recordfiledownloadEx
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 describes the response 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
- The agent signs in and invokes the recording download interface.
Error Code
- 108-001
- 108-014
- 108-015
- 108-016
- 108-017
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