Forcibly Signing Out

Prerequisites

The agent has signed in.

Description

This interface is used to forcibly sign out an agent.

• When an agent is in talking or answering state, if this interface is invoked, the agent will be signed out, and the call will be released.
• For an agent:
  • If the sign-out interface does not respond, the sign-in interface cannot be invoked.
  • If the sign-in interface does not respond, the sign-out interface cannot be invoked.
• Do not invoke operation interfaces after sign-out.

Interface Method

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

URI

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/forcelogout

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

forceLogout

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

Triggered Event

• None
  

  If an agent proactively signs out, the AgentOther_ShutdownService event is not received. If this event is received, the agent has been signed out.

Error Code

• None

Example

• Message header

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

• Request parameter

  None

• Response parameter

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