Making a Three-Party Call

Prerequisites

• The agent has signed in.
• The agent has established a call.
• The agent is holding a call.

Description

This interface is used by an agent to make a three-party call based on an ongoing call or a held call.

Interface Method

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

URI

https://ip:port/agentgateway/resource/voicecall/{agentid}/confjoin

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

confJoin

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	callid	string	Yes	Indicates the ID of the call that the agent is holding. It cannot be blank.
  2	callappdata	string	No	Call-associated data to be configured. It can be left empty. The maximum value is 16 KB.

Response Description

Triggered Event

• AgentEvent_Conference
• AgentEvent_Customer_Release

Error Code

• 100-006
• 100-007
• 200-010
• 200-011

Example

• Message header

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

• Request parameter

  {
      "callid": "1455885056-1095",
      "callappdata": ""
  }

• Response parameter

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