ws.proto 7.7 KB
Newer Older
1
syntax = "proto3";
W
wenxu12345 已提交
2
package server_api_params;//The package name to which the proto file belongs
programor_guo's avatar
programor_guo 已提交
3
//option go_package = "./sdk_ws;open_im_sdk";//The generated go pb file is in the current directory, and the package name is open_im_sdk
4

W
wenxu12345 已提交
5 6 7 8
////////////////////////////////base///////////////////////////////


message GroupInfo{
programor_guo's avatar
programor_guo 已提交
9 10 11 12 13 14 15 16 17 18 19 20
  string groupID = 1;
  string groupName = 2;
  string notification = 3;
  string introduction = 4;
  string faceURL = 5;
  string ownerUserID = 6;
  uint32 createTime = 7;
  uint32 memberCount = 8;
  string ex = 9;
  int32 status = 10;
  string creatorUserID = 11;
  int32 groupType = 12;
W
wenxu12345 已提交
21 22
}

W
wenxu12345 已提交
23

W
wenxu12345 已提交
24
message GroupMemberFullInfo {
programor_guo's avatar
programor_guo 已提交
25 26
  string groupID = 1 ;
  string userID = 2 ;
W
wenxu12345 已提交
27
  int32 roleLevel = 3;
programor_guo's avatar
programor_guo 已提交
28 29 30 31 32 33 34
  int64 joinTime = 4;
  string nickname = 5;
  string faceURL = 6;
  int32 appMangerLevel = 7; //if >0
  int32 joinSource = 8;
  string operatorUserID = 9;
  string ex = 10;
W
wenxu12345 已提交
35 36 37
}

message PublicUserInfo{
programor_guo's avatar
programor_guo 已提交
38 39 40 41 42
  string userID = 1;
  string nickname = 2;
  string faceURL = 3;
  int32 gender = 4;
  int32 appMangerLevel = 5; //if >0
W
wenxu12345 已提交
43 44 45
}

message UserInfo{
programor_guo's avatar
programor_guo 已提交
46 47 48 49 50 51 52 53 54 55
  string userID = 1;
  string nickname = 2;
  string faceURL = 3;
  int32 gender = 4;
  string phoneNumber = 5;
  uint32 birth = 6;
  string email = 7;
  string ex = 8;
  uint32 createTime = 9;
  int32 appMangerLevel = 10;
W
wenxu12345 已提交
56 57 58
}

message FriendInfo{
programor_guo's avatar
programor_guo 已提交
59 60 61 62 63 64 65
  string ownerUserID = 1;
  string remark = 2;
  uint32 createTime = 3;
  UserInfo friendUser = 4;
  int32 addSource = 5;
  string operatorUserID = 6;
  string ex = 7;
W
wenxu12345 已提交
66 67 68
}

message BlackInfo{
programor_guo's avatar
programor_guo 已提交
69 70 71 72 73 74
  string ownerUserID = 1;
  uint32 createTime = 2;
  PublicUserInfo blackUserInfo = 3;
  int32 addSource = 4;
  string operatorUserID = 5;
  string ex = 6;
W
wenxu12345 已提交
75 76 77
}

message GroupRequest{
W
wenxu12345 已提交
78 79
  PublicUserInfo userInfo = 1;
  GroupInfo groupInfo = 2;
W
wenxu12345 已提交
80
  int32 handleResult = 3;
programor_guo's avatar
programor_guo 已提交
81 82 83 84 85 86
  string reqMsg = 4;
  string  handleMsg = 5;
  uint32 reqTime = 6;
  string handleUserID = 7;
  uint32 handleTime = 8;
  string ex = 9;
W
wenxu12345 已提交
87 88 89
}

message FriendRequest{
W
wenxu12345 已提交
90 91 92
  string fromUserID = 1;
  string fromNickname = 2;
  string fromFaceURL = 3;
W
wenxu12345 已提交
93
  int32 fromGender = 4;
W
wenxu12345 已提交
94 95 96
  string toUserID = 5;
  string toNickname = 6;
  string toFaceURL = 7;
W
wenxu12345 已提交
97
  int32 toGender = 8;
W
wenxu12345 已提交
98 99 100 101 102 103 104
  int32 handleResult = 9;
  string reqMsg = 10;
  uint32 createTime = 11;
  string handlerUserID = 12;
  string handleMsg = 13;
  uint32 handleTime = 14;
  string ex = 15;
W
wenxu12345 已提交
105 106 107 108
}

