文档首页/ 云客服/ API参考/ 座席工作台/ 座席控制/ 座席操作类接口:onlineagent/ 强制签出带原因码
更新时间：2023-09-27 GMT+08:00
查看PDF
分享

强制签出带原因码

前置条件

  • 座席已签入

场景描述

座席强制签出带原因码。

接口方法

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

接口URI

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

其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号，{agentid}为座席工号，{reason}为座席签出原因码（范围1-255）。

表1 URI中携带的参数说明

序号

参数名

数据类型

选取原则

说明

1

agentid

string

True

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

2

reason

int

True

座席签出原因码，取值范围：1-255。

日志中的方法名

forceLogoutWithReason

请求说明

  • 消息头
    表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：失败

触发事件

  • 座席签出成功（AgentOther_ShutdownService）

    座席主动签出，并不一定会收到该事件，如果收到该事件，一定表示座席已经被签出。

错误结果码

100-005

报文样例

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

    无

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