Playing an Announcement in an Agent Conference Channel

Prerequisites

• The agent has signed in.
• The current agent is the conference chairperson.

Description

This interface is used to play voices in a conference call (that is, play voices to specified users). Only the chairperson has the permission to play voices in a conference call.

Interface Method

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

URI

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/playvoicetoparticipant

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

playVoiceToParticipant

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	addressType	String	Yes	Address type. 6: phone number 9: agent ID
  2	address	String	Yes	Address ID. The maximum length is 24 bytes.
  3	playMode	Integer	No	Mode for playing an announcement. The value 2 indicates that a specified announcement file is played. The default value is 2.
  4	voicePath	voicePath	Yes	Absolute file path. The value is in the format of Drive letter/conf/VCC ID/Announcement file name, for example, y:/conf/120/1136287.V3. The value can contain a maximum of 127 characters.

Response Description

Triggered Event

• AgentConf_StopParticipantVoice

Error Code

• 000-002
• 100-006
• 100-007
• 101-001
• 101-002

Example

• Message header

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

• Request parameter

  {
      "address": "2002",
      "addressType": "9",
      "playMode": 2,
      "voicePath": "y:/conf/120/1136287.V3"
  }

• Response parameter

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