///////////////////////////////////base end/////////////////////////////////////

109 110

message PullMessageBySeqListResp {
programor_guo's avatar
programor_guo 已提交
111 112 113 114 115 116
  int32 errCode = 1;
  string errMsg = 2;
  int64 maxSeq = 3;
  int64 minSeq = 4;
  repeated GatherFormat singleUserMsg = 5;
  repeated GatherFormat groupUserMsg = 6;
117 118
}
message PullMessageBySeqListReq{
programor_guo's avatar
programor_guo 已提交
119 120
  string userID = 1;
  string operationID = 2;
W
wenxu12345 已提交
121
  repeated int64 seqList = 3;
programor_guo's avatar
programor_guo 已提交
122 123 124 125 126 127 128 129 130 131 132 133 134 135
}
message PullMessageReq {
  string userID = 1;
  int64 seqBegin = 2;
  int64 seqEnd = 3;
  string operationID = 4;
}
message PullMessageResp {
  int32 errCode = 1;
  string errMsg = 2;
  int64 maxSeq = 3;
  int64 minSeq = 4;
  repeated GatherFormat singleUserMsg = 5;
  repeated GatherFormat groupUserMsg = 6;
136 137 138 139 140 141 142 143 144
}
message GetMaxAndMinSeqReq {
}
message GetMaxAndMinSeqResp {
  int64 maxSeq = 1;
  int64 minSeq = 2;
}
message GatherFormat{
  // @inject_tag: json:"id"
programor_guo's avatar
programor_guo 已提交
145
  string id = 1;
146
  // @inject_tag: json:"list"
programor_guo's avatar
programor_guo 已提交
147
  repeated MsgData list = 2;//detail msg
148
}
programor_guo's avatar
programor_guo 已提交
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
//message MsgFormat{
//  // @inject_tag: json:"sendID"
//  string SendID = 1;
//  // @inject_tag: json:"recvID"
//  string RecvID = 2;
//  // @inject_tag: json:"msgFrom"
//  int32 MsgFrom = 3;
//  // @inject_tag: json:"contentType"
//  int32 ContentType = 4;
//  // @inject_tag: json:"serverMsgID"
//  string ServerMsgID = 5;
//  // @inject_tag: json:"content"
//  string Content = 6;
//  // @inject_tag: json:"seq"
//  int64 Seq = 7;
//  // @inject_tag: json:"sendTime"
//  int64 SendTime = 8;
//  // @inject_tag: json:"senderPlatformID"
//  int32 SenderPlatformID = 9;
//  // @inject_tag: json:"senderNickName"
//  string SenderNickName = 10;
//  // @inject_tag: json:"senderFaceUrl"
//  string SenderFaceURL = 11;
//  // @inject_tag: json:"clientMsgID"
//  string ClientMsgID = 12;
//}
175 176 177


message UserSendMsgResp {
programor_guo's avatar
programor_guo 已提交
178 179
  string serverMsgID = 1;
  string clientMsgID = 2;
180 181 182 183 184 185
  int64  sendTime = 3;

}
message MsgData {
  string  sendID = 1;
  string  recvID = 2;
programor_guo's avatar
programor_guo 已提交
186
  string groupID = 3;
W
wenxu12345 已提交
187 188 189 190 191
  string clientMsgID = 4;
  string serverMsgID = 5;
  int32 senderPlatformID = 6;
  string  senderNickname = 7;
  string  senderFaceURL = 8;
programor_guo's avatar
programor_guo 已提交
192 193 194
  int32   sessionType = 9;
  int32 msgFrom = 10;
  int32 contentType = 11;
W
wenxu12345 已提交
195 196
  bytes content = 12;
  int64 seq = 14;
programor_guo's avatar
programor_guo 已提交
197 198
  int64 sendTime = 15;
  int64 createTime = 16;
programor_guo's avatar
programor_guo 已提交
199 200 201
  int32 status = 17;
  map<string, bool> options = 18;
  OfflinePushInfo offlinePushInfo = 19;
202 203
}

