io.xiaper.restkefu.controller.v1

类 ThreadController

java.lang.Object

io.xiaper.rest.controller.v1.BaseController

io.xiaper.restkefu.controller.v1.ThreadController

@RestController
 @RequestMapping(value="/api/thread")
public class ThreadController
extends io.xiaper.rest.controller.v1.BaseController

会话 TODO: 某些IM接口需要迁移到IM模块

作者:

xiaper.io

字段概要

从类继承的字段 io.xiaper.rest.controller.v1.BaseController

logger

构造器概要

构造器

构造器和说明
ThreadController()

方法概要

限定符和类型	方法和说明
io.xiaper.jpa.util.JsonResult	agentClose(Principal principal, Map map) 客服关闭会话
io.xiaper.jpa.util.JsonResult	appoint(Principal principal, String agentUid, String client) 指定坐席
io.xiaper.jpa.util.JsonResult	chooseWorkGroup(Principal principal, String workGroupWid, String client) 选择工作组
io.xiaper.jpa.util.JsonResult	chooseWorkGroupLiuXue(Principal principal, String workGroupWid, String workGroupNickname, String client) 留学，针对大学长定制 选择工作组： 1.
io.xiaper.jpa.util.JsonResult	contact(Principal principal, String contactCid, String client) 获取联系人会话
io.xiaper.jpa.util.JsonResult	filter(Principal principal, int page, int size, String nickname, String createdAtStart, String createdAtEnd, String workGroupNickname, String agentRealName, String client) 搜索过滤会话 FIXME: 仅显示成功接入客服的会话 TODO：管理员获取所有历史会话 TODO：客服组长获取组内成员所以历史会话 TODO：客服账号获取自己的历史会话
io.xiaper.jpa.util.JsonResult	get(Principal principal) 客服端获取24小时内会话
io.xiaper.jpa.util.JsonResult	group(Principal principal, String groupGid, String client) 获取群组会话
io.xiaper.jpa.util.JsonResult	history(Principal principal, int page, int size, String client) 获取 历史会话threads FIXME: 仅显示成功接入客服的会话 TODO：管理员获取所有历史会话 TODO：客服组长获取组内成员历史会话 TODO：客服账号获取自己的历史会话
io.xiaper.jpa.util.JsonResult	invite(Principal principal, Map map) 邀请会话 注：可以同时邀请多个客服加入
io.xiaper.jpa.util.JsonResult	inviteAccept(Principal principal, Map map) 接受邀请会话
io.xiaper.jpa.util.JsonResult	inviteExit(Principal principal, Map map) 退出邀请会话
io.xiaper.jpa.util.JsonResult	inviteReject(Principal principal, Map map) 拒绝邀请会话
io.xiaper.jpa.util.JsonResult	isTop(Principal principal, String tid, String client) 判断会话是否置顶
io.xiaper.jpa.util.JsonResult	markDeleted(Principal principal, Map map) 客户端标记删除，之后不再出现在其会话列表 TODO: 在收到新消息之后，取消标记删除
io.xiaper.jpa.util.JsonResult	markNoDisturb(Principal principal, Map map) 设置会话消息免打扰
io.xiaper.jpa.util.JsonResult	markTop(Principal principal, Map map) 会话置顶
io.xiaper.jpa.util.JsonResult	markUnread(Principal principal, Map map) 标记会话未读
io.xiaper.jpa.util.JsonResult	monitor(Principal principal, int page, int size, String client) 获取监控会话 TODO: 获取所有正在进行中的会话，分页， FIXME: 公司管理员可以获取全部会话，小组长可以获取本组内 正在进行会话
io.xiaper.jpa.util.JsonResult	quality(Principal principal, int page, int size, String client) 获取质量检查会话 TODO: 获取所有已经结束的会话，分页， FIXME: 公司管理员可以获取全部会话，小组长可以获取本组内 已经结束会话
io.xiaper.jpa.util.JsonResult	questionnaire(Principal principal, String threadTid, String questionnaireItemItemQid, String client) 咨询前问卷答案： 比如大学长业务类型选择完毕之后，通知访客
io.xiaper.jpa.util.JsonResult	request(Principal principal, String workGroupWid, String requestType, String agentUid, String client) 访客端发起请求会话 请求工作组会话 + 请求一对一会话 FIXME: 离线 以及非工作时间 提示 返回结果代码： 200：请求会话成功-创建新会话 201：请求会话成功-继续进行中会话 202：请求会话成功-排队中 203：请求会话成功-当前非工作时间，请自助查询或留言 204：请求会话成功-当前无客服在线，请自助查询或留言 205：咨询前问卷 206：(FIXME: 为兼容旧版，暂时增加此来代替201，待几个版本之后直接去掉205替换为201)请求会话成功-继续进行中会话 -1: 请求会话失败-access token无效 -2：请求会话失败-wId不存在 -3：被拉入黑名单
io.xiaper.jpa.util.JsonResult	requestShop(Principal principal) TODO: 电商客服，携带商品信息等
io.xiaper.jpa.util.JsonResult	transfer(Principal principal, Map map) 转接会话 注：只能转接一个客服账号
io.xiaper.jpa.util.JsonResult	transferAccept(Principal principal, Map map) 接受转接会话
io.xiaper.jpa.util.JsonResult	transferReject(Principal principal, Map map) 拒绝转接会话
io.xiaper.jpa.util.JsonResult	transferWorkGroup(Principal principal, Map map) 转接会话给某个工作组/技能组
io.xiaper.jpa.util.JsonResult	unmarkNoDisturb(Principal principal, Map map) 取消会话消息免打扰
io.xiaper.jpa.util.JsonResult	unMarkTop(Principal principal, Map map) 取消会话置顶
io.xiaper.jpa.util.JsonResult	unmarkUnread(Principal principal, Map map) 取消标记会话未读
io.xiaper.jpa.util.JsonResult	updateCurrent(Principal principal, Map map) 更新当前会话
io.xiaper.jpa.util.JsonResult	visitorClose(Principal principal, Map map) 访客关闭会话
io.xiaper.jpa.util.JsonResult	visitorHistory(Principal principal, int page, String client) 访客端获取访客所有历史会话
io.xiaper.jpa.util.JsonResult	workGroup(Principal principal, String workGroupWid, String client) 工作组会话

