蛋蛋星球 后台端
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.

logic.ext.proto 8.6 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. syntax = "proto3";
  2. package pb;
  3. option go_package = "egg-im/pkg/pb/";
  4. import "business.ext.proto";
  5. import "common.ext.proto";
  6. import "connect.ext.proto";
  7. service LogicExt {
  8. // 注册设备
  9. rpc RegisterDevice (RegisterDeviceReq) returns (RegisterDeviceResp);
  10. // 发送消息
  11. rpc SendMessage (SendMessageReq) returns (SendMessageResp);
  12. // 撤回消息
  13. rpc RecallMessage (RecallMessageReq) returns (RecallMessageResp);
  14. // 推送消息到房间
  15. rpc PushRoom(PushRoomReq)returns(Empty);
  16. // 发送红包
  17. rpc SendRedPacket (SendRedPacketReq) returns (SendRedPacketResp);
  18. // 添加好友
  19. rpc AddFriend (AddFriendReq) returns (Empty);
  20. // 同意添加好友
  21. rpc AgreeAddFriend (AgreeAddFriendReq) returns (Empty);
  22. // 删除好友
  23. rpc DeleteFriend (DeleteFriendReq) returns (Empty);
  24. // 设置好友信息
  25. rpc SetFriend (SetFriendReq) returns (SetFriendResp);
  26. // 获取好友列表
  27. rpc GetFriends (Empty) returns (GetFriendsResp);
  28. // 创建群组
  29. rpc CreateGroup (CreateGroupReq) returns (CreateGroupResp);
  30. // 更新群组
  31. rpc UpdateGroup (UpdateGroupReq) returns (Empty);
  32. // 获取群组信息
  33. rpc GetGroup (GetGroupReq) returns (GetGroupResp);
  34. // 获取用户加入的所有群组
  35. rpc GetGroups (Empty) returns (GetGroupsResp);
  36. // 添加群组成员
  37. rpc AddGroupMembers (AddGroupMembersReq) returns (AddGroupMembersResp);
  38. // 更新群组成员信息
  39. rpc UpdateGroupMember (UpdateGroupMemberReq) returns (Empty);
  40. // 删除群组成员
  41. rpc DeleteGroupMember (DeleteGroupMemberReq) returns (Empty);
  42. // 获取群组成员
  43. rpc GetGroupMembers (GetGroupMembersReq) returns (GetGroupMembersResp);
  44. // 设置禁言
  45. rpc SetGroupBannedMembers (SetGroupMemberBannedReq) returns (SetGroupMemberBannedResp);
  46. // 取消禁言
  47. rpc SetGroupRemoveBannedMembers (SetGroupMemberRemoveBannedReq) returns (Empty);
  48. // 获取群组禁言成员
  49. rpc GetGroupBannedMembers (GetGroupBannedMembersReq) returns (GetGroupBannedMembersResp);
  50. // 设置是否加好友
  51. rpc SetGroupAddFriend (SetGroupAddFriendReq) returns (Empty);
  52. }
  53. message RegisterDeviceReq {
  54. int32 type = 2; // 设备类型
  55. string brand = 3; // 厂商
  56. string model = 4; // 机型
  57. string system_version = 5; // 系统版本
  58. string sdk_version = 6; // sdk版本号
  59. }
  60. message RegisterDeviceResp {
  61. int64 device_id = 1; // 设备id
  62. }
  63. message SendMessageReq {
  64. ReceiverType receiver_type = 1; // 接收者类型,1:user;2:group
  65. int64 receiver_id = 2; // 用户id或者群组id
  66. repeated int64 to_user_ids = 3; // 需要@的用户id列表
  67. MessageType message_type = 4; // 消息类型
  68. bytes message_content = 5; // 消息内容
  69. int64 send_time = 6; // 消息发送时间戳,精确到毫秒
  70. bool is_persist = 7; // 是否将消息持久化到数据库
  71. string message_content_back = 8;
  72. }
  73. message SendMessageResp {
  74. int64 seq = 1; // 消息序列号
  75. }
  76. message RecallMessageReq {
  77. ReceiverType receiver_type = 1; // 接收者类型,1:user;2:group
  78. int64 receiver_id = 2; // 用户id或者群组id
  79. repeated int64 to_user_ids = 3; // 需要@的用户id列表
  80. MessageType message_type = 4; // 消息类型
  81. bytes message_content = 5; // 消息内容
  82. int64 send_time = 6; // 消息发送时间戳,精确到毫秒
  83. bool is_persist = 7; // 是否将消息持久化到数据库
  84. string message_content_back = 8;
  85. }
  86. message RecallMessageResp {
  87. int64 seq = 1; // 消息序列号
  88. }
  89. message SendRedPacketReq {
  90. ReceiverType receiver_type = 1; // 接收者类型,1:user;2:group
  91. int64 receiver_id = 2; // 用户id或者群组id
  92. MessageType message_type = 3; // 消息类型
  93. bytes message_content = 4; // 消息内容
  94. int64 send_time = 5; // 消息发送时间戳,精确到毫秒
  95. repeated int64 to_user_ids = 6; // 红包给到哪些用户(专属红包)
  96. string message_content_back = 7;
  97. }
  98. message SendRedPacketResp {
  99. int64 seq = 1; // 消息序列号
  100. }
  101. message PushRoomReq{
  102. int64 room_id = 1; // 房间id
  103. MessageType message_type = 2; // 消息类型
  104. bytes message_content = 3; // 消息内容
  105. int64 send_time = 4; // 消息发送时间戳,精确到毫秒
  106. bool is_persist = 5; // 是否将消息持久化
  107. bool is_priority = 6; // 是否优先推送
  108. }
  109. message AddFriendReq {
  110. int64 friend_id = 1; // 用户id
  111. string remarks = 2; // 备注
  112. string description = 3; // 描述
  113. }
  114. message DeleteFriendReq {
  115. int64 user_id = 1; // 用户id
  116. }
  117. message AgreeAddFriendReq {
  118. int64 user_id = 1; // 用户id
  119. string remarks = 2; // 备注
  120. }
  121. message SetFriendReq {
  122. int64 friend_id = 1; // 好友id
  123. string remarks = 2; // 备注
  124. string extra = 8; // 附加字段
  125. }
  126. message SetFriendResp {
  127. int64 friend_id = 1; // 好友id
  128. string remarks = 2; // 备注
  129. string extra = 8; // 附加字段
  130. }
  131. message Friend {
  132. int64 user_id = 1; // 用户id
  133. string phone_number = 2; // 电话号码
  134. string nickname = 3; // 昵称
  135. int32 sex = 4; // 性别
  136. string avatar_url = 5; // 头像地址
  137. string user_extra = 6; // 用户附加字段
  138. string remarks = 7; // 备注
  139. string extra = 8; // 附加字段
  140. }
  141. message GetFriendsResp {
  142. repeated Friend friends = 1;
  143. }
  144. message CreateGroupReq {
  145. string name = 1; // 名称
  146. string avatar_url = 2; // 头像
  147. string introduction = 3; // 简介
  148. string extra = 4; // 附加字段
  149. repeated int64 member_ids = 5; // 群组成员ID列表
  150. }
  151. message CreateGroupResp {
  152. int64 group_id = 1; // 群组id
  153. }
  154. message UpdateGroupReq {
  155. int64 group_id = 1; // 群组id
  156. string avatar_url = 2; // 头像
  157. string name = 3; // 名称
  158. string introduction = 4; // 简介
  159. string extra = 5; // 附加字段
  160. }
  161. message GetGroupReq {
  162. int64 group_id = 1;
  163. }
  164. message GetGroupResp {
  165. Group group = 1;
  166. MemberType member_type = 2;
  167. GroupUserStatusType group_user_status_type = 3;
  168. GroupNotice group_notice = 4; //群公告
  169. }
  170. message GroupNotice {
  171. string content = 1; //公告内容
  172. GroupNoticePublishType publish_type = 2; // 发布方式
  173. string publish_time = 3; // 发布时间
  174. }
  175. message Group {
  176. int64 group_id = 1; // 群组id
  177. string name = 2; // 名称
  178. string avatar_url = 3; // 头像
  179. string introduction = 4; // 简介
  180. int32 user_mum = 5; // 用户数
  181. int32 is_all_member_banned = 6; // 是否全员禁言(1:是 2:否)
  182. int32 is_all_add_friend = 10; // 是否允许加好友(1:是 2:否)
  183. string extra = 7; // 附加字段
  184. int64 create_time = 8; // 创建时间
  185. int64 update_time = 9; // 更新时间
  186. }
  187. message GetGroupsResp {
  188. repeated Group groups = 1;
  189. }
  190. message AddGroupMembersReq {
  191. int64 group_id = 1; // 群组id
  192. repeated int64 user_ids = 2; // 用户id列表
  193. }
  194. message AddGroupMembersResp {
  195. repeated int64 user_ids = 1; // 已经在群组的用户id列表
  196. }
  197. enum MemberType {
  198. GMT_UNKNOWN = 0; // 未知
  199. GMT_ADMIN = 1; // 群主
  200. GMT_MEMBER = 2; // 成员
  201. GMT_MANAGE = 3; // 管理员
  202. }
  203. message UpdateGroupMemberReq {
  204. int64 group_id = 1; // 群组id
  205. int64 user_id = 2; // 用户id
  206. MemberType member_type = 3; // 成员类型
  207. string remarks = 4; // 备注
  208. string extra = 5; // 附加字段
  209. }
  210. message DeleteGroupMemberReq {
  211. int64 group_id = 1; // 群组id
  212. int64 user_id = 2; // 用户id
  213. }
  214. message GetGroupMembersReq {
  215. int64 group_id = 1;
  216. int64 limit = 2;
  217. }
  218. message GetGroupMembersResp {
  219. repeated GroupMember members = 1;
  220. }
  221. message GroupMember {
  222. int64 user_id = 1;
  223. string nickname = 2; // 昵称
  224. int32 sex = 3; // 性别
  225. string avatar_url = 4; // 头像地址
  226. string user_extra = 5; // 用户附加字段
  227. MemberType member_type = 6; // 成员类型
  228. string remarks = 7; // 备注
  229. string extra = 8; // 群组成员附加字段
  230. int32 status = 9; // 状态
  231. }
  232. message SetGroupMemberBannedReq {
  233. int64 group_id = 1; // 群组id
  234. repeated int64 user_ids = 2; // 用户id列表
  235. AllMemberBannedType is_all_member_banned = 3; // 全员禁言(1:是 2:否)
  236. }
  237. message SetGroupMemberRemoveBannedReq {
  238. int64 group_id = 1; // 群组id
  239. repeated int64 remove_user_ids = 2; // 解除用户id列表
  240. }
  241. enum AllMemberBannedType {
  242. UNKNOWN_All_Member_Banned = 0; // 未知
  243. YES_All_Member_Banned = 1; // 是-全员禁言
  244. NOT_All_Member_Banned = 2; // 否-全员禁言
  245. }
  246. message SetGroupMemberBannedResp {
  247. AllMemberBannedType is_all_member_banned = 3; // 全员禁言(1:是 2:否)
  248. repeated GroupMember members = 1; //禁言人员列表
  249. }
  250. message GetGroupBannedMembersReq {
  251. int64 group_id = 1;
  252. }
  253. message GetGroupBannedMembersResp {
  254. repeated GroupMember members = 1;
  255. }
  256. enum AllAddFriendType {
  257. UNKNOWN_All_Add_Friend = 0; // 未知
  258. YES_All_Add_Friend = 1; // 是-允许加好友
  259. NOT_All_Add_Friend = 2; // 否-禁止加好友
  260. }
  261. message SetGroupAddFriendReq {
  262. int64 group_id = 1; // 群组id
  263. AllAddFriendType is_all_add_friend = 2; // 是否允许加好友(1:是 2:否)
  264. }