Playing Network Call Recordings

Prerequisites

• A network call center has been enabled.
• The agent has signed in.
• The agent is not in a three-party call.

Description

In the network call scenario, the system starts to play voices to an agent. (After the agent sign-in number receives a call, the system plays the recording after the call is connected.)

Any recording file can be played by using this interface. Therefore, use this interface with caution in secondary development.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

URI

https://ip:port/agentgateway/resource/recordplay/{agentid}/netplay

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.

Method Name in Logs

beginNetPlay

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

  Table 3 Parameters in the message body

  No.	Parameter	Value Type	Mandatory (Yes/No)	Description
  1	fileName	string	Yes	File path. The value can contain a maximum of 100 characters.
  2	position	long	No	Position where the playback starts, in seconds.
  3	playTime	int	No	Number of playback times. The options are as follows: 1: play once. 0: infinite loop. The default value is 1. NOTE: If this parameter is set to other values, the default value 1 is used.
  4	fileFormat	int	No	File encoding format. The options are as follows: 0: default format configured on the resource side. 1: 24K VOX format. 2: 32K VOX format. The default value is 0.
  5	ccId	int	Yes	ID of the call center where an announcement file is located. To obtain the ID, log in to the WAS and choose Web Configuration Console > Configure NIRC > CCS Type Client > Client ID.
  6	locationId	int	No	ID of a distributed node, which is an input parameter. This parameter is valid only when a single UAP is deployed and the platform supports the distributed mode. The value ranges from 0 to 65535.

Response Description

Triggered Event

• AgentMediaEvent_Play
• AgentMediaEvent_Play_Succ
• AgentMediaEvent_Play_Fail
• AgentMediaEvent_StopPlayDone

Error Code

• 100-006
• 100-007
• 100-018
• 500-007

Example

• Message header

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

• Request parameter

  {
      "fileName": "Y:/12/0/20211019/155/1406470.V3",
      "position": "0",
      "playTime": "1",
      "fileFormat": "0",
      "ccId": "1",
      "locationId": "-1"
  }

• Response parameter

  {
    "result": {},
    "message": "success",
    "retcode": "0"
  }