Playing an Announcement in an Agent Conference

Prerequisites

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

Description

This interface is used by a chairperson to play an announcement in a conference. Only chairpersons have the permission to play an announcement in a conference.

Interface Method

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

URI

https://ip:port/agentgateway/resource/agentconf/{agentid}/playvoicetoconf

In the URL, ip indicates the IP address of the agent gateway server, and port indicates the HTTPS port number of the agent gateway server.

Method Name in Logs

playVoiceToConf

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	playType	int	No	Announcement playing type. The options are as follows: 0: The conference foreground announcement is played. 1: The conference background announcement is played. The default value is 0.
  2	playMode	int	No	Mode for playing an announcement. The value 2 indicates that a specified announcement file is played. The default value is 2.
  3	voicePath	String	Yes	Absolute file path. The value is in the format of Drive letter/conf/VDN 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_StopVoice

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

  {
      "playType": 0,
      "playMode": 2,
      "voicePath": "y:/conf/120/1136287.V3"
  }

• Response parameter

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