package bilibili.im.interface.v1

Get desktop application:
View/edit binary Protocol Buffers messages

私信

• rpc SendMsg (ReqSendMsg, RspSendMsg)

  im.proto:10

  发送消息

  message ReqSendMsg

  im.proto:223

  发送消息-请求

  • optional type.Msg msg = 1

    消息内容

  • string cookie = 2

  • string cookie2 = 3

  • int32 error_code = 4

  • string dev_id = 5

  message RspSendMsg

  im.proto:404

  发送消息-响应

  • uint64 msg_key = 1

  • repeated EmotionInfo e_infos = 2

    表情资源信息

  • string msg_content = 3

  • optional type.KeyHitInfos key_hit_infos = 4

• rpc SyncRelation (ReqRelationSync, RspRelationSync)

  im.proto:12

  同步关系

  message ReqRelationSync

  im.proto:209

  同步关系-请求

  • uint64 client_relation_oplog_seqno = 1

    客户端当前seqno

  message RspRelationSync

  im.proto:390

  同步关系-响应

  • int32 full = 1

  • repeated type.RelationLog relation_logs = 2

    增量日志

  • repeated type.FriendRelation friend_list = 3

    全量列表

  • uint64 server_relation_oplog_seqno = 4

    服务器端最大的relation seqno

  • repeated type.GroupRelation group_list = 5

    全量列表

• rpc SyncAck (ReqSyncAck, RspSyncAck)

  im.proto:14

  确认同步进度

  message ReqSyncAck

  im.proto:316

  确认同步进度-请求

  • uint64 client_seqno = 1

  message RspSyncAck

  im.proto:494

  确认同步进度-响应

  (message has no fields)

• rpc SyncFetchSessionMsgs (ReqSessionMsg, RspSessionMsg)

  im.proto:16

  同步版本拉取消息

  message ReqSessionMsg

  im.proto:253

  同步版本拉取消息-请求

  • uint64 talker_id = 1

  • int32 session_type = 2

  • uint64 end_seqno = 3

  • uint64 begin_seqno = 4

  • int32 size = 5

  • int32 order = 6

  • string dev_id = 7

• rpc GetSessions (ReqGetSessions, RspSessions)

  im.proto:18

  拉取会话记录列表

  message ReqGetSessions

  im.proto:153

  拉取会话记录列表-请求

  • uint64 begin_ts = 1

  • uint64 end_ts = 2

  • uint32 size = 3

  • uint32 session_type = 4

  • uint32 unfollow_fold = 5

  • uint32 group_fold = 6

  • uint32 sort_rule = 7

  • uint32 teenager_mode = 8

    青少年模式

  • uint32 lessons_mode = 9

    课堂模式

• rpc NewSessions (ReqNewSessions, RspSessions)

  im.proto:20

  拉取新消息

  message ReqNewSessions

  im.proto:197

  拉取新消息-请求

  • uint64 begin_ts = 1

  • uint32 size = 2

  • uint32 teenager_mode = 3

  • uint32 lessons_mode = 4

    课堂模式

• rpc AckSessions (ReqAckSessions, RspSessions)

  im.proto:22

  拉取已读消息

  message ReqAckSessions

  im.proto:123

  拉取已读消息-请求

  • uint64 begin_ts = 1

  • uint32 end_ts = 2

  • uint32 size = 3

• rpc UpdateAck (ReqUpdateAck, DummyRsp)

  im.proto:24

  更新已读进度

  message ReqUpdateAck

  im.proto:340

  更新已读进度-请求

  • uint64 talker_id = 1

    聊天对象uid，可以为用户id或者为群id

  • uint32 session_type = 2

    会话类型

  • uint64 ack_seqno = 3

    已读的最大seqno

• rpc SetTop (ReqSetTop, DummyRsp)

  im.proto:26

  置顶聊天

  message ReqSetTop

  im.proto:271

  置顶聊天-请求

  • uint64 talker_id = 1

  • uint32 session_type = 2

  • uint32 op_type = 3

    0:置顶 1:取消置顶

• rpc RemoveSession (ReqRemoveSession, DummyRsp)

  im.proto:28

  删除会话记录

  message ReqRemoveSession

  im.proto:215

  删除会话记录-请求

  • uint64 talker_id = 1

  • uint32 session_type = 2

