文档首页/ 云客服/ API参考/ 座席工作台/ 座席控制/ 座席操作类接口:onlineagent/ 请求休息
更新时间：2024-08-02 GMT+08:00
查看PDF
分享

请求休息

前置条件

  • 座席已签入

场景描述

座席进行请求休息操作。

接口方法

设置成“POST”。该接口仅支持POST方法，不支持PUT、GET和DELETE等方法。

接口URI

https://ip:port/agentgateway/resource/onlineagent/{agentid}/rest/{time}/{restcause}?prolong={prolong}

其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。

表1 URI中携带的参数说明

序号

名称

参数类型

是否必选

说明

1

agentid

string

True

座席的工号，取值范围：101～59999。

2

time

long

True

休息时长。以秒为单位，取值范围：1~86399。

3

restcause

int

True

休息原因码。向平台设置休息原因码，取值范围：0-255，其中0代表无休息原因码。

4

prolong

boolean

False

已休息状态下是否重新设置休息原因，取值true/false，默认值false。座席休息状态下重新设置休息，该参数必选。

日志中的方法名

rest

请求说明

  • 消息头
    表2 请求头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式，缺省值：application/json; charset=UTF-8

    2

    Guid

    string

    True

    静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。
  • 消息体

    无

响应说明

表3 消息体参数说明

序号

名称

参数类型

说明

1

message

string

描述

2

retcode

string

错误码。取值如下：

0：成功

非0：失败

3

result

object

预留字段

触发事件

  • 休息成功（AgentState_SetRest_Success）
  • 休息超时提醒（AgentState_Rest_Timeout）

错误结果码

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

报文样例

  • 消息头 
    Content-Type:application/json; charset=UTF-8
Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • 请求参数

    无

  • 响应参数 
    {
  "result": {},
  "message": "success",
  "retcode": "0"
}