从类继承的方法 io.xiaper.rest.controller.v1.BaseController

getSpecification

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ThreadController

public ThreadController()

方法详细资料

request

@GetMapping(value="/request")
public io.xiaper.jpa.util.JsonResult request(Principal principal,
                                                                           @RequestParam(value="wId")
                                                                           String workGroupWid,
                                                                           @RequestParam(value="type")
                                                                           String requestType,
                                                                           @RequestParam(value="aId")
                                                                           String agentUid,
                                                                           @RequestParam(value="client")
                                                                           String client)

访客端发起请求会话 请求工作组会话 + 请求一对一会话 FIXME: 离线 以及非工作时间 提示 返回结果代码： 200：请求会话成功-创建新会话 201：请求会话成功-继续进行中会话 202：请求会话成功-排队中 203：请求会话成功-当前非工作时间，请自助查询或留言 204：请求会话成功-当前无客服在线，请自助查询或留言 205：咨询前问卷 206：(FIXME: 为兼容旧版，暂时增加此来代替201，待几个版本之后直接去掉205替换为201)请求会话成功-继续进行中会话 -1: 请求会话失败-access token无效 -2：请求会话失败-wId不存在 -3：被拉入黑名单

参数:

principal - principal

workGroupWid - wid

requestType - type

agentUid - uid

client - client

返回:

json

requestShop

@GetMapping(value="/request/shop")
public io.xiaper.jpa.util.JsonResult requestShop(Principal principal)

TODO: 电商客服，携带商品信息等

参数:

principal - principal

返回:

json

appoint

@GetMapping(value="/appoint")
public io.xiaper.jpa.util.JsonResult appoint(Principal principal,
                                                                           @RequestParam(value="aId")
                                                                           String agentUid,
                                                                           @RequestParam(value="client")
                                                                           String client)

指定坐席

参数:

principal - principal

agentUid - aid

client - client

返回:

json

workGroup

@GetMapping(value="/workGroup")
public io.xiaper.jpa.util.JsonResult workGroup(Principal principal,
                                                                               @RequestParam(value="wId")
                                                                               String workGroupWid,
                                                                               @RequestParam(value="client")
                                                                               String client)

工作组会话

参数:

principal - principal

workGroupWid - wid

client - client

返回:

json

questionnaire

@GetMapping(value="/questionnaire")
public io.xiaper.jpa.util.JsonResult questionnaire(Principal principal,
                                                                                       @RequestParam(value="tId")
                                                                                       String threadTid,
                                                                                       @RequestParam(value="itemQid")
                                                                                       String questionnaireItemItemQid,
                                                                                       @RequestParam(value="client")
                                                                                       String client)

咨询前问卷答案： 比如大学长业务类型选择完毕之后，通知访客

参数:

principal - principal

threadTid - tid

questionnaireItemItemQid - qid

client - client

返回:

json

chooseWorkGroupLiuXue

@GetMapping(value="/choose/workGroup/liuxue")
public io.xiaper.jpa.util.JsonResult chooseWorkGroupLiuXue(Principal principal,
                                                                                                         @RequestParam(value="wId")
                                                                                                         String workGroupWid,
                                                                                                         @RequestParam(value="nickname")
                                                                                                         String workGroupNickname,
                                                                                                         @RequestParam(value="client")
                                                                                                         String client)

