Controlling the Image Display Mode of a Three-Party Video Call

Prerequisites

• The agent has signed in.
• The agent has an ongoing video call.

  The interface supports the following scenarios:

  • Setting up three-party video calls
  • Initiating an internal help (a three-party video call)
  • Transferring a call to an external number by setting a three-party video call

Description

A video agent changes the three-party video display mode.

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/voicecall/{agentid}/adjustvideomode

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

adjustVideoMode

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 Parameter in the message body

  No.	Parameter	Value Type	Mandatory (Yes/No)	Description
  1	mode	Interger	Yes	Display mode. The value ranges from 0 to 3. The value 0 indicates that images are the same size for all three parties. The value 1 indicates that the user's image is maximized. The value 2 indicates that the agent's image is maximized. The value 3 indicates that the third-party's image is maximized.

Response Description

Error Code

• 200-031
• 200-032
• 200-033
• 200-034
• 200-035

Example

• Message header

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

• Request parameter

  {
      "mode": "0"
  }

• Response parameter

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