Applying for an Agent Conference

Prerequisites

• The agent has signed in.

Description

This interface is used by an agent to apply for an agent conference. If the interface is successfully invoked, the agent needs to wait for the subsequent asynchronous event. After the application is successful, the agent who applies for the conference becomes the chairperson. The agent who applies for a conference receives the AgentConf_SelfJoinResult event, indicating that the agent has joined the conference. The agent can perform chairperson operations only after the AgentConf_RequestSuccess event is received. Before receiving the AgentConf_RequestSuccess event, the platform directly returns a failure message when the agent invokes conference-related interfaces.

• The current agent is in idle or talking state. If the agent is in a call, the call must be in stable state. Otherwise, the agent fails to apply for a conference. For example, if the agent performs operations such as voice playing, muting, call holding, or hang-up transfer during a call, the conference application fails.
• If there are two agents in a three-party conversation, the called agent cannot initiate an agent conference.
• The participant type can only be agent ID or phone number.
• The number of parties in a conference call must be less than or equal to the maximum number of concurrent voice calls set in the VDN.

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}/requestagentconf

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

requestAgentConf

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	memberNum	int	Yes	Maximum number of participants in a conference. The value ranges from 1 to 120.
  2	confCallerNo	String	No	Calling number displayed when a user is called to join a conference. The maximum length is 24 bytes. If this parameter is not set, the platform uses the system calling number in the basic information about the VDN configuration console by default. If there are restrictions on numbers in the VDN, the value must be within the restriction range.
  3	time	int	No	Applied conference duration. The unit is minute. The value ranges from 4 to 1440. The default value is 60.
  4	promptTime	int	No	Duration after which a conference ends. This parameter is optional. The unit is minute. The value ranges from 3 to 1440. The default value is 3. If the value is greater than or equal to the applied conference duration, the value is the applied conference duration minus 1.
  5	beepTone	boolean	No	Whether to play an announcement when a user joins or leaves a conference. The default value is false.
  6	playMode	int	No	2: Playing a specified voice file. The default value is 2.
  7	voicePath	String	No	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. When BeepTone is set to true, this parameter must be set and playMode must be set to 2. When BeepTone is set to false, this parameter is invalid. The maximum length is 127.

Response Description

Triggered Event

• AgentState_Busy
• AgentOther_PhoneAlerting
• AgentOther_PhoneOffhook
• AgentConf_SelfJoinResult
• AgentConf_RequestSuccess
• AgentConf_RequestFailed
• AgentConf_Timeout

Error Code

• 000-002
• 100-006
• 100-007

Example

• Message header

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

• Request parameter

  {
      "memberNum": 4,
      "confCallerNo": "10000",
      "time": 50,
      "promptTime": 5,
      "beepTone": true,
      "playMode": 2,
      "voicePath": "y:/conf/120/1136287.V3"
  }

• Response parameter

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