package pb
Get desktop application:
View/edit binary Protocol Buffers messages
service accountService
user.proto:332rpc UserRegister (, )
user.proto:335UserRegister 用户注册 二次开发人员可以传递自定义参数 如果不满足你的需求 你可以修改该proto文件
message
user.proto:9UserRegisterReq 用户注册请求
optional header = 1
string userId = 2
用户id 唯一
optional int64 registerTime = 3
注册时间 13位时间戳 如果不传 默认为当前时间
optional string nickname = 4
昵称
optional string avatar = 5
头像url
map<string, string> accountMap = 6
账号信息 你可以存放password、email、phone等等
map<string, string> profileMap = 7
个人信息 你可以存放性别、年龄、生日等等
map<string, string> extraMap = 8
扩展信息 你可以存放等级、积分、金币等等
map<string, string> verifyMap = 9
验证信息 你可以存放smsCode、emailCode等等
message
user.proto:24UserRegisterResp 用户注册响应
optional header = 1
rpc UserDestroy (, )
user.proto:338UserDestroy 用户注销 注销逻辑可以从这里修改
message
user.proto:31UserDestroyReq 用户注销请求
optional header = 1
string userId = 2
// 用户id 唯一
message
user.proto:37UserDestroyResp 用户注销响应
optional header = 1
rpc UserAccessToken (, )
user.proto:341UserAccessToken 用户登录 登录逻辑可以从这里修改 默认是密码/手机号登录
message
user.proto:44UserAccessTokenReq 用户登录请求
optional header = 1
map<string, string> accountMap = 2
账号信息 你可以存放password、email、phone等等
map<string, string> verifyMap = 3
验证信息 你可以存放smsCode、emailCode等等
optional int64 expireTime = 4
过期时间 13位时间戳
message
user.proto:52UserAccessTokenResp 用户登录响应
optional header = 1
string userId = 2
用户id 唯一
string accessToken = 3
用户token
rpc RefreshUserAccessToken (, )
user.proto:344RefreshUserAccessToken 刷新用户token 刷新逻辑可以从这里修改
message
user.proto:61RefreshUserAccessTokenReq 刷新用户token请求
optional header = 1
string userId = 2
用户id 唯一
message
user.proto:67RefreshUserAccessTokenResp 刷新用户token响应
optional header = 1
rpc RevokeUserAccessToken (, )
user.proto:347RevokeUserAccessToken 注销用户token 注销逻辑可以从这里修改
message
user.proto:74RevokeUserAccessTokenReq 注销用户token
optional header = 1
message
user.proto:79RevokeUserAccessTokenResp 注销用户token
optional header = 1
rpc UpdateUserAccountMap (, )
user.proto:350UpdateUserAccountMap 更新用户账号信息 更新账号信息逻辑可以从这里修改 默认：如果是修改密码，需要旧密码或手机验证码。如果修改绑定手机号，需要验证新手机号的验证码
message
user.proto:86UpdateUserAccountMapReq 更新用户账号信息请求
optional header = 1
map<string, string> accountMap = 2
账号信息 你可以存放password、email、phone等等
map<string, string> verifyMap = 3
验证信息 你可以存放oldPassword、smsCode、emailCode等等
message
user.proto:93UpdateUserAccountMapResp 更新用户账号信息响应
optional header = 1
rpc ResetUserAccountMap (, )
user.proto:353ResetUserAccountMap 重置用户账号信息 重置账号信息逻辑可以从这里修改
message
user.proto:193ResetUserAccountMapReq 重置用户账号信息请求
optional header = 1
map<string, string> accountMap = 2
账号信息 你可以存放password、email、phone等等
map<string, string> verifyMap = 3
验证信息 你可以存放smsCode、emailCode等等
message
user.proto:200ResetUserAccountMapResp 重置用户账号信息响应
optional header = 1
rpc CreateRobot (, )
user.proto:356CreateRobot 创建机器人 创建机器人逻辑可以从这里修改
message
user.proto:279CreateRobotReq 创建机器人请求
optional header = 1
string robotId = 2
机器人id 唯一
optional string nickname = 3
昵称
optional string avatar = 4
头像url
message
user.proto:287CreateRobotResp 创建机器人响应
optional header = 1
string accessToken = 2
机器人token
service callbackService
user.proto:383rpc UserAfterOnline (, )
user.proto:386UserAfterOnline 用户上线回调 用户上线回调逻辑可以从这里修改
message
user.proto:207UserAfterOnlineReq 用户上线回调请求
optional header = 1
message
user.proto:212UserAfterOnlineResp 用户上线回调响应
optional header = 1
rpc UserAfterOffline (, )
user.proto:389UserAfterOffline 用户下线回调 用户下线回调逻辑可以从这里修改
message
user.proto:219UserAfterOfflineReq 用户下线回调请求
optional header = 1
string userId = 2
用户id 唯一
message
user.proto:225UserAfterOfflineResp 用户下线回调响应
optional header = 1
rpc UserBeforeConnect (, )
user.proto:392UserBeforeConnect 用户连接前的回调 用户连接前的回调逻辑可以从这里修改
message
user.proto:232UserBeforeConnectReq 服务端连接前的回调
optional header = 1
string userId = 2
用户id 唯一
string token = 3
用户token
message
user.proto:239UserBeforeConnectResp 服务端连接前的回调
optional header = 1
bool success = 2
是否允许建立连接
WebsocketCustomCloseCode closeCode = 3
如果不允许建立连接，返回的错误码
string closeReason = 4
如果不允许建立连接，返回的错误信息
string userId = 5
成功的话返回用户id
rpc UserBeforeRequest (, )
user.proto:395UserBeforeRequest 用户请求前的回调 用户请求前的回调逻辑可以从这里修改
message
user.proto:253UserBeforeRequestReq 用户请求前的回调请求
optional header = 1
string path = 2
请求路径
message
user.proto:259UserBeforeRequestResp 用户请求前的回调响应
optional header = 1
string userId = 2
用户id
rpc UserAfterKeepAlive (, )
user.proto:398UserAfterKeepAlive 用户保活回调 用户保活回调逻辑可以从这里修改
message
user.proto:267UserAfterKeepAliveReq 用户保活回调请求
optional header = 1
message
user.proto:272UserAfterKeepAliveResp 用户保活回调响应
optional header = 1
service captchaService
third.proto:153rpc GetCaptcha (, )
third.proto:156GetCaptcha 获取图形验证码 二次开发人员可以自行实现
message
third.proto:91GetCaptchaReq 获取图形验证码请求
optional header = 1
optional int64 expireTime = 2
过期时间
bool includeEnglish = 3
字符是否包含英文
bool includeNumber = 4
字符是否包含数字
int32 width = 5
宽度
int32 height = 6
高度
int32 charCount = 7
字符数量
message
third.proto:108GetCaptchaResp 获取图形验证码响应
optional header = 1
string captchaId = 2
验证码id
string captchaCode = 3
图形验证码
rpc CaptchaVerify (, )
third.proto:159CaptchaVerify 验证图形验证码 二次开发人员可以自行实现
message
third.proto:119CaptchaVerifyReq 验证图形验证码请求
optional header = 1
string captchaId = 2
验证码id
string captchaCode = 3
验证码
bool delete = 4
是否立刻删除 删除后再次验证会失败
message
third.proto:130CaptchaVerifyResp 验证图形验证码响应
optional header = 1
bool success = 2
ConversationSettingUpdate 更新会话设置
message
conversation.proto:200optional header = 1
message
conversation.proto:204optional header = 1
ListJoinedConversations 列出加入的会话
message
conversation.proto:210optional header = 1
ConversationType conversationType = 2
int64 cursor = 3
Cursor 游标
int64 limit = 4
Limit 限制
optional filter = 5
optional option = 6
message
conversation.proto:245optional header = 1
repeated conversationList = 3
service emailService
third.proto:144rpc EmailCodeSend (, )
third.proto:147EmailCodeSend 发送邮件 二次开发人员可以自行实现
message
third.proto:52EmailCodeSendReq 发送邮件请求
optional header = 1
string email = 2
邮件地址
string scene = 3
场景
optional int64 expireTime = 4
过期时间
message
third.proto:63EmailCodeSendResp 发送邮件响应
optional header = 1
rpc EmailCodeVerify (, )
third.proto:150EmailCodeVerify 验证邮件 二次开发人员可以自行实现
message
third.proto:70EmailCodeVerifyReq 验证邮件请求
optional header = 1
string email = 2
邮件地址
string scene = 3
场景
string emailCode = 4
验证码
bool delete = 5
是否立刻删除 删除后再次验证会失败
message
third.proto:83EmailCodeVerifyResp 验证邮件响应
optional header = 1
bool success = 2
rpc FriendApply (, )
conversation.proto:191FriendApply 添加好友
message
conversation.proto:111optional header = 1
string toUserId = 2
optional string message = 3
Message 附加消息
optional string answer = 4
Answer 附加回答
message
conversation.proto:120optional header = 1
FriendApplyHandle 处理好友申请
message
conversation.proto:126optional header = 1
string applyId = 2
bool agree = 3
Agree 是否同意
optional string firstMessage = 4
同意后发送的第一条消息
message
conversation.proto:135optional header = 1
ListFriendApply 列出好友申请
message
conversation.proto:141optional header = 1
int64 cursor = 2
Cursor 游标
int64 limit = 3
Limit 限制
optional filter = 4
optional option = 5
message
conversation.proto:159optional header = 1
int64 cursor = 2
Cursor 游标
repeated friendApplyList = 3
rpc CountFriend (, )
conversation.proto:197CountFriend 统计好友数量
message
conversation.proto:180CountFriendReq 统计好友数量
optional header = 1
message
conversation.proto:184optional header = 1
int64 count = 2
service gatewayService
gateway.proto:152GatewayGetUserConnection 获取用户的连接 二次开发人员不建议修改此处逻辑
message
gateway.proto:52GatewayGetUserConnectionReq 获取用户的连接
optional header = 1
string userId = 2
message
gateway.proto:57optional header = 1
repeated connections = 2
GatewayBatchGetUserConnection 批量获取用户的连接 二次开发人员建议不修改此处逻辑
message
gateway.proto:63GatewayBatchGetUserConnectionReq 批量获取用户的连接
optional header = 1
repeated string userIds = 2
message
gateway.proto:68optional header = 1
repeated connections = 2
GatewayGetConnectionByFilter 通过条件获取用户的连接 二次开发人员可以增加过滤条件
message
gateway.proto:78GatewayGetConnectionByFilterReq 根据过滤条件获取连接
optional header = 1
optional filter = 2
message
gateway.proto:83optional header = 1
repeated connections = 2
GatewayWriteDataToWs 向用户的连接写入数据 二次开发人员不建议修改此处逻辑
message
gateway.proto:89GatewayWriteDataToWsReq 写入数据到ws连接
optional header = 1
optional filter = 2
optional data = 3
GatewayWriteDataToWsWrapper 向用户的连接写入数据 二次开发人员不建议修改此处逻辑
message
gateway.proto:101GatewayWriteDataToWsWrapperReq 写入数据到ws连接
optional header = 1
optional filter = 2
optional data = 3
rpc GatewayKickWs (, )
gateway.proto:171GatewayKickWs 踢出用户的连接 二次开发人员可以在此处修改踢出用户连接的逻辑 比如踢出连接之前，先给用户发送一条消息
message
gateway.proto:108GatewayKickWsReq 踢出ws连接
optional header = 1
optional filter = 2
WebsocketCustomCloseCode closeCode = 3
string closeReason = 4
message
gateway.proto:115optional header = 1
repeated successConnections = 2
rpc GatewayKeepAlive (, )
gateway.proto:175KeepAlive 保持连接 客户端必须每隔 config.Websocket.KeepAliveSecond 秒发送一次心跳包 二次开发人员可以在这里修改逻辑，比如一致性算法安全校验等
message
gateway.proto:121GatewayKeepAliveReq 保持连接
optional header = 1
message
gateway.proto:125optional header = 1
rpc VerifyConnection (, )
gateway.proto:178VerifyConnection 验证连接 客户端拿着自己的公钥，请求网关，网关返回自己的公钥
message
gateway.proto:130VerifyConnectionReq 验证连接 客户端拿着自己的公钥，请求网关，网关返回自己的公钥
optional header = 1
bytes publicKey = 2
message
gateway.proto:135optional header = 1
bytes publicKey = 2
AuthenticationConnection 验证连接 客户端拿着userId token，鉴权连接
message
gateway.proto:141AuthenticationConnectionReq 验证连接 客户端拿着userId token，鉴权连接
optional header = 1
string userId = 2
string token = 3
message
gateway.proto:147optional header = 1
bool success = 2
rpc GroupCreate (, )
conversation.proto:88GroupCreate 创建群组
message
conversation.proto:8optional header = 1
optional string name = 2
optional string avatar = 3
repeated string memberList = 4
map<string, string> infoMap = 5
map<string, string> extraMap = 6
message
conversation.proto:17optional header = 1
string groupId = 2
rpc CountJoinGroup (, )
conversation.proto:90CountJoinGroup 统计加入的群组数量
message
conversation.proto:23CountJoinGroupReq 统计加入的群组数量
optional header = 1
message
conversation.proto:27optional header = 1
int64 count = 2
CountCreateGroup 统计创建的群组数量
message
conversation.proto:33CountCreateGroupReq 统计创建的群组数量
optional header = 1
message
conversation.proto:37optional header = 1
int64 count = 2
rpc GroupSubscribe (, )
conversation.proto:94GroupSubscribe 群组订阅
message
conversation.proto:44optional header = 1
message
conversation.proto:48optional header = 1
ListGroupSubscribers 列出群组订阅者
message
conversation.proto:53ListGroupSubscribersReq 列出群组订阅者
optional header = 1
string groupId = 2
GroupId 群组id
int64 cursor = 3
Cursor 游标
int64 limit = 4
Limit 限制
optional filter = 5
optional option = 6
message
conversation.proto:73optional header = 1
repeated subscriberList = 2
service infoService
user.proto:359rpc UpdateUserProfileMap (, )
user.proto:362UpdateUserProfileMap 更新用户个人信息 更新个人信息逻辑可以从这里修改
message
user.proto:100UpdateUserProfileMapReq 更新用户个人信息请求
optional header = 1
map<string, string> profileMap = 2
个人信息 你可以存放性别、年龄、生日等等
message
user.proto:106UpdateUserProfileMapResp 更新用户个人信息响应
optional header = 1
rpc UpdateUserExtraMap (, )
user.proto:365UpdateUserExtraMap 更新用户扩展信息 更新扩展信息逻辑可以从这里修改
message
user.proto:113UpdateUserExtraMapReq 更新用户扩展信息请求
optional header = 1
map<string, string> extraMap = 2
扩展信息 你可以存放等级、积分、金币等等
message
user.proto:119UpdateUserExtraMapResp 更新用户扩展信息响应
optional header = 1
rpc UpdateUserCountMap (, )
user.proto:368UpdateUserCountMap 更新用户计数信息 更新计数信息逻辑可以从这里修改
message
user.proto:124UpdateUserCountMapReq 更新用户计数信息请求
optional header = 1
UpdateUserCountMapReq.CountType countType = 2
UpdateUserCountMapReq.Algorithm algorithm = 3
int64 count = 4
bool statistics = 5
是否统计 统计后同步到数据库
message
user.proto:147UpdateUserCountMapResp 更新用户计数信息响应
optional header = 1
rpc GetSelfUserInfo (, )
user.proto:371GetSelfUserInfo 获取自己的用户信息 获取自己的用户信息逻辑可以从这里修改
message
user.proto:154GetSelfUserInfoReq 获取自己的用户信息请求
optional header = 1
message
user.proto:159GetSelfUserInfoResp 获取自己的用户信息响应
optional header = 1
string userId = 2
用户id 唯一
optional int64 registerTime = 3
注册时间 13位时间戳 如果不传 默认为当前时间
optional string nickname = 4
昵称
optional string avatar = 5
头像url
map<string, string> accountMap = 6
账号信息 你可以存放password、email、phone等等
map<string, string> profileMap = 7
个人信息 你可以存放性别、年龄、生日等等
map<string, string> extraMap = 8
扩展信息 你可以存放等级、积分、金币等等
rpc GetUserInfo (, )
user.proto:374GetUserInfo 获取用户信息 获取用户信息逻辑可以从这里修改
message
user.proto:174GetUserInfoReq 获取用户信息请求
optional header = 1
string userId = 2
用户id 唯一
message
user.proto:180GetUserInfoResp 获取用户信息响应
optional header = 1
string userId = 2
用户id 唯一
optional int64 registerTime = 3
注册时间 13位时间戳 如果不传 默认为当前时间
optional string nickname = 4
昵称
optional string avatar = 5
头像url
map<string, string> profileMap = 6
个人信息 你可以存放性别、年龄、生日等等
rpc GetUserModelById (, )
user.proto:377GetUserModelById 获取用户模型 获取用户模型逻辑可以从这里修改
message
user.proto:295GetUserModelReq 获取用户模型请求
optional header = 1
string userId = 2
用户id 唯一
optional opt = 3
message
user.proto:307GetUserModelByIdResp 获取用户模型响应
optional header = 1
bytes userModelJson = 2
用户模型json
bytes userSettingsJson = 3
用户设置json 他是map[string]usermodel.UserSetting的json
rpc GetUserModelByIds (, )
user.proto:380GetUserModelByIds 批量获取用户模型 批量获取用户模型逻辑可以从这里修改
message
user.proto:314GetUserModelByIdsReq 批量获取用户模型请求
optional header = 1
repeated string userIds = 2
用户id列表
optional opt = 3
message
user.proto:326GetUserModelByIdsResp 批量获取用户模型响应
optional header = 1
map<string, bytes> userModelJsons = 2
用户模型json列表
map<string, bytes> userSettingsJsons = 3
用户设置json列表 value是map[string]usermodel.UserSetting的json
service messageService
message.proto:96rpc MessageInsert (, )
message.proto:99MessageInsert 插入消息 二次开发时，需要实现该接口
message
message.proto:35MessageInsertReq 插入消息请求
optional header = 1
repeated messages = 2
消息
message
message.proto:42MessageInsertResp 插入消息响应
optional header = 1
rpc MessageSend (, )
message.proto:101MessageSend 发送消息
message
message.proto:7MessageSendReq 发送消息请求
optional header = 1
optional message = 2
消息
bool disableQueue = 3
禁止走队列
message
message.proto:16MessageSendResp 发送消息响应
optional header = 1
rpc MessageBatchSend (, )
message.proto:103MessageBatchSend 批量发送消息
message
message.proto:21MessageBatchSendReq 批量发送消息请求
optional header = 1
repeated messages = 2
消息
bool disableQueue = 3
禁止走队列
message
message.proto:30MessageBatchSendResp 批量发送消息响应
optional header = 1
rpc MessagePush (, )
message.proto:105MessagePush 推送消息
message
message.proto:47MessagePushReq 推送消息请求
optional header = 1
repeated message = 2
消息
message
message.proto:54MessagePushResp 推送消息响应
optional header = 1
service noticeService
message.proto:170rpc NoticeSend (, )
message.proto:172NoticeSend 通知发送
message
message.proto:131optional header = 1
rpc NoticeBatchSend (, )
message.proto:174NoticeBatchSend 通知批量发送
message
message.proto:137optional header = 1
repeated notices = 2
message
message.proto:142optional header = 1
rpc ListNotice (, )
message.proto:176ListNotice 获取通知列表
message
message.proto:148optional header = 1
repeated convList = 2
会话id
int64 SortGt = 3
SortGt 排序大于
int64 Limit = 4
Limit 限制条数
message
message.proto:164optional header = 1
repeated notices = 2
service smsService
third.proto:135rpc SmsCodeSend (, )
third.proto:138SmsCodeSend 发送短信 二次开发人员可以自行实现
message
third.proto:9SmsCodeSendReq 发送短信请求
optional header = 1
string phone = 2
手机号
string phoneCode = 3
手机国家区号
string scene = 4
短信场景
optional int64 expireTime = 5
过期时间
message
third.proto:22SmsCodeSendResp 发送短信响应
optional header = 1
rpc SmsCodeVerify (, )
third.proto:141SmsCodeVerify 验证短信 二次开发人员可以自行实现
message
third.proto:29SmsCodeVerifyReq 验证短信请求
optional header = 1
string phone = 2
手机号
string phoneCode = 3
手机国家区号
string scene = 4
短信场景
string smsCode = 5
验证码
bool delete = 6
是否立刻删除 删除后再次验证会失败
message
third.proto:44SmsCodeVerifyResp 验证短信响应
optional header = 1
bool success = 2
SubscriptionSubscribe 订阅号订阅
message
conversation.proto:270optional header = 1
message
conversation.proto:274optional header = 1
SubscriptionAfterOnline 订阅号在做用户上线后的操作
message
conversation.proto:280optional header = 1
message
conversation.proto:284optional header = 1
SubscriptionAfterOffline 订阅号在做用户下线后的操作
message
conversation.proto:289SubscriptionAfterOffline 订阅号在做用户下线后的操作
optional header = 1
string userId = 2
message
conversation.proto:294optional header = 1
UpsertUserSubscription 更新用户订阅的订阅号
message
conversation.proto:308optional header = 1
string subscriptionId = 2
SubscriptionId 订阅号id
optional userSubscription = 3
message
conversation.proto:315optional header = 1
DeleteUserSubscription 删除用户订阅的订阅号
message
conversation.proto:321optional header = 1
string subscriptionId = 2
SubscriptionId 订阅号id
message
conversation.proto:327optional header = 1
ListSubscriptionSubscribers 列出订阅号订阅者
message
conversation.proto:333optional header = 1
string subscriptionId = 2
SubscriptionId 订阅号id
int64 cursor = 3
Cursor 游标
int64 limit = 4
Limit 限制
optional filter = 5
optional option = 6
message
conversation.proto:353optional header = 1
repeated subscriberList = 2
service worldService
world.proto:14rpc WorldPostSubmit (, )
world.proto:16WorldPostSubmit 世界圈帖子发布
message
world.proto:6optional header = 1
message
world.proto:10optional header = 1
message
common.proto:61AlertActionData alert提示 永远有一个关闭按钮 以下描述的是另一个操作按钮
string title = 1
标题
string message = 2
消息
AlertActionData.ButtonType buttonType = 3
按钮类型
string buttonLabel = 4
按钮标签
string buttonData = 5
按钮数据
Used in:
NO_BUTTON = 0
无按钮
JUMP_URL = 1
跳转url
ConversationSettingKey 会话设置key
Used in:
IsPinned = 0
是否置顶
IsMuted = 1
是否免打扰
IsBlocked = 2
是否屏蔽
IsFolded = 3
是否折叠
ConversationAlias = 4
自己设置的会话备注
NicknameInConversation = 5
在会话中的昵称
ConversationType 会话类型
Used in: , , , ,
Single = 0
单聊
Group = 1
群聊
Subscription = 2
订阅号
FriendApplyStatus 好友申请状态
Used in:
Applying = 0
Applying 申请中
Accepted = 1
Accepted 已同意
Rejected = 2
Rejected 已拒绝
message
gateway.proto:7GatewayApiRequest http/私有协议 请求
optional header = 1
string requestId = 2
string path = 3
bytes body = 4
message
gateway.proto:15GatewayApiResponse http/私有协议 响应
Used in:
optional header = 1
string requestId = 2
string path = 3
bytes body = 4
message
gateway.proto:73Used in: , , ,
repeated string userIds = 1
message
gateway.proto:33GatewayWriteDataContent 写入数据内容
Used in: ,
GatewayWriteDataType dataType = 1
写入数据类型
optional response = 2
响应
optional message = 3
主动推送message
optional notice = 4
主动推送notice
message
gateway.proto:95Used as response type in: gatewayService.GatewayWriteDataToWs, gatewayService.GatewayWriteDataToWsWrapper
optional header = 1
repeated successConnections = 2
GatewayWriteDataType 写入数据类型
Used in:
Response = 0
返回响应
PushMessage = 1
主动推送message
PushNotice = 2
主动推送notice
message
user.proto:298Used in:
bool withUserSettings = 1
是否携带用户设置列表
repeated string userSettingKeys = 2
用户设置key列表 如果withUserSettings为false 则该字段无效
message
user.proto:317Used in:
bool withUserSettings = 1
是否携带用户设置列表
repeated string userSettingKeys = 2
用户设置key列表 如果withUserSettings为false 则该字段无效
message
conversation.proto:148Filter 过滤器
Used in:
optional FriendApplyStatus status = 1
message
conversation.proto:152Option 选项
Used in:
bool includeApplyByMe = 1
包含我发出的申请
message
conversation.proto:164List 列表
Used in:
string applyId = 1
ApplyId 申请id
string fromUserId = 2
FromUserId 申请人id
string toUserId = 3
ToUserId 被申请人id
string message = 4
Message 附加消息
string answer = 5
Answer 附加回答
message
conversation.proto:62Filter 过滤器
Used in:
int64 subscribeTimeGte = 1
subscribeTimeGte 订阅时间大于等于
message
conversation.proto:67Option 选项
Used in:
(message has no fields)
message
conversation.proto:77Cursor 游标 List 列表
Used in:
string userId = 1
UserId 用户id
int64 subscribeTime = 2
SubscribeTime 订阅时间
message
conversation.proto:219Filter 过滤器
Used in:
repeated settingList = 1
使用setting中的字段过滤
message
conversation.proto:220Used in:
ConversationSettingKey key = 1
string value = 2
SettingKV.Operator operator = 3
bool orNotExists = 4
bool orExists = 5
Used in:
Equal = 0
等于
NotEqual = 1
不等于
message
conversation.proto:237Option 选项
Used in:
bool includeSelfMemberInfo = 2
IncludeSelfMemberInfo 是否包含自己的成员信息
message
conversation.proto:248List 列表
Used in:
string conversationId = 1
ConversationId 会话id
ConversationType conversationType = 2
optional selfMemberInfo = 31
message
conversation.proto:252Used in:
int64 joinTime = 1
message
message.proto:150Used in:
string conversationId = 1
会话id
ConversationType conversationType = 2
会话类型
message
conversation.proto:342Filter 过滤器
Used in:
int64 subscribeTimeGte = 1
subscribeTimeGte 订阅时间大于等于
message
conversation.proto:347Option 选项
Used in:
(message has no fields)
message
conversation.proto:357Cursor 游标 List 列表
Used in:
string userId = 1
UserId 用户id
int64 subscribeTime = 2
SubscribeTime 订阅时间
message
gateway.proto:45LongConnection ws连接
Used in: , , , ,
optional header = 1
string podIp = 3
int64 connectTime = 4
message
common.proto:158Message 消息
Used in: , , , ,
string messageId = 1
MessageId 消息id 由服务端插入时生成
string uuid = 2
UUID 客户端生成的id 由客户端生成 在客户端保证唯一性
string conversationId = 3
发送到哪个会话
单聊: 那么该值为接受者的id；群聊：那么该值为群id；订阅号：那么该值为订阅号id
ConversationType conversationType = 4
会话类型
optional sender = 5
有可能是系统 那么该值为空
bytes content = 6
消息内容
MessageContentType contentType = 7
消息类型
int64 sendTime = 8
发送时间 由客户端生成
int64 insertTime = 9
插入时间 由服务端生成
int64 seq = 10
在会话中的消息顺序
optional option = 16
map<string, string> extraMap = 17
extraMap, example: {"platformSource": "windows"}
message
common.proto:194选项
Used in:
bool storageForServer = 1
服务端是否保存该消息
bool storageForClient = 2
客户端是否保存该消息
bool needDecrypt = 3
是否需要解密 （端对端加密技术，服务端无法解密）
bool countUnread = 4
消息是否需要计入未读数
message
common.proto:169发送者
Used in:
string id = 1
发送者id
string name = 2
发送者名称
string avatar = 3
发送者头像
string extra = 11
extra
message
message.proto:59MessageContentText 图文消息
repeated items = 1
items 图文消息
message
message.proto:60Used in:
Item.Type type = 1
类型
string text = 2
文本
optional image = 3
optional at = 4
message
message.proto:79@用户信息
Used in:
string userId = 1
用户id
string name = 2
用户名称, 渲染时先获取用户本地信息中的备注，如果没有备注，那么就显示该名称
message
message.proto:70图片
Used in:
string url = 1
图片地址
int32 width = 2
宽度
int32 height = 3
高度
Used in:
TEXT = 0
文本
IMAGE = 1
图片
AT = 2
@
MessageContentType 消息内容类型
Used in:
Text = 0
图文
Markdown = 1
Markdown
Image = 2
图片
Voice = 3
语音
Video = 4
视频
Typing = 101
正在输入
Read = 102
已读
Recall = 103
撤回
message
common.proto:210Notice 通知
Used in: , ,
string noticeId = 1
通知id 因为通知永远都是服务端发送给客户端的，所以通知id一定唯一。
string conversationId = 2
发送到哪个会话
单聊: 那么该值为发送者和接受者的id；群聊：那么该值为群id；订阅号：那么该值为订阅号id
ConversationType conversationType = 3
会话类型
string content = 4
通知内容
NoticeContentType contentType = 5
通知类型
int64 updateTime = 6
通知的更新时间
int64 sort = 7
排序
message
message.proto:111NoticeContentJoinNewGroup 通知内容-加入新群
string groupId = 1
message
message.proto:109NoticeContentNewFriendRequest 通知内容-新的好友请求
(message has no fields)
message
message.proto:115NoticeContentOnlineStatus 通知内容-用户在线状态
string userId = 1
用户id
bool online = 2
是在线还是离线
NoticeContentType 通知内容类型
Used in:
NewFriendRequest = 0
有新的好友请求
JoinNewGroup = 1
加入到了新群
OnlineStatus = 2
在线状态
message
message.proto:122Used as request type in: noticeService.NoticeSend
Used as field type in:
optional header = 1
optional notice = 2
repeated string userIds = 3
追加用户
bool broadcast = 4
是否广播
Platform 平台枚举
Used in:
IOS = 0
ios
ANDROID = 1
android
WEB = 2
web
WINDOWS = 3
windows
MAC = 4
mac
LINUX = 5
linux
Ipad = 6
ipad
AndroidPad = 7
android pad
message
common.proto:18RequestHeader 请求头
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
string appId = 1
应用id
string userId = 2
用户id
string clientIp = 3
客户端ip
string installId = 4
安装后向服务器注册的UUID
Platform platform = 5
平台
string deviceModel = 6
设备型号
string osVersion = 7
操作系统版本
string appVersion = 8
app版本
string extra = 9
额外信息
ResponseActionType 客户端收到响应后做的动作类型
Used in:
NONE_ACTION = 0
无动作
TOAST_ACTION = 1
toast提示
ALERT_ACTION = 2
alert提示
SECOND_AUTH_ACTION = 3
二次认证 一段时间内没有进行二次验证 而且此次是高危操作 此时客户端应该弹出二次验证界面 验证短信验证码
ResponseCode
Used in:
SUCCESS = 0
成功
INVALID_DATA = 1
无效的数据
UNAUTHORIZED = 2
未授权
FORBIDDEN = 3
禁止访问
INVALID_METHOD = 4
无效的方法
TIMEOUT = 5
超时
SERVER_ERROR = 6
服务器错误
message
common.proto:74ResponseHeader 响应头
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
ResponseCode code = 1
错误码
ResponseActionType actionType = 2
动作类型
string actionData = 3
动作数据 json字符串
string extra = 4
额外信息
message
common.proto:50ToastActionData toast提示 客户端根据level显示不同的颜色 可能持续不同的时间
ToastActionData.Level level = 1
级别
string message = 2
消息
Used in:
INFO = 0
信息
WARN = 1
警告
ERROR = 2
错误
Used in:
add = 0
加
sub = 1
减
fixed = 2
固定
Used in:
friendCount = 0
好友数量
joinGroupCount = 1
加入群数量
createGroupCount = 2
创建群数量
message
conversation.proto:299UserSubscription 用户订阅的订阅号
Used in:
string subscriptionId = 1
string Subscriber = 2
int64 subscribeTime = 3
map<string, string> extraMap = 6
WebsocketCustomCloseCode websocket关闭码 You can define custom codes in the 3000-4999 range. The 3000-3999 range is reserved for use by libraries, frameworks and applications. The 4000-4999 range is reserved for private use.
Used in: ,
CloseCodeZero = 0
pb必须有一个默认值
CloseCodeNormalClose = 1000
正常关闭
CloseCodeGoingAway = 1001
离开
CloseCodeProtocolError = 1002
协议错误
CloseCodeUnsupportedData = 1003
不支持的数据
CloseCodeNoStatusReceived = 1005
没有收到状态
CloseCodeAbnormalClosure = 1006
异常关闭
CloseCodeAuthenticationFailed = 4001
认证失败
CloseCodeDuplicateConnection = 4002
重复连接
CloseCodeServerInternalError = 4003
服务器内部错误
CloseCodeHeartbeatTimeout = 4004
心跳超时