Starting Playing an Announcement

Prerequisites

• The agent has signed in.
• The agent is not in a call.

Description

This interface is used to start playing an announcement to an agent. (The agent's sign-in number receives a call. After the call is connected, the system plays the recording.)

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 PUT. This interface supports only the PUT method.

URI

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

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

beginPlay

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	voicepath	string	Yes	File path. The value can contain a maximum of 100 characters.
  2	startpostion	long	No	Start position of the file to be played, in seconds.
  3	volumechange	string	No	Playback volume. The default value is 50. A maximum of five digits are allowed.
  4	speedchange	string	No	Playback speed. The default value is 50. A maximum of five digits are allowed.
  5	times	int	No	Number of playback times. The default value is 1. NOTE: If this parameter is set to other values, the default value 1 is used.
  6	codeformat	int	No	File coding format. The default value is 0, which is the only value supported.
  7	locationId	int	No	ID of a distributed call center node. The value of locationId is returned for a recording start event obtained through the polling interface.

Response Description

Triggered Event

• AgentMediaEvent_Play
• AgentMediaEvent_Play_Succ
• AgentMediaEvent_Play_Fail
• AgentMediaEvent_StopPlayDone

Error Code

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

Example

• Message header

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

• Request parameter

  {
      "voicepath": "Y:/1/0/20180621/105/1406470.V3",
      "startpostion": 0,
      "volumechange": 20,
      "speedchange": 20,
      "times": 1,
      "codeformat": 0,
      "locationId": -1
  }

• Response parameter

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