message.proto 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313
  1. syntax = "proto3";
  2. //option java_package = "com.shiku.imserver.common.proto";//写的是生成文件的包名
  3. //option java_outer_classname = "MessageProBuf";//生成的类文件名
  4. package Message;
  5. //required optional repeated
  6. //消息 数据
  7. message MessageHead
  8. {
  9. /**
  10. *发送者;
  11. */
  12. string from = 1;
  13. /**
  14. * 接受者;
  15. */
  16. string to = 2;
  17. /**
  18. * 消息id
  19. *
  20. */
  21. string messageId = 3;
  22. /**
  23. * 聊天类型;(单聊,群聊)
  24. */
  25. int32 chatType = 4;
  26. /**
  27. *是否离线消息 true 离线消息
  28. */
  29. bool offline = 5;
  30. }
  31. //消息的 body
  32. message ChatMessage
  33. {
  34. MessageHead messageHead=1;
  35. string fromUserId = 2;
  36. string fromUserName= 3;
  37. string toUserId= 4;
  38. string toUserName= 5;
  39. /**
  40. *
  41. * 消息发送时间
  42. */
  43. int64 timeSend= 6;
  44. /**
  45. * 消息类型;
  46. */
  47. int32 type= 7;
  48. /**
  49. * 消息内容;
  50. */
  51. string content=8;
  52. /**
  53. * 消息发到哪个群组;
  54. */
  55. string objectId=9;
  56. string fileName=10;
  57. // 是否加密传输
  58. bool isEncrypt=11;
  59. int64 deleteTime=12;
  60. // 是否阅后即焚
  61. bool isReadDel=13;
  62. int64 fileSize=14; // 文件大小 单位字节
  63. int64 fileTime=15; // 文件播放时长 录音时长,视频时长
  64. // 1.当为地理位置时,有效 2.特殊:当为图片时,该值为图片的宽度
  65. double location_x=16;
  66. // 1.当为地理位置时,有效 2.特殊:当为图片时,该值为图片的高度
  67. double location_y=17;
  68. }
  69. /**
  70. * 登陆授权消息
  71. */
  72. message AuthMessage
  73. {
  74. MessageHead messageHead=1;
  75. string token = 2;
  76. string password = 3;
  77. }
  78. /**
  79. * 登陆授权消息结果
  80. */
  81. message AuthRespMessageProBuf
  82. {
  83. MessageHead messageHead=1;
  84. /**
  85. * 登陆结果 1 登陆 成功 0 登陆失败
  86. */
  87. int32 status=2;
  88. /*
  89. * 提示信息
  90. */
  91. string arg=3;
  92. string token=4;
  93. string resources=5;
  94. }
  95. /**
  96. * 消息回执
  97. */
  98. message MessageReceiptStatusProBuf
  99. {
  100. MessageHead messageHead=1;
  101. /**
  102. * 0 发送中 1 到达服务器
  103. * 2 已接收 3 已读
  104. */
  105. int32 status=2;
  106. /*
  107. * 提示信息
  108. */
  109. string messageId=3;
  110. }
  111. /**
  112. * 加入群组消息
  113. */
  114. message JoinGroupMessageProBuf
  115. {
  116. MessageHead messageHead=1;
  117. string jid = 2;
  118. int64 seconds = 3;
  119. }
  120. message ExitGroupMessageProBuf
  121. {
  122. MessageHead messageHead=1;
  123. string jid = 2;
  124. }
  125. /**
  126. * 群组协议结果
  127. */
  128. message GroupMessageRespProBuf
  129. {
  130. MessageHead messageHead=1;
  131. string jid = 2;
  132. /**
  133. * 1 成功
  134. * -1 失败
  135. */
  136. int32 status=3;
  137. /**
  138. * 是否退出群组协议
  139. */
  140. bool isExit=4;
  141. }
  142. /**
  143. * 漫游聊天记录
  144. */
  145. message PullMessageHistoryRecordReqProBuf
  146. {
  147. MessageHead messageHead=1;
  148. string jid = 2;
  149. /**
  150. * 请求数量
  151. */
  152. int32 size = 3;
  153. /**
  154. * 开始时间
  155. */
  156. int64 startTime = 4;
  157. /**
  158. * 结束时间
  159. */
  160. int64 endTime = 5;
  161. }
  162. /**
  163. * 漫游聊天记录 结果
  164. */
  165. message PullMessageHistoryRecordRespProBuf
  166. {
  167. /**
  168. * 请求ID 标识
  169. */
  170. string messageId = 1;
  171. string jid = 2;
  172. /**
  173. *
  174. */
  175. int32 chatType = 3;
  176. repeated ChatMessage messageList = 4;
  177. /**
  178. * 消息总数
  179. */
  180. int32 count = 5;
  181. }
  182. /**
  183. * 批量拉取群组消息数量
  184. */
  185. message PullBatchGroupMessageReqProBuf
  186. {
  187. MessageHead messageHead=1;
  188. /**
  189. * jid 群组jid lastTime 群组的最后一条消息时间
  190. * 群组数据集合["jid1,lastTime","jid2,lastTime"]
  191. */
  192. repeated string jidList = 2;
  193. /**
  194. *拉取消息的截止时间
  195. */
  196. int64 endTime = 3;
  197. }
  198. /**
  199. * 批量拉取群组消息数量 及最后几条消息 结果 (单个群组的)
  200. */
  201. message PullGroupMessageRespProBuf
  202. {
  203. /**
  204. * 请求ID 标识
  205. */
  206. string messageId = 1;
  207. /**
  208. *群组jid
  209. */
  210. string jid=2;
  211. /**
  212. *群组消息数量
  213. */
  214. int64 count = 3;
  215. /**
  216. *消息集合
  217. */
  218. repeated ChatMessage messageList = 4;
  219. }
  220. //心跳协议
  221. message PingMessageProBuf
  222. {
  223. MessageHead messageHead=1;
  224. }
  225. message CommonSuccessProBuf
  226. {
  227. MessageHead messageHead=1;
  228. }
  229. //错误协议
  230. message CommonErrorProBuf
  231. {
  232. MessageHead messageHead=1;
  233. int32 code = 2;
  234. string arg = 3; //错误参数,格式:xx,xxx,xxxx
  235. }