Package com.bytedesk.core.message

Class MessageRestController

java.lang.Object
com.bytedesk.core.base.BaseRestController<MessageRequest,MessageRestService>
com.bytedesk.core.message.MessageRestController
@RestController @RequestMapping("/api/v1/message") @Description("Message Management Controller - Message management APIs for CRUD operations") public class MessageRestController extends BaseRestController<MessageRequest,MessageRestService>
消息管理接口控制器
Since:
2024-01-29
Author:
Jackning (270580156@qq.com)

  • Field Details

  • Constructor Details

    • MessageRestController

      public MessageRestController()

  • Method Details

    • queryByOrg

      public org.springframework.http.ResponseEntity<?> queryByOrg(MessageRequest request)
      根据组织查询消息
      Overrides:
      queryByOrg in class BaseRestController<MessageRequest,MessageRestService>
      Parameters:
      request - 查询请求
      Returns:
      分页消息列表

    • queryByUser

      public org.springframework.http.ResponseEntity<?> queryByUser(MessageRequest request)
      根据用户查询消息
      Overrides:
      queryByUser in class BaseRestController<MessageRequest,MessageRestService>
      Parameters:
      request - 查询请求
      Returns:
      分页消息列表

    • queryByUid

      public org.springframework.http.ResponseEntity<?> queryByUid(MessageRequest request)
      根据UID查询消息
      Overrides:
      queryByUid in class BaseRestController<MessageRequest,MessageRestService>
      Parameters:
      request - 查询请求
      Returns:
      消息详情

    • queryUnread

      @GetMapping("/unread") @Deprecated public org.springframework.http.ResponseEntity<?> queryUnread(MessageRequest request)
      Deprecated.
      此功能已迁移到企业版，请使用 /api/v1/vip/message/unread
      客服端-根据会话topic-查询未读消息
      Parameters:
      request - 查询请求
      Returns:
      未读消息列表

    • queryByThreadTopic

      @GetMapping("/thread/topic") public org.springframework.http.ResponseEntity<?> queryByThreadTopic(MessageRequest request)
      根据主题查询消息
      Parameters:
      request - 查询请求
      Returns:
      分页消息列表

    • queryByThreadUid

      @GetMapping("/thread/uid") public org.springframework.http.ResponseEntity<?> queryByThreadUid(MessageRequest request)
      根据会话UID查询消息
      Parameters:
      request - 查询请求
      Returns:
      分页消息列表

    • create

      public org.springframework.http.ResponseEntity<?> create(MessageRequest request)
      创建消息
      Overrides:
      create in class BaseRestController<MessageRequest,MessageRestService>
      Parameters:
      request - 创建请求
      Returns:
      创建的消息

    • update

      public org.springframework.http.ResponseEntity<?> update(MessageRequest request)
      更新消息
      Overrides:
      update in class BaseRestController<MessageRequest,MessageRestService>
      Parameters:
      request - 更新请求
      Returns:
      更新后的消息

    • delete

      public org.springframework.http.ResponseEntity<?> delete(MessageRequest request)
      删除消息
      Overrides:
      delete in class BaseRestController<MessageRequest,MessageRestService>
      Parameters:
      request - 删除请求
      Returns:
      删除结果

    • sendRestMessage

      @PostMapping("/rest/send") public org.springframework.http.ResponseEntity<?> sendRestMessage(@RequestBody Map<String,String> map)
      当客户端长连接断开时，启用此rest接口发送消息 send offline message
      Parameters:
      map - 包含JSON消息的Map
      Returns:
      发送结果

    • export

      @ActionAnnotation(title="\u6d88\u606f", action="\u5bfc\u51fa", description="export message") @GetMapping("/export") public Object export(MessageRequest request, jakarta.servlet.http.HttpServletResponse response)
      导出消息列表
      Overrides:
      export in class BaseRestController<MessageRequest,MessageRestService>
      Parameters:
      request - 导出请求
      response - HTTP响应
      Returns:
      导出结果

    • markAsRead

      @PostMapping("/{messageUid}/read") @Deprecated public org.springframework.http.ResponseEntity<?> markAsRead(@PathVariable String messageUid)
      Deprecated.
      此功能已迁移到企业版，请使用 /api/v1/vip/message/{messageUid}/read
      标记消息为已读
      Parameters:
      messageUid - 消息UID
      Returns:
      更新后的消息

    • markThreadAsRead

      @PostMapping("/thread/{threadUid}/read") @Deprecated public org.springframework.http.ResponseEntity<?> markThreadAsRead(@PathVariable String threadUid)
      Deprecated.
      此功能已迁移到企业版，请使用 /api/v1/vip/message/thread/{threadUid}/read
      批量标记会话中所有消息为已读
      Parameters:
      threadUid - 会话UID
      Returns:
      更新的消息数量