Downloading Video Files (Extended)
Prerequisites
- On the CC-Gateway, VIDEO_DOWNLOAD_FLAG and IF_SUPPORT_VIDEO have been set to ON, indicating that the video file download function and video event function have been enabled. The configuration file path is /home/elpis/tomcat/webapps/agentgateway/WEB-INF/config/basic.properties.
- The file server has been mounted to the CC-Gateway.
- The agent has signed in.
- The mount directory is configured in the configuration file.
Description
This interface is used to download video files generated during video calls. (You are not advised to use this interface to download video files larger than 200 MB.)
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}/videofiledownloadEx?recordId=xxx&locationId=xxx
Example:
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 |
Agent ID. The value ranges from 101 to 59999. |
2 |
recordId |
string |
Yes |
Video file path.
NOTE:
If recordId is not specified, the video file corresponding to the first recording URL is downloaded by default. |
3 |
locationId |
int |
No |
Node ID. This parameter is mandatory in CTI Pool mode. |
Method Name in Logs
downloadVideoFileEx
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 video file download interface is invoked.
Error Code
- 108-001
- 104-003
- 104-010
- 108-002
- 108-011
- 108-009
- 108-012
- 108-013
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