W
wenxu12345 已提交
204
message OfflinePushInfo{
programor_guo's avatar
programor_guo 已提交
205 206 207
  string title = 1;
  string desc = 2;
  string ex = 3;
W
wenxu12345 已提交
208 209
  string iOSPushSound = 4;
  bool iOSBadgeCount = 5;
W
wenxu12345 已提交
210 211
}

W
pb  
wenxu12345 已提交
212 213


W
wenxu12345 已提交
214 215


W
wenxu12345 已提交
216 217 218



W
wenxu12345 已提交
219 220

message TipsComm{
programor_guo's avatar
programor_guo 已提交
221 222
  bytes detail = 1;
  string defaultTips = 2;
W
wenxu12345 已提交
223 224 225
}

//////////////////////group/////////////////////
W
wenxu12345 已提交
226 227 228 229


//	OnGroupCreated()
message GroupCreatedTips{
programor_guo's avatar
programor_guo 已提交
230
  GroupInfo group = 1;
W
wenxu12345 已提交
231
  GroupMemberFullInfo opUser = 2;
W
wenxu12345 已提交
232 233
  repeated GroupMemberFullInfo memberList = 3;
  int64 operationTime = 4;
W
wenxu12345 已提交
234
  GroupMemberFullInfo groupOwnerUser = 5;
W
wenxu12345 已提交
235 236 237
}

//	OnGroupInfoSet()
W
wenxu12345 已提交
238
message GroupInfoSetTips{
W
wenxu12345 已提交
239 240 241
  GroupMemberFullInfo opUser = 1; //who do this
  int64 muteTime = 2;
  GroupInfo group = 3;
W
wenxu12345 已提交
242 243
}

W
wenxu12345 已提交
244 245 246 247
//	OnJoinGroupApplication()
message JoinGroupApplicationTips{
  GroupInfo group = 1;
  PublicUserInfo applicant = 2;
W
wenxu12345 已提交
248
  string  reqMsg = 3;
W
wenxu12345 已提交
249 250 251
}

//	OnQuitGroup()
W
wenxu12345 已提交
252
//Actively leave the group
W
wenxu12345 已提交
253
message MemberQuitTips{
programor_guo's avatar
programor_guo 已提交
254
  GroupInfo group = 1;
W
wenxu12345 已提交
255
  GroupMemberFullInfo quitUser = 2;
programor_guo's avatar
programor_guo 已提交
256
  int64 operationTime = 3;
W
wenxu12345 已提交
257 258
}

W
wenxu12345 已提交
259 260 261

//	OnApplicationGroupAccepted()
message GroupApplicationAcceptedTips{
programor_guo's avatar
programor_guo 已提交
262 263
  GroupInfo group = 1;
  GroupMemberFullInfo opUser = 2;
W
wenxu12345 已提交
264
  string  handleMsg = 4;
W
wenxu12345 已提交
265 266
}

W
wenxu12345 已提交
267 268
//	OnApplicationGroupRejected()
message GroupApplicationRejectedTips{
programor_guo's avatar
programor_guo 已提交
269 270
  GroupInfo group = 1;
  GroupMemberFullInfo opUser = 2;
W
wenxu12345 已提交
271
  string  handleMsg = 4;
W
wenxu12345 已提交
272 273
}

W
wenxu12345 已提交
274 275
//	OnTransferGroupOwner()
message GroupOwnerTransferredTips{
programor_guo's avatar
programor_guo 已提交
276
  GroupInfo group = 1;
W
wenxu12345 已提交
277 278
  GroupMemberFullInfo opUser = 2;
  GroupMemberFullInfo newGroupOwner = 3;
programor_guo's avatar
programor_guo 已提交
279
  int64 operationTime = 4;
W
wenxu12345 已提交
280 281
}

W
pb  
wenxu12345 已提交
282

W
wenxu12345 已提交
283
//	OnMemberKicked()
W
wenxu12345 已提交
284
message MemberKickedTips{
programor_guo's avatar
programor_guo 已提交
285 286 287 288
  GroupInfo group = 1;
  GroupMemberFullInfo opUser = 2;
  repeated GroupMemberFullInfo kickedUserList = 3;
  int64 operationTime = 4;
W
wenxu12345 已提交
289 290
}

W
wenxu12345 已提交
291 292
//	OnMemberInvited()
message MemberInvitedTips{
programor_guo's avatar
programor_guo 已提交
293 294
  GroupInfo group = 1;
  GroupMemberFullInfo opUser = 2;
W
wenxu12345 已提交
295
  repeated GroupMemberFullInfo invitedUserList = 3;
programor_guo's avatar
programor_guo 已提交
296
  int64 operationTime = 4;
W
wenxu12345 已提交
297 298
}

