Package com.bytedesk.core.thread

Class ThreadRestController

java.lang.Object
com.bytedesk.core.base.BaseRestController<ThreadRequest,ThreadRestService>
com.bytedesk.core.thread.ThreadRestController
@RestController @RequestMapping("/api/v1/thread") public class ThreadRestController extends BaseRestController<ThreadRequest,ThreadRestService>
会话管理接口
Since:
2024-01-29
Author:
Jackning

  • Field Details

  • Constructor Details

    • ThreadRestController

      public ThreadRestController()

  • Method Details

    • queryByOrg

      @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u67e5\u8be2\u7ec4\u7ec7\u4f1a\u8bdd", description="queryByOrg thread") public org.springframework.http.ResponseEntity<?> queryByOrg(ThreadRequest request)
      根据组织查询会话
      Overrides:
      queryByOrg in class BaseRestController<ThreadRequest,ThreadRestService>
      Parameters:
      request - 查询请求
      Returns:
      分页会话列表

    • queryByUser

      @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u67e5\u8be2\u7528\u6237\u4f1a\u8bdd", description="queryByUser thread") public org.springframework.http.ResponseEntity<?> queryByUser(ThreadRequest request)
      根据用户查询会话
      Overrides:
      queryByUser in class BaseRestController<ThreadRequest,ThreadRestService>
      Parameters:
      request - 查询请求
      Returns:
      分页会话列表

    • queryByUid

      @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u67e5\u8be2\u4f1a\u8bdd\u8be6\u60c5", description="queryByUid thread") public org.springframework.http.ResponseEntity<?> queryByUid(ThreadRequest request)
      根据UID查询会话
      Overrides:
      queryByUid in class BaseRestController<ThreadRequest,ThreadRestService>
      Parameters:
      request - 查询请求
      Returns:
      会话信息

    • queryByThreadInvite

      @GetMapping("/query/invite") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u67e5\u8be2\u9080\u8bf7\u4f1a\u8bdd", description="query invite threads") public org.springframework.http.ResponseEntity<?> queryByThreadInvite(ThreadRequest request)
      查询邀请会话
      Parameters:
      request - 查询请求
      Returns:
      分页邀请会话列表

    • queryByThreadTopic

      @GetMapping("/query/topic") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u6839\u636e\u4e3b\u9898\u67e5\u8be2", description="query thread by topic") public org.springframework.http.ResponseEntity<?> queryByThreadTopic(ThreadRequest request)
      根据主题查询会话
      Parameters:
      request - 查询请求
      Returns:
      会话信息

    • queryByTopicAndOwner

      @GetMapping("/query/topic/owner") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u6839\u636e\u4e3b\u9898\u548c\u7528\u6237\u67e5\u8be2", description="query thread by topic and owner") public org.springframework.http.ResponseEntity<?> queryByTopicAndOwner(ThreadRequest request)
      主要用于查询 某个成员 的 某个群组会话
      Parameters:
      request -
      Returns:

    • create

      @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u521b\u5efa\u4f1a\u8bdd", description="create thread") public org.springframework.http.ResponseEntity<?> create(@RequestBody ThreadRequest request)
      创建会话
      Overrides:
      create in class BaseRestController<ThreadRequest,ThreadRestService>
      Parameters:
      request - 创建会话请求
      Returns:
      创建的会话

    • update

      @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u66f4\u65b0\u4f1a\u8bdd", description="update thread") public org.springframework.http.ResponseEntity<?> update(@RequestBody ThreadRequest request)
      更新会话
      Overrides:
      update in class BaseRestController<ThreadRequest,ThreadRestService>
      Parameters:
      request - 更新会话请求
      Returns:
      更新后的会话

    • updateTop

      @PostMapping("/update/top") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u66f4\u65b0\u7f6e\u9876\u72b6\u6001", description="update thread top") public org.springframework.http.ResponseEntity<?> updateTop(@RequestBody ThreadRequest request)
      更新会话置顶状态
      Parameters:
      request - 更新请求
      Returns:
      更新后的会话

    • updateStar

      @PostMapping("/update/star") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u66f4\u65b0\u6807\u661f\u72b6\u6001", description="update thread star") public org.springframework.http.ResponseEntity<?> updateStar(@RequestBody ThreadRequest request)
      更新会话标星状态
      Parameters:
      request - 更新请求
      Returns:
      更新后的会话

    • updateMute

      @PostMapping("/update/mute") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u66f4\u65b0\u9759\u97f3\u72b6\u6001", description="update thread mute") public org.springframework.http.ResponseEntity<?> updateMute(@RequestBody ThreadRequest request)
      更新会话静音状态
      Parameters:
      request - 更新请求
      Returns:
      更新后的会话

    • updateHide

      @PostMapping("/update/hide") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u66f4\u65b0\u9690\u85cf\u72b6\u6001", description="update thread hide") public org.springframework.http.ResponseEntity<?> updateHide(@RequestBody ThreadRequest request)

    • updateFold

      @PostMapping("/update/fold") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u66f4\u65b0\u6298\u53e0\u72b6\u6001", description="update thread fold") public org.springframework.http.ResponseEntity<?> updateFold(@RequestBody ThreadRequest request)

    • updateUser

      @PostMapping("/update/user") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u66f4\u65b0\u7528\u6237\u4fe1\u606f", description="update thread user") public org.springframework.http.ResponseEntity<?> updateUser(@RequestBody ThreadRequest request)
      更新会话用户信息
      Parameters:
      request - 更新请求
      Returns:
      更新后的会话

    • updateTagList

      @PostMapping("/update/tagList") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u66f4\u65b0\u6807\u7b7e\u5217\u8868", description="update thread tagList") public org.springframework.http.ResponseEntity<?> updateTagList(@RequestBody ThreadRequest request)
      更新会话标签列表
      Parameters:
      request - 更新请求
      Returns:
      更新后的会话

    • updateUnread

      @PostMapping("/update/unread") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u66f4\u65b0\u672a\u8bfb\u72b6\u6001", description="update thread unread") public org.springframework.http.ResponseEntity<?> updateUnread(@RequestBody ThreadRequest request)
      更新会话未读状态
      Parameters:
      request - 更新请求
      Returns:
      更新后的会话

    • queryByUserTopics

      @GetMapping("/query/by/user/topics") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u67e5\u8be2\u7528\u6237\u5ba2\u670d\u4f1a\u8bdd", description="query threads by user topics") public org.springframework.http.ResponseEntity<?> queryByUserTopics(ThreadRequest request)
      查询用户所有客服会话
      Returns:
      用户所有会话列表

    • updateNote

      @PostMapping("/update/note") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u66f4\u65b0\u5907\u6ce8", description="update thread note") public org.springframework.http.ResponseEntity<?> updateNote(@RequestBody ThreadRequest request)

    • close

      @PostMapping("/close") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u5173\u95ed\u4f1a\u8bdd", description="close thread") public org.springframework.http.ResponseEntity<?> close(@RequestBody ThreadRequest request)
      关闭会话
      Parameters:
      request - 关闭请求
      Returns:
      关闭后的会话

    • closeByTopic

      @PostMapping("/close/topic") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u6839\u636e\u4e3b\u9898\u5173\u95ed\u4f1a\u8bdd", description="close thread by topic") public org.springframework.http.ResponseEntity<?> closeByTopic(@RequestBody ThreadRequest request)

    • delete

      @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u5220\u9664\u4f1a\u8bdd", description="delete thread") public org.springframework.http.ResponseEntity<?> delete(@RequestBody ThreadRequest request)
      删除会话
      Overrides:
      delete in class BaseRestController<ThreadRequest,ThreadRestService>
      Parameters:
      request - 删除请求
      Returns:
      删除结果

    • export

      @GetMapping("/export") @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u5bfc\u51fa\u4f1a\u8bdd", description="export thread") public Object export(ThreadRequest request, jakarta.servlet.http.HttpServletResponse response)
      导出会话列表
      Overrides:
      export in class BaseRestController<ThreadRequest,ThreadRestService>
      Parameters:
      request - 导出请求
      response - HTTP响应
      Returns:
      导出结果

    • requestMessageMetadata

      @ActionAnnotation(title="\u4f1a\u8bdd\u7ba1\u7406", action="\u7533\u8bf7\u6d88\u606f\u5143\u4fe1\u606f", description="request message metadata") @PostMapping("/message/meta") public org.springframework.http.ResponseEntity<?> requestMessageMetadata(@RequestBody ThreadRequest request)
      发送消息前申请服务端分配的消息元信息
      Parameters:
      request - 包含 threadUid 的请求
      Returns:
      包含 messageUid、timestamp 的元信息