message.proto 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. syntax = "proto3";
  2. package message;
  3. message SendMsgRequest {
  4. string receiveUserId = 1; //接收方用户ID
  5. string receiveName = 2; //接收方用户名
  6. string sendUserId = 3; //发送方用户ID
  7. string sendName = 4; //发送方用户名
  8. string title = 5; //主题
  9. string content = 6; //内容
  10. int64 msgType = 7; //消息类型 1:客服 2:系统通知 3:营销 4:用户会话
  11. string link = 8; //跳转链接
  12. int64 citeId = 9; //引用id
  13. string appid = 10; //应用标识
  14. }
  15. message ChangeReadStatusRequest {
  16. int64 id = 1; // 消息id
  17. int64 readStatus = 2; // 阅读状态 0-未读 1-已读
  18. string appid = 3; //应用标识
  19. }
  20. message ResCount {
  21. int64 msgType = 1; // 类型及未读数量
  22. int64 count = 2; // 类型及未读数量
  23. }
  24. // 删除单一消息
  25. message DeleteSingleMessageRequest {
  26. int64 id = 1; // 消息id
  27. string appid = 3; //应用标识
  28. }
  29. // 批量删除消息
  30. message DeleteMultipleMessageRequest {
  31. string id = 1; // 多条消息id, 逗号分隔
  32. string appid = 3; //应用标识
  33. }
  34. // 查询指定用户未读消息合计
  35. message GetUnreadCountRequest {
  36. string userId = 1; // 用户id
  37. string appid = 2; //应用标识
  38. }
  39. message Response {
  40. int64 code = 1; //状态码
  41. string message = 2; //响应消息
  42. }
  43. message GetUnreadCountResponse {
  44. int64 code = 1; //状态码
  45. string message = 2; //响应消息
  46. int64 count = 3; //
  47. }
  48. message FindUserMsgReq {
  49. string userId = 1; //用户id
  50. string receiveUserId = 2; //聊天方用户id
  51. string appid = 3; //应用标识
  52. int64 offSet = 4; //当前
  53. int64 pageSize = 5; //大小
  54. int64 msgType = 6; //是否区分类型
  55. int64 read = 7; // 是否区分已读未读 -1 不区分已读未读 0 未读 1 已读
  56. }
  57. message Messages {
  58. string receiveUserId = 1; //接收方用户ID
  59. string receiveName = 2; //接收方用户名
  60. string sendUserId = 3; //发送方用户ID
  61. string sendName = 4; //发送方用户名
  62. string title = 5; //主题
  63. string content = 6; //内容
  64. int64 msgType = 7; //消息类型 1:客服 2:系统通知 3:营销 4:用户会话
  65. string link = 8; //跳转链接
  66. int64 citeId = 9; //引用id
  67. int64 isRead = 10; //已读未读 0:未读 1:已读
  68. string createtime = 11;
  69. string appid = 12; //应用标识
  70. int64 id = 13; //消息id
  71. }
  72. message FindUserMsgRes {
  73. int64 code = 1; //状态码
  74. string message = 2; //响应消息
  75. repeated Messages data = 3; //
  76. int64 count = 4; //总数
  77. }
  78. message GetClassUnreadCountReq {
  79. string userId = 1; // 用户id
  80. int64 msgType = 2; //分类 1:客服 2:系统通知 3:营销 4:用户会话
  81. string appid = 3; //应用标识
  82. }
  83. //查看消息内容
  84. message MessageDetailReq {
  85. int64 id = 1; //消息id
  86. }
  87. message MessageDetailResp {
  88. int64 code = 1; //状态码
  89. string message = 2; //响应消息
  90. Messages data = 3; //
  91. }
  92. message GetLastMessageReq {
  93. string userId = 1; // 用户id
  94. int64 msgType = 2; //分类 1:客服 2:系统通知 3:营销 4:用户会话
  95. string appid = 3; //应用标识
  96. }
  97. message GetLastMessageRes {
  98. int64 code = 1; //状态码
  99. string message = 2; //响应消息
  100. Messages data = 3; //
  101. }
  102. // 获取用户分类的的未读消息分类及数量 及分类下最新的消息
  103. message GetUnreadClassCountReq {
  104. string userId = 1; // 用户id
  105. string appid = 2; //应用标识
  106. }
  107. message GetUnreadClassCountRes {
  108. int64 code = 1; //状态码
  109. string message = 2; //响应消息
  110. repeated ResCount data = 3; //
  111. repeated Messages info = 4; // 每个类型最新消息列表
  112. }
  113. message GetMsgTypeReq {
  114. string userId = 1; // 用户id
  115. string appid = 2; //应用标识
  116. }
  117. message GetMsgTypeRes {
  118. int64 code = 1; //状态码
  119. string message = 2; //响应消息
  120. repeated int64 data = 3; //
  121. }
  122. //更新分类下消息状态 已读、未读
  123. message UpdateMessageReadReq {
  124. int64 msgType = 1;
  125. string receiveUserid = 2;
  126. string appId = 3;
  127. }
  128. message UpdateMessageReadResp {
  129. int64 code = 1; //状态码
  130. string message = 2; //响应消息
  131. int64 status = 3;
  132. }
  133. service Message {
  134. // 修改消息阅读状态
  135. rpc ChangeReadStatus (ChangeReadStatusRequest) returns (Response);
  136. //指定用户发消息
  137. rpc SendUserMsg (SendMsgRequest) returns (Response);
  138. // 删除单一消息
  139. rpc DeleteSingleMessage (DeleteSingleMessageRequest) returns (Response);
  140. // 删除多条消息
  141. rpc DeleteMultipleMessage (DeleteMultipleMessageRequest) returns (Response);
  142. // 查询指定用户未读消息合计
  143. rpc GetUnreadCount (GetUnreadCountRequest) returns (GetUnreadCountResponse);
  144. // 查询指定用户的历史消息记录
  145. rpc FindUserMsg (FindUserMsgReq) returns (FindUserMsgRes);
  146. // 查询指定用户指定分类的未读消息合计
  147. rpc GetClassUnreadCount (GetClassUnreadCountReq) returns (GetUnreadCountResponse);
  148. // 获取指定用户指定分类的最新一条未读消息
  149. rpc GetLastMessage (GetLastMessageReq) returns (GetLastMessageRes);
  150. //查看详细详情
  151. rpc FindMessageDetail (MessageDetailReq) returns (MessageDetailResp);
  152. // 获取指定用户的未读消息分类及数量 及分类的最新消息
  153. rpc GetUnreadClassCount (GetUnreadClassCountReq) returns (GetUnreadClassCountRes);
  154. // 获取指定用户收到消息的分类
  155. rpc GetMsgType (GetMsgTypeReq) returns (GetMsgTypeRes);
  156. //修改用户指定分类下的消息已读未读
  157. rpc UpdateMessageRead (UpdateMessageReadReq) returns (UpdateMessageReadResp);
  158. }