message.api 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. syntax = "v1"
  2. info(
  3. title: // TODO: add title
  4. desc: // TODO: add description
  5. author: "jiaojiao7"
  6. email: "renjiaojiao@topnet.net.cn"
  7. )
  8. type MessageDeleteReq {
  9. Id string `form:"id"`
  10. AppId string `form:"appId"`
  11. }
  12. type response {
  13. Code int64 `json:"code"`
  14. Message string `json:"message"`
  15. }
  16. //查询消息详情
  17. type MessageDetailReq {
  18. Id int64 `form:"id"`
  19. }
  20. type MessageDetailResp {
  21. Code int64 `json:"code"`
  22. Message string `json:"message"`
  23. Data map[string]interface{} `json:"data"`
  24. }
  25. type MessageGetLastReq {
  26. UserId string `form:"userId"`
  27. AppId string `form:"appId"`
  28. MsgType int64 `form:"msgType"`
  29. }
  30. type MessageGetLastRes {
  31. Code int64 `json:"code"`
  32. Message string `json:"message"`
  33. Data map[string]interface{} `json:"data"`
  34. }
  35. type MessageFindReq {
  36. UserId string `form:"userId"`
  37. AppId string `form:"appId"`
  38. // MsgType int64 `form:"msgType"`
  39. ReceiveUserId string `form:"receiveUserId"`
  40. MsgType int64 `form:"msgType"` // 是否限制消息类型 -1 不限制
  41. IsRead int64 `form:"isRead"` // 是否限制未读 -1 不限制
  42. Offset int64 `form:"offset"` // 页数
  43. PageSize int64 `form:"pageSize"` //
  44. }
  45. type MessageFindRes {
  46. Code int64 `json:"code"`
  47. Message string `json:"message"`
  48. Data []map[string]interface{} `json:"data"`
  49. Total int64 `json:"total"`
  50. }
  51. type MessageUnreadClassCountReq {
  52. UserId string `form:"userId"`
  53. AppId string `form:"appId"`
  54. NeedMsg bool `form:"needMsg"`
  55. }
  56. type MessageUnreadClassCountRes {
  57. Code int64 `json:"code"`
  58. Message string `json:"message"`
  59. Data []map[string]interface{} `json:"data"`
  60. Info []map[string]interface{} `json:"info"`
  61. }
  62. type MessageUnreadCountReq {
  63. UserId string `form:"userId"`
  64. AppId string `form:"appId"`
  65. }
  66. type MessageUnreadCountRes {
  67. Code int64 `json:"code"`
  68. Message string `json:"message"`
  69. Data map[string]interface{} `json:"data"`
  70. }
  71. type MessageTypeReq {
  72. UserId string `form:"userId"`
  73. AppId string `form:"appId"`
  74. }
  75. type MessageTypeRes {
  76. Code int64 `json:"code"`
  77. Message string `json:"message"`
  78. Data []int64 `json:"data"`
  79. }
  80. type MarkReadReq {
  81. MsgId int64 `form:"msgId"`
  82. AppId string `form:"appId"`
  83. }
  84. type MarkReadRes {
  85. Code int64 `json:"code"`
  86. Message string `json:"message"`
  87. Data int64 `json:"data"`
  88. }
  89. service message-api {
  90. //删除消息
  91. @handler MessageDeleteHandler // TODO: set handler name and delete this comment
  92. get /message/messageDelete (MessageDeleteReq) returns (response)
  93. //查询消息详情
  94. @handler MessageDetailHandler // TODO: set handler name and delete this comment
  95. get /message/messageDetail (MessageDetailReq) returns (MessageDetailResp)
  96. @handler MessageGetLastHandler // 获取指定类型的最新一条未读消息
  97. post /message/messageGetLast (MessageGetLastReq) returns (MessageGetLastRes)
  98. @handler MessageFindHandler // 获取指定用户的历史消息 条件可选 消息类型 是否未读
  99. post /message/messageFind (MessageFindReq) returns (MessageFindRes)
  100. @handler MessageUnreadClassCountHandler // 获取用户未读消息分类及分类下的最新消息
  101. post /message/messageUnreadClassCount (MessageUnreadClassCountReq) returns (MessageUnreadClassCountRes)
  102. @handler MessageUnreadCountHandler // 获取用户未读消息数量
  103. post /message/messageUnreadCount (MessageUnreadCountReq) returns (MessageUnreadCountRes)
  104. @handler MessageTypeHandler // 获取用户未读消息数量
  105. post /message/messageType (MessageTypeReq) returns (MessageTypeRes)
  106. @handler MarkReadHandler // 标记为已读
  107. post /message/markRead (MarkReadReq) returns (MarkReadRes)
  108. }