• rpc SingleUnread (ReqSingleUnread, RspSingleUnread)

  im.proto:30

  未读私信数

  message ReqSingleUnread

  im.proto:298

  未读私信数-请求

  • int32 unread_type = 1

  • int32 show_unfollow_list = 2

  • int64 uid = 3

  • int32 show_dustbin = 4

  message RspSingleUnread

  im.proto:468

  未读私信数-响应

  • uint64 unfollow_unread = 1

    未关注用户私信数

  • uint64 follow_unread = 2

    已关注用户私信数

  • uint32 unfollow_push_msg = 3

    未关注人列表是否有新业务通知

  • int32 dustbin_push_msg = 4

  • int64 dustbin_unread = 5

  • int64 biz_msg_unfollow_unread = 6

  • int64 biz_msg_follow_unread = 7

• rpc MyGroupUnread (DummyReq, RspMyGroupUnread)

  im.proto:32

  我创建的应援团未读数

  message RspMyGroupUnread

  im.proto:384

  我创建的应援团未读数-响应

  • uint32 unread_count = 1

    未读消息数

• rpc UpdateUnflwRead (DummyReq, DummyRsp)

  im.proto:34

  未关注的人批量设置为已读

• rpc GroupAssisMsg (ReqGroupAssisMsg, RspSessionMsg)

  im.proto:36

  应援团消息助手

  message ReqGroupAssisMsg

  im.proto:181

  应援团消息助手-请求

  • uint64 client_seqno = 1

  • uint32 size = 2

• rpc AckAssisMsg (ReqAckAssisMsg, DummyRsp)

  im.proto:38

  更新应援团小助手消息已拉取进度

  message ReqAckAssisMsg

  im.proto:117

  更新应援团小助手消息已拉取进度-请求

  • uint64 ack_seqno = 1

• rpc SessionDetail (ReqSessionDetail, type.SessionInfo)

  im.proto:40

  拉取会话详情

• rpc BatchSessDetail (ReqSessionDetails, RspSessionDetails)

  im.proto:42

  批量拉取会话详情

  message ReqSessionDetails

  im.proto:247

  批量拉取会话详情-请求

  • repeated ReqSessionDetail sess_ids = 1

    会话详情请求列表

  message RspSessionDetails

  im.proto:416

  批量拉取会话详情-响应

  • repeated type.SessionInfo sess_infos = 1

    会话详情列表

• rpc BatchRmSessions (ReqBatRmSess, DummyRsp)

  im.proto:44

  批量删除会话

  message ReqBatRmSess

  im.proto:133

  批量删除会话-请求

  (message has no fields)

• rpc ShareList (ReqShareList, RspShareList)

  im.proto:46

  拉取最近私信分享列表

  message ReqShareList

  im.proto:282

  拉取最近私信分享列表-请求

  • int32 size = 1

    分页大小 最大20

  message RspShareList

  im.proto:452

  拉取最近私信分享列表-响应

  • repeated ShareSessionInfo session_list = 1

    最近会话列表

  • int32 IsAddressListEmpty = 2

• rpc SpecificSingleUnread (ReqSpecificSingleUnread, RspSpecificSingleUnread)

  im.proto:48

  message ReqSpecificSingleUnread

  im.proto:310

  -请求

  • repeated SimpleSession talker_sessions = 1

    具体会话详情

  message RspSpecificSingleUnread

  im.proto:486

  -响应

  • map<uint64, uint64> talkerUnreadCnt = 1

    key -> 用户uid, value ->未读数

  • uint64 allUnreadCnt = 2

    总未读数

• rpc GetSpecificSessions (ReqGetSpecificSessions, RspSessions)

  im.proto:50

  message ReqGetSpecificSessions

  im.proto:175

  -请求

  • repeated SimpleSession talker_sessions = 1

    具体会话详情

• rpc GetLiveInfo (ReqLiveInfo, RspLiveInfo)

  im.proto:52

  message ReqLiveInfo

  im.proto:189

  • int64 uid = 1

  • int64 talker_id = 2

  message RspLiveInfo

  im.proto:376

  • int64 live_status = 1

  • string jump_url = 2

• rpc GetTotalUnread (ReqTotalUnread, RspTotalUnread)

  im.proto:54

  message ReqTotalUnread

  im.proto:322

  • int32 unread_type = 1

  • int32 show_unfollow_list = 2

  • int64 uid = 3

  • int32 show_dustbin = 4

  • int32 singleunread_on = 5

  • int32 msgfeed_on = 6

  • int32 sysup_on = 7

  message RspTotalUnread

  im.proto:499

  • optional SessionSingleUnreadRsp session_single_unread = 1

  • optional MsgFeedUnreadRsp msg_feed_unread = 2

  • optional SysMsgInterfaceLastMsgRsp sys_msg_interface_last_msg = 3

  • int32 total_unread = 4

