Updated on 2023-09-27 GMT+08:00

Forcibly Signing Out with a Cause Code

Prerequisites

  • The agent has signed in.

Description

This interface is used to forcibly sign out an agent with a cause code.

Interface Method

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

URI

https://ip:port/agentgateway/resource/onlineagent/{agentid}/forcelogoutwithreason/{reason}

In the URL, ip indicates the IP address of the CC-Gateway, port indicates the HTTPS port number of the CC-Gateway, {agentid} indicates the employee ID of the agent that has logged in, and {reason} indicates the cause code of agent sign-out (ranging from 1 to 255).

Table 1 Parameters in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

2

reason

int

Yes

Agent sign-out reason code. The value ranges from 1 to 255.

Method Name in Logs

forceLogoutWithReason

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

Triggered Event

  • AgentOther_ShutdownService

    If the agent signs out, the event will not always be received. If the event is received, the agent has been signed out.

Error Code

100-005

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