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.

When downloading an audio file:

In the SaaS or OP integration environment, the encoding format of the downloaded recording files is G711.A-law. Use a proper player to play the 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 address:Port number/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

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

recordfiledownloadEx

Request Description

• Message header

  Table 2 Parameters in the request message header

  No.	Parameter	Value Type	Mandatory	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 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

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": ""
  }