Quitting the Work State

Prerequisites

• The agent has signed in.
• The agent is in working state.

Description

This interface is used by an agent to quit the work state.

Interface Method

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

URI

https://ip:port/agentgateway/resource/onlineagent/{agentid}/cancelwork

Method Name in Logs

cancelWork

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

• AgentState_CancelWork_Success

Error Code

• 100-006
• 100-007
• 100-009

Example

• Message header

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

• Request parameter

  None

• Response parameter

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