留学，针对大学长定制 选择工作组： 1. 首先根据用户ip匹配相应分公司 2. 根据工作组昵称匹配相应分公司昵称（每个国家相应工作组昵称相同，假设每个分公司每个国家之一一个工作组，如果有多个则默认匹配第一个） 3. 如果没有匹配到相应国家工作组，则直接请求传入工作组wid客服会话

参数:

principal - principal

workGroupWid - wid

workGroupNickname - nickname

client - client

返回:

json

chooseWorkGroup

@GetMapping(value="/choose/workGroup")
public io.xiaper.jpa.util.JsonResult chooseWorkGroup(Principal principal,
                                                                                            @RequestParam(value="wId")
                                                                                            String workGroupWid,
                                                                                            @RequestParam(value="client")
                                                                                            String client)

选择工作组

参数:

principal - principal

workGroupWid - wid

client - client

返回:

json

transfer

@PostMapping(value="/transfer")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult transfer(Principal principal,
                                                                                             @RequestBody
                                                                                             Map map)

转接会话 注：只能转接一个客服账号

参数:

principal - principal

map - map

返回:

json

transferWorkGroup

@PostMapping(value="/transfer/workGroup")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult transferWorkGroup(Principal principal,
                                                                                                                @RequestBody
                                                                                                                Map map)

转接会话给某个工作组/技能组

参数:

principal - principal

map - map

返回:

json

transferAccept

@PostMapping(value="/transfer/accept")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult transferAccept(Principal principal,
                                                                                                          @RequestBody
                                                                                                          Map map)

接受转接会话

参数:

principal - principal

map - map

返回:

json

transferReject

@PostMapping(value="/transfer/reject")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult transferReject(Principal principal,
                                                                                                          @RequestBody
                                                                                                          Map map)

拒绝转接会话

参数:

principal - principal

map - map

返回:

json

invite

@PostMapping(value="/invite")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult invite(Principal principal,
                                                                                         @RequestBody
                                                                                         Map map)

邀请会话 注：可以同时邀请多个客服加入

参数:

principal - principal

map - map

返回:

json

inviteAccept

@PostMapping(value="/invite/accept")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult inviteAccept(Principal principal,
                                                                                                      @RequestBody
                                                                                                      Map map)

接受邀请会话

参数:

principal - principal

map - map

返回:

json

inviteReject

@PostMapping(value="/invite/reject")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult inviteReject(Principal principal,
                                                                                                      @RequestBody
                                                                                                      Map map)

拒绝邀请会话

参数:

principal - principal

map - map

返回:

json

inviteExit

@PostMapping(value="/invite/exit")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult inviteExit(Principal principal,
                                                                                                  @RequestBody
                                                                                                  Map map)

退出邀请会话

参数:

principal - principal

map - map

返回:

json

updateCurrent

@PostMapping(value="/update/current")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult updateCurrent(Principal principal,
                                                                                                        @RequestBody
                                                                                                        Map map)

更新当前会话

参数:

principal - principal

map - map

返回:

json

isTop

@GetMapping(value="/is/top")
public io.xiaper.jpa.util.JsonResult isTop(Principal principal,
                                                                        @RequestParam(value="tid")
                                                                        String tid,
                                                                        @RequestParam(value="client")
                                                                        String client)

判断会话是否置顶

参数:

principal - principal

tid - tid

client - client

返回:

json

markTop

@PostMapping(value="/mark/top")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult markTop(Principal principal,
                                                                                            @RequestBody
                                                                                            Map map)

会话置顶

参数:

principal - principal

map - map

返回:

json

unMarkTop

@PostMapping(value="/unmark/top")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult unMarkTop(Principal principal,
                                                                                                @RequestBody
                                                                                                Map map)

取消会话置顶

参数:

principal - principal

map - map

返回:

json

markNoDisturb

@PostMapping(value="/mark/nodisturb")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult markNoDisturb(Principal principal,
                                                                                                        @RequestBody
                                                                                                        Map map)

设置会话消息免打扰

参数:

principal - principal

map - map

返回:

json

unmarkNoDisturb

@PostMapping(value="/unmark/nodisturb")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult unmarkNoDisturb(Principal principal,
                                                                                                            @RequestBody
                                                                                                            Map map)

取消会话消息免打扰

参数:

principal - principal

map - map

返回:

json

markUnread

@PostMapping(value="/mark/unread")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult markUnread(Principal principal,
                                                                                                  @RequestBody
                                                                                                  Map map)

标记会话未读

参数:

principal - principal

map - map

返回:

json

unmarkUnread

@PostMapping(value="/unmark/unread")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult unmarkUnread(Principal principal,
                                                                                                      @RequestBody
                                                                                                      Map map)

取消标记会话未读

参数:

principal - principal

map - map

返回:

json

markDeleted

