message.proto 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  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. string 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. string 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. string id = 13; //消息id
  71. int64 msgLogId = 14;
  72. }
  73. message FindUserMsgRes {
  74. int64 code = 1; //状态码
  75. string message = 2; //响应消息
  76. repeated Messages data = 3; //
  77. int64 count = 4; //总数
  78. }
  79. message GetClassUnreadCountReq {
  80. string userId = 1; // 用户id
  81. int64 msgType = 2; //分类 1:客服 2:系统通知 3:营销 4:用户会话
  82. string appid = 3; //应用标识
  83. }
  84. //查看消息内容
  85. message MessageDetailReq {
  86. string id = 1; //消息id
  87. }
  88. message MessageDetailResp {
  89. int64 code = 1; //状态码
  90. string message = 2; //响应消息
  91. Messages data = 3; //
  92. }
  93. message GetLastMessageReq {
  94. string userId = 1; // 用户id
  95. int64 msgType = 2; //分类 1:客服 2:系统通知 3:营销 4:用户会话
  96. string appid = 3; //应用标识
  97. int64 isRead = 4; // 0:未读 1:已读 -1 不区分
  98. }
  99. message GetLastMessageRes {
  100. int64 code = 1; //状态码
  101. string message = 2; //响应消息
  102. Messages data = 3; //
  103. }
  104. // 获取用户分类的的未读消息分类及数量 及分类下最新的消息
  105. message GetUnreadClassCountReq {
  106. string userId = 1; // 用户id
  107. string appid = 2; //应用标识
  108. bool needMsg = 3; //是否需要分类下的最新一条消息
  109. }
  110. message GetUnreadClassCountRes {
  111. int64 code = 1; //状态码
  112. string message = 2; //响应消息
  113. repeated ResCount data = 3; //
  114. repeated Messages info = 4; // 每个类型最新消息列表
  115. }
  116. message GetMsgTypeReq {
  117. string userId = 1; // 用户id
  118. string appid = 2; //应用标识
  119. }
  120. message GetMsgTypeRes {
  121. int64 code = 1; //状态码
  122. string message = 2; //响应消息
  123. repeated int64 data = 3; //
  124. }
  125. //更新分类下消息状态 已读、未读
  126. message UpdateMessageReadReq {
  127. int64 msgType = 1;
  128. string receiveUserid = 2;
  129. string appId = 3;
  130. }
  131. message UpdateMessageReadResp {
  132. int64 code = 1; //状态码
  133. string message = 2; //响应消息
  134. int64 status = 3;
  135. }
  136. message user {
  137. string userId = 1;
  138. string userName = 2;
  139. }
  140. message multipleSaveMsgReq {
  141. string userIds = 1;
  142. string userNames = 2;
  143. string sendUserId = 3; //发送方用户ID
  144. string sendName = 4; //发送方用户名
  145. string title = 5; //主题
  146. string content = 6; //内容
  147. int64 msgType = 7; //消息类型 1:客服 2:系统通知 3:营销 4:用户会话
  148. string link = 8; //跳转链接
  149. int64 citeId = 9; //引用id
  150. string appid = 10; //应用标识
  151. int64 msgLogId = 11;//消息记录表id
  152. }
  153. message multipleSaveMsgResp {
  154. int64 code = 1; //状态码
  155. string message = 2; //响应消息
  156. int64 errCount = 3; // 保存出错数量
  157. }
  158. service Message {
  159. //批量保存消息
  160. rpc multipleSaveMsg (multipleSaveMsgReq) returns (multipleSaveMsgResp);
  161. // 修改消息阅读状态
  162. rpc ChangeReadStatus (ChangeReadStatusRequest) returns (Response);
  163. //指定用户发消息
  164. rpc SendUserMsg (SendMsgRequest) returns (Response);
  165. // 删除单一消息
  166. rpc DeleteSingleMessage (DeleteSingleMessageRequest) returns (Response);
  167. // 删除多条消息
  168. rpc DeleteMultipleMessage (DeleteMultipleMessageRequest) returns (Response);
  169. // 查询指定用户未读消息合计
  170. rpc GetUnreadCount (GetUnreadCountRequest) returns (GetUnreadCountResponse);
  171. // 查询指定用户的历史消息记录
  172. rpc FindUserMsg (FindUserMsgReq) returns (FindUserMsgRes);
  173. // 查询指定用户指定分类的未读消息合计
  174. rpc GetClassUnreadCount (GetClassUnreadCountReq) returns (GetUnreadCountResponse);
  175. // 获取指定用户指定分类的最新一条消息
  176. rpc GetLastMessage (GetLastMessageReq) returns (GetLastMessageRes);
  177. //查看详细详情
  178. rpc FindMessageDetail (MessageDetailReq) returns (MessageDetailResp);
  179. // 获取指定用户的分类及未读消息数量
  180. rpc GetUnreadClassCount (GetUnreadClassCountReq) returns (GetUnreadClassCountRes);
  181. // 获取指定用户收到消息的分类
  182. rpc GetMsgType (GetMsgTypeReq) returns (GetMsgTypeRes);
  183. //修改用户指定分类下的消息已读未读
  184. rpc UpdateMessageRead (UpdateMessageReadReq) returns (UpdateMessageReadResp);
  185. }