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 address:Port number/agentgateway/resource/recordfile/{agentid}/videofiledownloadEx?recordId=xxx&locationId=xxx

If the CC-Gateway is deployed in single-node mode, set IP address to the CC-Gateway server address and Port number to the HTTPS port number of the CC-Gateway server (the default value is 8043). If the CC-Gateway is deployed in cluster mode, set IP address to the NSLB address and Port number to the default value 8043.

For the CC-Gateway port number on the NSLB, log in to any NSLB node as the nslb user and run the ./nslbctl l command to query the port number. In the query result, the following port is opened by the CC-Gateway to third-party systems through the NSLB.

In the SaaS scenario, contact O&M personnel to obtain the values of IP address and Port number.

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).

• Message body

  None

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
• 108-019

Example

• Message header

  Content-Type:application/json; charset=UTF-8
  Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1

• Request parameter

  None

• Response parameter

  {
      "retcode": "000-003",
      "message": "no right to invite resource",
      "result": ""
  }