W
wenxu12345 已提交
299
//Actively join the group
W
wenxu12345 已提交
300 301 302 303 304
message MemberEnterTips{
  GroupInfo group = 1;
  GroupMemberFullInfo entrantUser = 2;
  int64 operationTime = 3;
}
W
wenxu12345 已提交
305 306 307 308 309 310 311 312 313 314










W
wenxu12345 已提交
315 316

//////////////////////friend/////////////////////
W
wenxu12345 已提交
317 318 319 320 321 322
//message FriendInfo{
//  UserInfo OwnerUser = 1;
//  string Remark = 2;
//  uint64 CreateTime = 3;
//  UserInfo FriendUser = 4;
//}
W
pb  
wenxu12345 已提交
323

W
wenxu12345 已提交
324
message FriendApplication{
programor_guo's avatar
programor_guo 已提交
325 326 327
  int64 addTime = 1;
  string addSource = 2;
  string addWording = 3;
W
wenxu12345 已提交
328 329
}

W
wenxu12345 已提交
330
message FromToUserID{
programor_guo's avatar
programor_guo 已提交
331 332
  string fromUserID = 1;
  string toUserID = 2;
W
wenxu12345 已提交
333 334 335
}

//FromUserID apply to add ToUserID
W
wenxu12345 已提交
336
message FriendApplicationTips{
programor_guo's avatar
programor_guo 已提交
337
  FromToUserID fromToUserID = 1;
W
wenxu12345 已提交
338
}
W
pb  
wenxu12345 已提交
339

W
wenxu12345 已提交
340
//FromUserID accept or reject ToUserID
W
wenxu12345 已提交
341
message FriendApplicationApprovedTips{
programor_guo's avatar
programor_guo 已提交
342
  FromToUserID fromToUserID = 1;
W
wenxu12345 已提交
343
  string handleMsg = 2;
W
wenxu12345 已提交
344
}
W
pb  
wenxu12345 已提交
345

W
wenxu12345 已提交
346
//FromUserID accept or reject ToUserID
W
wenxu12345 已提交
347
message FriendApplicationRejectedTips{
programor_guo's avatar
programor_guo 已提交
348
  FromToUserID fromToUserID = 1;
W
wenxu12345 已提交
349
   string handleMsg = 2;
W
pb  
wenxu12345 已提交
350 351
}

W
wenxu12345 已提交
352

W
wenxu12345 已提交
353
// FromUserID  Added a friend ToUserID
W
wenxu12345 已提交
354
message FriendAddedTips{
programor_guo's avatar
programor_guo 已提交
355 356 357
  FriendInfo friend = 1;
  int64 operationTime = 2;
  PublicUserInfo     opUser = 3;  //who do this
W
wenxu12345 已提交
358

W
wenxu12345 已提交
359
}
W
pb  
wenxu12345 已提交
360

W
wenxu12345 已提交
361
// FromUserID  deleted a friend ToUserID
W
wenxu12345 已提交
362
message FriendDeletedTips{
programor_guo's avatar
programor_guo 已提交
363
  FromToUserID fromToUserID = 1;
W
wenxu12345 已提交
364
}
W
pb  
wenxu12345 已提交
365

W
wenxu12345 已提交
366

W
wenxu12345 已提交
367 368

message BlackAddedTips{
programor_guo's avatar
programor_guo 已提交
369
  FromToUserID fromToUserID = 1;
W
wenxu12345 已提交
370
}
W
wenxu12345 已提交
371

W
wenxu12345 已提交
372
message BlackDeletedTips{
programor_guo's avatar
programor_guo 已提交
373
  FromToUserID fromToUserID = 1;
W
wenxu12345 已提交
374 375 376
}

message FriendInfoChangedTips{
programor_guo's avatar
programor_guo 已提交
377
  FromToUserID fromToUserID = 1;
W
wenxu12345 已提交
378 379
}
//////////////////////user/////////////////////
W
wenxu12345 已提交
380
message UserInfoUpdatedTips{
programor_guo's avatar
programor_guo 已提交
381
  string userID = 1;
W
wenxu12345 已提交
382
}