@PostMapping(value="/mark/deleted")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult markDeleted(Principal principal,
                                                                                                    @RequestBody
                                                                                                    Map map)

客户端标记删除，之后不再出现在其会话列表 TODO: 在收到新消息之后，取消标记删除

参数:

principal - principal

map - map

返回:

json

get

@GetMapping(value="/get")
public io.xiaper.jpa.util.JsonResult get(Principal principal)

客服端获取24小时内会话

参数:

principal - principal

返回:

json

contact

@GetMapping(value="/contact")
public io.xiaper.jpa.util.JsonResult contact(Principal principal,
                                                                           @RequestParam(value="cid")
                                                                           String contactCid,
                                                                           @RequestParam(value="client")
                                                                           String client)

获取联系人会话

参数:

principal - principal

contactCid - cid

client - client

返回:

json

group

@GetMapping(value="/group")
public io.xiaper.jpa.util.JsonResult group(Principal principal,
                                                                       @RequestParam(value="gid")
                                                                       String groupGid,
                                                                       @RequestParam(value="client")
                                                                       String client)

获取群组会话

参数:

principal - principal

groupGid - gid

client - client

返回:

json

history

@GetMapping(value="/history")
public io.xiaper.jpa.util.JsonResult history(Principal principal,
                                                                           @RequestParam(value="page")
                                                                           int page,
                                                                           @RequestParam(value="size")
                                                                           int size,
                                                                           @RequestParam(value="client")
                                                                           String client)

获取 历史会话threads FIXME: 仅显示成功接入客服的会话 TODO：管理员获取所有历史会话 TODO：客服组长获取组内成员历史会话 TODO：客服账号获取自己的历史会话

参数:

principal - principal

page - page

size - size

client - client

返回:

json

monitor

@GetMapping(value="/monitor")
public io.xiaper.jpa.util.JsonResult monitor(Principal principal,
                                                                           @RequestParam(value="page")
                                                                           int page,
                                                                           @RequestParam(value="size")
                                                                           int size,
                                                                           @RequestParam(value="client")
                                                                           String client)

获取监控会话 TODO: 获取所有正在进行中的会话，分页， FIXME: 公司管理员可以获取全部会话，小组长可以获取本组内 正在进行会话

参数:

principal - principal

page - page

size - size

client - client

返回:

json

quality

@GetMapping(value="/quality")
public io.xiaper.jpa.util.JsonResult quality(Principal principal,
                                                                           @RequestParam(value="page")
                                                                           int page,
                                                                           @RequestParam(value="size")
                                                                           int size,
                                                                           @RequestParam(value="client")
                                                                           String client)

获取质量检查会话 TODO: 获取所有已经结束的会话，分页， FIXME: 公司管理员可以获取全部会话，小组长可以获取本组内 已经结束会话

参数:

principal - principal

page - page

size - size

client - client

返回:

json

agentClose

@PostMapping(value="/agent/close")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult agentClose(Principal principal,
                                                                                                  @RequestBody
                                                                                                  Map map)

客服关闭会话

参数:

principal - principal

map - map

返回:

json

visitorClose

@PostMapping(value="/visitor/close")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult visitorClose(Principal principal,
                                                                                                      @RequestBody
                                                                                                      Map map)

访客关闭会话

参数:

principal - principal

map - map

返回:

json

filter

@GetMapping(value="/filter")
public io.xiaper.jpa.util.JsonResult filter(Principal principal,
                                                                         @RequestParam(value="page")
                                                                         int page,
                                                                         @RequestParam(value="size")
                                                                         int size,
                                                                         @RequestParam(value="nickname")
                                                                         String nickname,
                                                                         @RequestParam(value="createdAtStart")
                                                                         String createdAtStart,
                                                                         @RequestParam(value="createdAtEnd")
                                                                         String createdAtEnd,
                                                                         @RequestParam(value="workGroupNickname")
                                                                         String workGroupNickname,
                                                                         @RequestParam(value="agentRealName")
                                                                         String agentRealName,
                                                                         @RequestParam(value="client")
                                                                         String client)

搜索过滤会话 FIXME: 仅显示成功接入客服的会话 TODO：管理员获取所有历史会话 TODO：客服组长获取组内成员所以历史会话 TODO：客服账号获取自己的历史会话

参数:

principal - principal

page - page

size - size

nickname - nickname

createdAtStart - start

createdAtEnd - end

workGroupNickname - nickname

agentRealName - realname

client - client

返回:

json

visitorHistory

@GetMapping(value="/visitor/history")
public io.xiaper.jpa.util.JsonResult visitorHistory(Principal principal,
                                                                                          @RequestParam(value="page")
                                                                                          int page,
                                                                                          @RequestParam(value="client")
                                                                                          String client)

访客端获取访客所有历史会话

参数:

principal - principal

page - page

client - client

返回:

json