Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Control/ Call Control Interfaces: voicecall/ Controlling the Image Display Mode of a Three-Party Video Call
Updated on 2023-09-27 GMT+08:00
View PDF
Share

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:port/agentgateway/resource/voicecall/{agentid}/adjustvideomode

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.

Table 1 Parameter in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

Method Name in Logs

adjustVideoMode

Request Description

  • Request 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

    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

Table 4 Parameters in the message body

No.

Parameter

Value Type

Description

1

message

string

Description.

2

retcode

string

Error code. The options are as follows:

0: success

Other values: failure

3

result

object

Reserved field.

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"
}