• rpc ShowClearUnreadUI (ReqShowClearUnreadUI, RspShowClearUnreadUI)

  im.proto:56

  message ReqShowClearUnreadUI

  im.proto:288

  • int32 unread_type = 1

  • int32 show_unfollow_list = 2

  • int32 show_dustbin = 4

  message RspShowClearUnreadUI

  im.proto:460

  • bool display = 1

  • string text = 2

• rpc CloseClearUnreadUI (ReqCloseClearUnreadUI, RspCloseClearUnreadUI)

  im.proto:58

  message ReqCloseClearUnreadUI

  im.proto:138

  (message has no fields)

  message RspCloseClearUnreadUI

  im.proto:365

  (message has no fields)

• rpc UpdateTotalUnread (ReqUpdateTotalUnread, RspUpdateTotalUnread)

  im.proto:60

  message ReqUpdateTotalUnread

  im.proto:360

  (message has no fields)

  message RspUpdateTotalUnread

  im.proto:511

  (message has no fields)

空请求

Used as request type in: ImInterface.MyGroupUnread, ImInterface.UpdateUnflwRead

• uint32 idl = 1

空响应

Used as response type in: ImInterface.AckAssisMsg, ImInterface.BatchRmSessions, ImInterface.RemoveSession, ImInterface.SetTop, ImInterface.UpdateAck, ImInterface.UpdateUnflwRead

(message has no fields)

• FOLD_NO = 0

• FOLD_YES = 1

• FOLD_UNKNOWN = 2

• UNREAD_TYPE_ALL = 0

• UNREAD_TYPE_FOLLOW = 1

• UNREAD_TYPE_UNFOLLOW = 2

• UNREAD_TYPE_DUSTBIN = 3

表情资源信息

Used in: RspSendMsg, RspSessionMsg

• string text = 1

  表情

• string url = 2

  表情url

• int32 size = 3

  表情大小 0:未知 1:min 2:max

• string gif_url = 4

  gif url

Used in: ReqGetMsg

• int64 msg_key = 1

• int64 seqno = 2

Used in: RspTotalUnread

• map<string, int64> unread = 1

• int64 talker_id = 1

• int32 session_type = 2

• repeated MsgDetail msg_detail = 3

拉取会话详情-请求

Used as request type in: ImInterface.SessionDetail

Used as field type in: ReqSessionDetails

• uint64 talker_id = 1

• uint32 session_type = 2

• uint64 uid = 3

• int64 uid = 1

• int64 talker_id = 2

• int32 status = 3

• repeated type.Msg msg = 1

同步版本拉取消息-响应

Used as response type in: ImInterface.GroupAssisMsg, ImInterface.SyncFetchSessionMsgs

• repeated type.Msg messages = 1

• int32 has_more = 2

• uint64 min_seqno = 3

• uint64 max_seqno = 4

• repeated EmotionInfo e_infos = 5

  表情资源信息

拉取消息-响应

Used as response type in: ImInterface.AckSessions, ImInterface.GetSessions, ImInterface.GetSpecificSessions, ImInterface.NewSessions

• repeated type.SessionInfo session_list = 1

• uint32 has_more = 2

• bool anti_disturb_cleaning = 3

  标记反垃圾会话是否在清理中

• int32 is_address_list_empty = 4

  当session_list为空时，会返回该字段用于判断通讯录是否为空，1表示空，0表示非空

• map<int32, int64> system_msg = 5

• bool show_level = 6

• UNKNOWN = 0

• UN_FOLD_SESSION = 1

• UN_FOLLOW_SINGLE_SESSION = 2

• MY_GROUP_SESSION = 3

• ALL_SESSION = 4

• DUSTBIN_SESSION = 5

Used in: RspTotalUnread

• int64 unfollow_unread = 1

• int64 follow_unread = 2

• int32 unfollow_push_msg = 3

• int32 dustbin_push_msg = 4

• int64 dustbin_unread = 5

会话信息，用于私信分享

Used in: RspShareList

• uint64 talker_id = 1

• string talker_uname = 2

• string talker_icon = 3

• int32 official_type = 4

  认证信息 -1: 无认证 0:个人认证 1:机构认证

Used in: ReqGetSpecificSessions, ReqSpecificSingleUnread

• uint64 talker_id = 1

  聊天对象uid，可以为用户id或者为群id

• uint32 session_type = 2

  会话类型

Used in: RspTotalUnread

• int32 unread = 1

• string title = 2

• string time = 3

• int64 id = 4