消息 API

1. "获取消息列表"

  1. route definition
  • Url: /api/v1/messages
  • Method: GET
  • Request: MessagesListRequest
  • Response: MessagesListResponse
  1. request definition
type MessagesListRequest struct {
	Page int `form:"page,optional"`
	PageSize int `form:"pageSize,optional"`
	Type string `form:"type,optional"`
	Status string `form:"status,optional"`
}
  1. response definition
type MessagesListResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

2. "发送消息"

  1. route definition
  • Url: /api/v1/messages
  • Method: POST
  • Request: MessageSendRequest
  • Response: MessageSendResponse
  1. request definition
type MessageSendRequest struct {
	To string `json:"to"`
	Type string `json:"type"`
	Title string `json:"title,optional"`
	Content string `json:"content"`
	Data interface{} `json:"data,optional"`
}
  1. response definition
type MessageSendResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

3. "获取消息详情"

  1. route definition
  • Url: /api/v1/messages/:id
  • Method: GET
  • Request: MessageDetailRequest
  • Response: MessageDetailResponse
  1. request definition
type MessageDetailRequest struct {
	ID string `path:"id"`
}
  1. response definition
type MessageDetailResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

4. "标记消息已读"

  1. route definition
  • Url: /api/v1/messages/:id/read
  • Method: POST
  • Request: MessageReadRequest
  • Response: MessageReadResponse
  1. request definition
type MessageReadRequest struct {
	ID string `path:"id"`
}
  1. response definition
type MessageReadResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

5. "消息流（实时推送）"

  1. route definition
  • Url: /api/v1/messages/stream
  • Method: GET
  • Request: StreamMessagesRequest
  • Response: StreamMessagesResponse
  1. request definition
type StreamMessagesRequest struct {
}
  1. response definition
type StreamMessagesResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

6. "获取未读消息数量"

  1. route definition
  • Url: /api/v1/messages/unread-count
  • Method: GET
  • Request: MessagesUnreadCountRequest
  • Response: MessagesUnreadCountResponse
  1. request definition
type MessagesUnreadCountRequest struct {
}
  1. response definition
type MessagesUnreadCountResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}