Help Center/ Customer Engagement Center/ API Reference/ Agent Operation Interface Reference/ Real-time Inspection: qualitycontrol/ Inserting
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Inserting

Prerequisites

  • The inspector has signed in.
  • The inspector is in idle state.

Description

This interface is used by an inspector to inspect a specified agent in real time after the inspector signs in and shows idle.

An agent who has the inspection permission can barge into an agent who has signed in. After barging into an agent, the inspector enters the barge state, and the agent and inspector enter the two-party conversation mode. If the agent is answering an inbound call from a customer, the inspector can participate in the talk between the agent and customer.

Interface Method

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

URI

https://IP address:Port number/agentgateway/resource/qualitycontrol/{agentid}/addinsert/{workNo}

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.

Table 1 Parameters in the URI

No.

Parameter

Value Type

Mandatory (Yes/No)

Description

1

agentid

String

Yes

Agent ID. The value ranges from 101 to 999999.

2

workNo

String

Yes

ID of an agent whose call is to be inserted into. The value ranges from 101 to 999999.

The agent ID must belong to the same VCC as the value of agentid.

Method Name in Logs

addInsert

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

    None

Response Description

Table 3 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.

Triggered Event

  • AgentOther_PhoneAlerting
  • AgentOther_PhoneOffhook
  • AgentState_Busy
  • AgentOther_BeQcStart

Error Code

  • 100-006
  • 900-001
  • 900-002
  • 900-003
  • 900-005

Example

  • Message header 
    Content-Type:application/json; charset=UTF-8
Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter

    None

  • Response parameter 
    {
    "message": "",
    "retcode": "0",
    "result": {}
}