Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Control/ Agent Operation Interfaces: onlineagent/ Setting Busy
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Setting Busy

Prerequisites

The agent has signed in.

Description

This interface is used to set the agent state to busy.

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}/saybusy?reason={reason}&prolong={false}

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 Parameters in the URI

No.

Parameter

Value Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

2

reason

int

No

Indicates the busy reason code.

If this parameter is left empty or set to 0, no busy reason code is available.

The value is an integer ranging from 200 to 250. This parameter is mandatory when an agent in busy state shows busy again.

3

prolong

boolean

No

Indicates whether to reset the busy reason when the agent is busy. The options are true and false. The default value is false. This parameter is mandatory when an agent in busy state shows busy again.

Method Name in Logs

sayBusy

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

AgentState_SetNotReady_Success

Error Code

  • 000-002
  • 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"
}