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

Applying for Rest

Prerequisites

  • The agent has signed in.

Description

The agent requests for rest.

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}/rest/{time}/{restcause}?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

time

long

Yes

Rest duration. The unit is second. The value ranges from 1 to 86399.

3

restcause

int

Yes

Rest cause code. Rest cause code configured on the platform. The value ranges from 0 to 255. The value 0 indicates no rest cause code.

4

prolong

boolean

No

Whether to reset the rest reason when the agent is in rest state. The options are true and false. The default value is false. This parameter is mandatory when an agent in rest state sets the state to rest again.

Method Name in Logs

rest

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_SetRest_Success
  • AgentState_Rest_Timeout

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