## 鉴权接口 | 返回 | 接口 | 描述 | | ------------------- | ----------------------------------- | -------- | | LoginResult | login(account, password, loginType) | 登录 | | CommonDataResult | logout() | 登出 | | LoginResult | relogin() | 重新登出 | | CommonDataResult | changePwd(oldPwd, newPwd) | 修改密码 | ## 会话服务接口 | 返回 | 接口 | 描述 | | ------------------- | ----------------------------- | ------------------------ | | TODO | getChatList() | 获取本地缓存会话列表 | | TODO | addChat(chatID, isGroup) | 新建会话缓存 | | number | getChatCacheListUnreadCount() | 获取会话菜单未读消息总数 | | void | setActiveChatID(chatID = 0) | 设置当前激活会话ID | | number | deleteChatCache(chatID) | 删除当前会话 | | number | clearChatCacheList() | 清空会话列表 | ## 预登录接口 | 返回 | 接口 | 描述 | | ------------------- | --------- | ------------------ | | void | getConfig | 获取预登录地址信息 | ## 联系人服务接口 | 返回 | 接口 | 描述 | | --------------------- | ------------------------------------------------- | ------------------------------------ | | VerifyMessageRet | addBuddy(userID, message) | 添加好友 | | CommonDataResult | removeBuddy(userID) | 删除好友 | | CommonDataResult | addInBlackList(userID) | 加入到黑名单 | | CommonDataResult | editBuddyRemark(userID, remark) | 修改好友备注 | | VerifyMessageRet | addBuddyResponse(buddyID, isagree, applicationID) | 被添加好友响应操作 | | TODO | getBuddyList() | 获取好友列表(缓存) | | GetUserResult | getBuddy(userID) | 获取好友信息(优先缓存，其次服务器请求) | | GetBuddyOnlineResult | getBuddyOnline() | 获取在线的好友状态 | ## 消息服务 | 返回 | 接口 | 描述 | | -------------------- | ------------------------------------------- | ------------------------------------ | | SendMessageResult | sendMessage(messageBean) | 发送文字/表情消息 | | TODO | sendPictureMessage(formData, messageBean) | 发送图片消息 | | TODO | sendFileMessage(formData, messageBean) | 发送文件消息 | | SendMessageResult | sendTipMessage(messageBean) | 弱提示消息 | | SendMessageResult | sendCardMessage(messageBean) | 发送名片消息 | | CommonDataResult | setMessageForRead(chatID, maxMessageID) | 更新消息为已读状态 | | MessageStorageResult | getMessages(chatID, messageID, size) | 获取服务器历史消息(访问服务器) | | TODO | getMessagesHistory(chatID, messageID, size) | 分页获取本地历史消息缓存 | | TODO | getMessageHistoryById(messageID) | 根据messageID 获取本地历史消息缓存 | ## 搜索服务 | 返回 | 接口 | 描述 | | -------------------------- | --------------------------- | ---------------- | | SearchResult | simpleSearchBuddy(keyword) | 通用查询接口 | | CommonSettingServerResult | getPersonDataSwitch(userID) | 查看好友隐私接口 | ## 我的服务 | 返回 | 接口 | 描述 | | ------------------- | ---------------------- | ---------------- | | getMyself | getMyself() | 获取个人信息 | | CommonDataResult | getUserSetting(number) | 获取个人设置信息 | | CommonDataResult | setMyself(userBean) | 设置个人信息 | ## 系统服务 | 返回 | 接口 | 描述 | | ------------------- | ---------------------------------- | ------------------------ | | GetUserResult | getUser(userID) | 根据 userID 获取用户信息 | | GetUserResult | getUserInfo(targetID, clientScene) | 根据 userID 获取用户信息 | ## 系统消息服务 | 返回 | 接口 | 描述 | | ------------------- | ---------------------------- | ------------------------ | | TODO | getSystemMessageCacheList() | 获取系统消息列表 | | TODO | deleteSystemMessageCache(id) | 根据 id 删除系统消息 | | TODO | clearSystemMessageCache() | 清空当前用户系统消息列表 | ## 群服务 | 返回 | 接口 | 描述 | | -------------------------------------- | --------------------------------------------------------- | ----------------------------------------------------- | | TODO | createGroup(groupName, members[], groupIcon = '') | 创建群 | | CommonDataResult | activeGroup(groupID) | 激活群-如果存在群成员则添加群成员 | | VerifyMessageRet | addGroupRequest(groupID, message) | 加群申请请求 | | VerifyMessageRet | addGroupResponse(userID, groupID, applicationID, isagree) | 添加群响应 | | VerifyMessageRet | groupInviteResponse(groupID, applicationID, isagree) | 群邀请 被邀请人响应 | | VerifyMessageRet | groupDissolveRequest(groupID, groupName) | 解散群 | | VerifyMessageRet | groupMemberExitRequest(groupID) | 群成员退出 | | VerifyMessageRet | groupMemberKickoutRequest(groupID, kickoutUserIDs[]) | 管理员踢群成员 | | TransferGroupResult | transferGroup(groupID, targetUserID) | 群转让 | | GroupInfoResult | getGroupInfo(groupID) | 获取群信息(优先本地 其次服务器) | | GroupSetResult | getGroupSet(groupID) | 获取群设置信息 | | TODO | getGroupList() | 获取缓存群列表信息 | | TODO | getGroupMemberCacheList(groupID) | 获取缓存群成员列表信息 | | TODO | getGroupMemberList(groupID) | 获取群成员列表(取最近，如果时间没变，优先取缓存数据) | | CommonDataResult | updateGroupInfo(groupInfo) | 更新群信息 | | CommonDataResult | deleteGroup(groupID) | 删除群 | | AddGroupMemberResult VerifyMessageRet | invitationGroupMembers(groupID, members[]) | 邀请群成员 | | AddGroupMemberResult | addOldGroupMember(groupID, members[]) | 邀请群成员---老接口 | | VerifyMessageRet | addNewGroupMember(groupID, invitees[]) | 邀请群成员---新接口 | | RemoveGroupMemberResult | removeMembers(groupID, members[]) | 移除群成员 | | GroupMemberInfoResult | getMemberInfo(groupID, targetUserID) | 获取群成员信息 | | GetBuddyOnlineResult | getMembersOnline(members[]) | 获取群成员信息 | | TODO | getGroupMessagesHistory(groupID, messageID = 0, size = 10) | 获取群聊天历史信息(缓存) | | TODO | getGroupMessageHistoryById(messageID) | 根据messageID 获取本地群消息历史(缓存) | ## 组织机构服务 | 返回 | 接口 | 描述 | | --------------------- | ----------------------------- | -------------------------------------------- | | GetOrgUserResult | getOrgUser(orgID, entID) | 获取组织下成员列表 | | EnORet | getVisibleOrgUsers(options) | 获取某个用户所在组织下可见的子组织和用户 | | GetEnterpriseResult | getOrgList() | 获取一个用户拥有的企业列表 |