definitions: base_info.AccountCheckReq: properties: checkUserIDList: items: type: string maxItems: 100 type: array operationID: type: string required: - checkUserIDList - operationID type: object base_info.AccountCheckResp: properties: data: items: $ref: '#/definitions/user.AccountCheckResp_SingleUserStatus' type: array errCode: type: integer errMsg: type: string type: object base_info.AddBlacklistReq: properties: fromUserID: type: string operationID: type: string toUserID: type: string required: - fromUserID - operationID - toUserID type: object base_info.AddBlacklistResp: properties: errCode: type: integer errMsg: type: string type: object base_info.AddFriendReq: properties: fromUserID: type: string operationID: type: string reqMsg: type: string toUserID: type: string required: - fromUserID - operationID - toUserID type: object base_info.AddFriendResp: properties: errCode: type: integer errMsg: type: string type: object base_info.AddFriendResponseReq: properties: flag: enum: - -1 - 0 - 1 type: integer fromUserID: type: string handleMsg: type: string operationID: type: string toUserID: type: string required: - flag - fromUserID - operationID - toUserID type: object base_info.AddFriendResponseResp: properties: errCode: type: integer errMsg: type: string type: object base_info.ApplicationGroupResponseReq: properties: fromUserID: description: application from FromUserID type: string groupID: type: string handleResult: enum: - -1 - 1 type: integer handledMsg: type: string operationID: type: string required: - fromUserID - groupID - handleResult - operationID type: object base_info.ApplicationGroupResponseResp: properties: errCode: type: integer errMsg: type: string type: object base_info.CancelMuteGroupMemberReq: properties: groupID: type: string operationID: type: string userID: type: string required: - groupID - operationID - userID type: object base_info.CancelMuteGroupMemberResp: properties: errCode: type: integer errMsg: type: string type: object base_info.CancelMuteGroupReq: properties: groupID: type: string operationID: type: string required: - groupID - operationID type: object base_info.CancelMuteGroupResp: properties: errCode: type: integer errMsg: type: string type: object base_info.CleanUpMsgReq: properties: operationID: type: string userID: type: string required: - operationID - userID type: object base_info.CleanUpMsgResp: properties: errCode: type: integer errMsg: type: string type: object base_info.Comment: properties: content: type: string contentID: type: string createTime: type: integer replyUserID: type: string replyUserName: type: string userID: type: string userName: type: string type: object base_info.CommentOneWorkMomentReq: properties: content: type: string operationID: type: string replyUserID: type: string workMomentID: type: string required: - content - operationID - workMomentID type: object base_info.CommentOneWorkMomentResp: properties: data: type: object errCode: type: integer errMsg: type: string type: object base_info.CreateGroupReq: properties: ex: type: string faceURL: type: string groupID: type: string groupName: type: string groupType: type: integer introduction: type: string memberList: items: $ref: '#/definitions/base_info.GroupAddMemberInfo' type: array notification: type: string operationID: type: string ownerUserID: type: string required: - operationID type: object base_info.CreateGroupResp: properties: errCode: type: integer errMsg: type: string type: object base_info.CreateOneWorkMomentReq: properties: operationID: type: string workMoment: $ref: '#/definitions/office.WorkMoment' type: object base_info.CreateOneWorkMomentResp: properties: data: type: object errCode: type: integer errMsg: type: string type: object base_info.CreateTagReq: properties: operationID: type: string tagName: description: tag名称 type: string userIDList: description: 用户ID列表 items: type: string type: array required: - operationID - tagName - userIDList type: object base_info.CreateTagResp: properties: errCode: type: integer errMsg: type: string type: object base_info.DelMsgReq: properties: operationID: type: string seqList: items: type: integer type: array userID: type: string required: - operationID - seqList - userID type: object base_info.DelMsgResp: properties: errCode: type: integer errMsg: type: string type: object base_info.DeleteCommentReq: properties: contentID: type: string operationID: type: string workMomentID: type: string required: - contentID - operationID - workMomentID type: object base_info.DeleteCommentResp: properties: data: type: object errCode: type: integer errMsg: type: string type: object base_info.DeleteFriendReq: properties: fromUserID: type: string operationID: type: string toUserID: type: string required: - fromUserID - operationID - toUserID type: object base_info.DeleteFriendResp: properties: errCode: type: integer errMsg: type: string type: object base_info.DeleteOneWorkMomentReq: properties: operationID: type: string workMomentID: type: string required: - operationID - workMomentID type: object base_info.DeleteOneWorkMomentResp: properties: data: type: object errCode: type: integer errMsg: type: string type: object base_info.DeleteTagReq: properties: operationID: type: string tagID: type: string required: - operationID - tagID type: object base_info.DeleteTagResp: properties: errCode: type: integer errMsg: type: string type: object base_info.DismissGroupReq: properties: groupID: type: string operationID: type: string required: - groupID - operationID type: object base_info.DismissGroupResp: properties: errCode: type: integer errMsg: type: string type: object base_info.ForceLogoutReq: properties: fromUserID: maxLength: 64 minLength: 1 type: string operationID: type: string platform: maximum: 8 minimum: 1 type: integer required: - fromUserID - operationID - platform type: object base_info.ForceLogoutResp: properties: errCode: type: integer errMsg: type: string type: object base_info.GetAllUsersUidReq: properties: operationID: type: string required: - operationID type: object base_info.GetAllUsersUidResp: properties: data: items: type: string type: array errCode: type: integer errMsg: type: string type: object base_info.GetBlackListReq: properties: fromUserID: type: string operationID: type: string required: - fromUserID - operationID type: object base_info.GetBlackListResp: properties: data: items: additionalProperties: true type: object type: array errCode: type: integer errMsg: type: string type: object base_info.GetFriendApplyListReq: properties: fromUserID: type: string operationID: type: string required: - fromUserID - operationID type: object base_info.GetFriendApplyListResp: properties: data: items: additionalProperties: true type: object type: array errCode: type: integer errMsg: type: string type: object base_info.GetFriendListReq: properties: fromUserID: type: string operationID: type: string required: - fromUserID - operationID type: object base_info.GetFriendListResp: properties: data: items: additionalProperties: true type: object type: array errCode: type: integer errMsg: type: string type: object base_info.GetGroupAllMemberReq: properties: groupID: type: string operationID: type: string required: - groupID - operationID type: object base_info.GetGroupAllMemberResp: properties: data: items: additionalProperties: true type: object type: array errCode: type: integer errMsg: type: string type: object base_info.GetGroupApplicationListReq: properties: fromUserID: description: 作为管理员或群主收到的 进群申请 type: string operationID: type: string required: - fromUserID - operationID type: object base_info.GetGroupApplicationListResp: properties: data: items: additionalProperties: true type: object type: array errCode: type: integer errMsg: type: string type: object base_info.GetGroupInfoReq: properties: groupIDList: items: type: string type: array operationID: type: string required: - groupIDList - operationID type: object base_info.GetGroupInfoResp: properties: data: items: additionalProperties: true type: object type: array errCode: type: integer errMsg: type: string type: object base_info.GetGroupMembersInfoReq: properties: groupID: type: string memberList: items: type: string type: array operationID: type: string required: - groupID - memberList - operationID type: object base_info.GetGroupMembersInfoResp: properties: data: items: additionalProperties: true type: object type: array errCode: type: integer errMsg: type: string type: object base_info.GetJoinedGroupListReq: properties: fromUserID: type: string operationID: type: string required: - fromUserID - operationID type: object base_info.GetJoinedGroupListResp: properties: data: items: additionalProperties: true type: object type: array errCode: type: integer errMsg: type: string type: object base_info.GetSelfApplyListReq: properties: fromUserID: type: string operationID: type: string required: - fromUserID - operationID type: object base_info.GetSelfApplyListResp: properties: data: items: additionalProperties: true type: object type: array errCode: type: integer errMsg: type: string type: object base_info.GetSelfUserInfoReq: properties: operationID: type: string userID: type: string required: - operationID - userID type: object base_info.GetSelfUserInfoResp: properties: errCode: type: integer errMsg: type: string type: object base_info.GetTagSendLogsReq: properties: operationID: type: string pageNumber: type: integer showNumber: type: integer required: - operationID - pageNumber - showNumber type: object base_info.GetTagSendLogsResp: properties: data: properties: currentPage: type: integer logs: items: $ref: '#/definitions/office.TagSendLog' type: array showNumber: type: integer type: object errCode: type: integer errMsg: type: string type: object base_info.GetUserFriendWorkMomentsReq: properties: operationID: type: string pageNumber: type: integer showNumber: type: integer required: - operationID - pageNumber - showNumber type: object base_info.GetUserFriendWorkMomentsResp: properties: data: properties: currentPage: type: integer showNumber: type: integer workMoments: items: $ref: '#/definitions/base_info.WorkMoment' type: array type: object errCode: type: integer errMsg: type: string type: object base_info.GetUserReqGroupApplicationListReq: properties: operationID: type: string userID: type: string required: - operationID - userID type: object base_info.GetUserTagByIDReq: properties: operationID: type: string tagID: type: string required: - operationID - tagID type: object base_info.GetUserTagByIDResp: properties: data: properties: tag: $ref: '#/definitions/office.Tag' type: object errCode: type: integer errMsg: type: string type: object base_info.GetUserTagsReq: properties: operationID: type: string required: - operationID type: object base_info.GetUserTagsResp: properties: data: properties: tags: items: $ref: '#/definitions/office.Tag' type: array type: object errCode: type: integer errMsg: type: string type: object base_info.GetUserWorkMomentsReq: properties: operationID: type: string pageNumber: type: integer showNumber: type: integer userID: type: string required: - operationID - pageNumber - showNumber type: object base_info.GetUserWorkMomentsResp: properties: data: properties: currentPage: type: integer showNumber: type: integer workMoments: items: $ref: '#/definitions/base_info.WorkMoment' type: array type: object errCode: type: integer errMsg: type: string type: object base_info.GetUsersInfoReq: properties: operationID: type: string userIDList: items: type: string type: array required: - operationID - userIDList type: object base_info.GetUsersInfoResp: properties: errCode: type: integer errMsg: type: string type: object base_info.GetUsersOnlineStatusReq: properties: operationID: type: string userIDList: items: type: string maxItems: 200 type: array required: - operationID - userIDList type: object base_info.GetUsersOnlineStatusResp: properties: data: items: $ref: '#/definitions/pbRelay.GetUsersOnlineStatusResp_SuccessResult' type: array errCode: type: integer errMsg: type: string type: object base_info.GetWorkMomentByIDReq: properties: operationID: type: string workMomentID: type: string required: - operationID - workMomentID type: object base_info.GetWorkMomentByIDResp: properties: data: properties: workMoment: $ref: '#/definitions/base_info.WorkMoment' type: object errCode: type: integer errMsg: type: string type: object base_info.GroupAddMemberInfo: properties: roleLevel: type: integer userID: type: string required: - roleLevel - userID type: object base_info.ImportFriendReq: properties: friendUserIDList: items: type: string type: array fromUserID: type: string operationID: type: string required: - friendUserIDList - fromUserID - operationID type: object base_info.ImportFriendResp: properties: data: items: $ref: '#/definitions/base_info.UserIDResult' type: array errCode: type: integer errMsg: type: string type: object base_info.InviteUserToGroupReq: properties: groupID: type: string invitedUserIDList: items: type: string type: array operationID: type: string reason: type: string required: - groupID - invitedUserIDList - operationID type: object base_info.InviteUserToGroupResp: properties: data: items: $ref: '#/definitions/base_info.UserIDResult' type: array errCode: type: integer errMsg: type: string type: object base_info.IsFriendReq: properties: fromUserID: type: string operationID: type: string toUserID: type: string required: - fromUserID - operationID - toUserID type: object base_info.IsFriendResp: properties: data: $ref: '#/definitions/base_info.Response' errCode: type: integer errMsg: type: string type: object base_info.JoinGroupReq: properties: groupID: type: string operationID: type: string reqMessage: type: string required: - groupID - operationID type: object base_info.JoinGroupResp: properties: errCode: type: integer errMsg: type: string type: object base_info.KickGroupMemberReq: properties: groupID: type: string kickedUserIDList: items: type: string type: array operationID: type: string reason: type: string required: - groupID - kickedUserIDList - operationID type: object base_info.KickGroupMemberResp: properties: data: items: $ref: '#/definitions/base_info.UserIDResult' type: array errCode: type: integer errMsg: type: string type: object base_info.LikeOneWorkMomentReq: properties: operationID: type: string workMomentID: type: string required: - operationID - workMomentID type: object base_info.LikeOneWorkMomentResp: properties: data: type: object errCode: type: integer errMsg: type: string type: object base_info.MinioUploadFileResp: properties: URL: type: string newName: type: string snapshotName: type: string snapshotURL: type: string type: object base_info.MuteGroupMemberReq: properties: groupID: type: string mutedSeconds: type: integer operationID: type: string userID: type: string required: - groupID - mutedSeconds - operationID - userID type: object base_info.MuteGroupReq: properties: groupID: type: string operationID: type: string required: - groupID - operationID type: object base_info.MuteGroupResp: properties: errCode: type: integer errMsg: type: string type: object base_info.ParseTokenReq: properties: operationID: type: string required: - operationID type: object base_info.ParseTokenResp: properties: data: additionalProperties: true type: object errCode: type: integer errMsg: type: string type: object base_info.QuitGroupReq: properties: groupID: type: string operationID: type: string required: - groupID - operationID type: object base_info.QuitGroupResp: properties: errCode: type: integer errMsg: type: string type: object base_info.RemoveBlackListReq: properties: fromUserID: type: string operationID: type: string toUserID: type: string required: - fromUserID - operationID - toUserID type: object base_info.RemoveBlackListResp: properties: errCode: type: integer errMsg: type: string type: object base_info.Response: properties: isFriend: type: boolean type: object base_info.SendMsg2TagReq: properties: content: type: string groupList: items: type: string type: array operationID: type: string senderPlatformID: type: integer tagList: items: type: string type: array userList: items: type: string type: array required: - content - operationID - senderPlatformID type: object base_info.SendMsg2TagResp: properties: errCode: type: integer errMsg: type: string type: object base_info.SetFriendRemarkReq: properties: fromUserID: type: string operationID: type: string remark: type: string toUserID: type: string required: - fromUserID - operationID - remark - toUserID type: object base_info.SetFriendRemarkResp: properties: errCode: type: integer errMsg: type: string type: object base_info.SetGlobalRecvMessageOptReq: properties: globalRecvMsgOpt: enum: - 0 - 1 - 2 type: integer operationID: type: string required: - operationID type: object base_info.SetGlobalRecvMessageOptResp: properties: errCode: type: integer errMsg: type: string type: object base_info.SetGroupInfoReq: properties: ex: type: string faceURL: type: string groupID: type: string groupName: type: string introduction: type: string needVerification: type: integer notification: type: string operationID: type: string required: - groupID - operationID type: object base_info.SetGroupInfoResp: properties: errCode: type: integer errMsg: type: string type: object base_info.SetGroupMemberInfoReq: properties: ex: type: string groupID: type: string nickname: type: string operationID: type: string roleLevel: maximum: 3 minimum: 1 type: integer userGroupFaceUrl: type: string userID: type: string required: - groupID - operationID - userID type: object base_info.SetGroupMemberInfoResp: properties: errCode: type: integer errMsg: type: string type: object base_info.SetTagReq: properties: increaseUserIDList: items: type: string type: array newName: type: string operationID: type: string reduceUserIDList: items: type: string type: array tagID: type: string required: - operationID - tagID type: object base_info.SetTagResp: properties: errCode: type: integer errMsg: type: string type: object base_info.TransferGroupOwnerReq: properties: groupID: type: string newOwnerUserID: type: string oldOwnerUserID: type: string operationID: type: string required: - groupID - newOwnerUserID - oldOwnerUserID - operationID type: object base_info.TransferGroupOwnerResp: properties: errCode: type: integer errMsg: type: string type: object base_info.UpdateSelfUserInfoReq: properties: birth: type: integer email: maxLength: 64 type: string ex: maxLength: 1024 type: string faceURL: maxLength: 1024 type: string gender: enum: - 0 - 1 - 2 type: integer nickname: maxLength: 64 minLength: 1 type: string operationID: type: string phoneNumber: maxLength: 32 type: string userID: maxLength: 64 minLength: 1 type: string required: - operationID - userID type: object base_info.UpdateUserInfoResp: properties: errCode: type: integer errMsg: type: string type: object base_info.UserIDResult: properties: result: type: integer userID: type: string type: object base_info.UserRegisterReq: properties: birth: type: integer email: maxLength: 64 type: string ex: maxLength: 1024 type: string faceURL: maxLength: 1024 type: string gender: enum: - 0 - 1 - 2 type: integer nickname: maxLength: 64 minLength: 1 type: string operationID: type: string phoneNumber: maxLength: 32 type: string platform: maximum: 7 minimum: 1 type: integer secret: maxLength: 32 type: string userID: maxLength: 64 minLength: 1 type: string required: - operationID - platform - secret - userID type: object base_info.UserRegisterResp: properties: data: $ref: '#/definitions/base_info.UserTokenInfo' errCode: type: integer errMsg: type: string type: object base_info.UserTokenInfo: properties: expiredTime: type: integer token: type: string userID: type: string type: object base_info.UserTokenReq: properties: operationID: type: string platform: maximum: 8 minimum: 1 type: integer secret: maxLength: 32 type: string userID: maxLength: 64 minLength: 1 type: string required: - operationID - platform - secret - userID type: object base_info.UserTokenResp: properties: data: $ref: '#/definitions/base_info.UserTokenInfo' errCode: type: integer errMsg: type: string type: object base_info.WorkMoment: properties: atUsers: items: $ref: '#/definitions/base_info.WorkMomentUser' type: array comments: items: $ref: '#/definitions/base_info.Comment' type: array content: type: string createTime: type: integer faceURL: type: string likeUsers: items: $ref: '#/definitions/base_info.WorkMomentUser' type: array permission: type: integer permissionUsers: items: $ref: '#/definitions/base_info.WorkMomentUser' type: array userID: type: string userName: type: string workMomentID: type: string type: object base_info.WorkMomentUser: properties: userID: type: string userName: type: string type: object office.Comment: properties: content: type: string contentID: type: string createTime: type: integer faceURL: type: string replyUserID: type: string replyUserName: type: string userID: type: string userName: type: string type: object office.PermissionGroup: properties: groupID: type: string groupName: type: string type: object office.Tag: properties: tagID: type: string tagName: type: string userList: items: $ref: '#/definitions/office.TagUser' type: array type: object office.TagSendLog: properties: content: type: string sendTime: type: integer userList: items: $ref: '#/definitions/office.TagUser' type: array type: object office.TagUser: properties: userID: type: string userName: type: string type: object office.WorkMoment: properties: atUserList: items: $ref: '#/definitions/office.WorkMomentUser' type: array comments: items: $ref: '#/definitions/office.Comment' type: array content: type: string createTime: type: integer faceURL: type: string likeUserList: items: $ref: '#/definitions/office.WorkMomentUser' type: array permission: type: integer permissionGroupList: items: $ref: '#/definitions/office.PermissionGroup' type: array permissionUserList: items: $ref: '#/definitions/office.WorkMomentUser' type: array userID: type: string userName: type: string workMomentID: type: string type: object office.WorkMomentUser: properties: userID: type: string userName: type: string type: object pbRelay.GetUsersOnlineStatusResp_SuccessDetail: properties: platform: type: string status: type: string type: object pbRelay.GetUsersOnlineStatusResp_SuccessResult: properties: detailPlatformStatus: items: $ref: '#/definitions/pbRelay.GetUsersOnlineStatusResp_SuccessDetail' type: array status: type: string userID: type: string type: object server_api_params.GroupInfo: properties: createTime: type: integer creatorUserID: type: string ex: type: string faceURL: type: string groupID: type: string groupName: type: string groupType: type: integer introduction: type: string memberCount: type: integer needVerification: $ref: '#/definitions/wrapperspb.Int32Value' notification: type: string ownerUserID: type: string status: type: integer type: object server_api_params.GroupMemberFullInfo: properties: appMangerLevel: type: integer ex: type: string faceURL: type: string groupID: type: string joinSource: type: integer joinTime: type: integer muteEndTime: type: integer nickname: type: string operatorUserID: type: string roleLevel: type: integer userID: type: string type: object server_api_params.UserInfo: properties: appMangerLevel: type: integer birth: type: integer createTime: type: integer email: type: string ex: type: string faceURL: type: string gender: type: integer globalRecvMsgOpt: type: integer nickname: type: string phoneNumber: type: string userID: type: string type: object user.AccountCheckResp_SingleUserStatus: properties: accountStatus: type: string userID: type: string type: object wrapperspb.Int32Value: properties: value: description: The int32 value. type: integer type: object info: contact: {} paths: /auth/force_logout: post: consumes: - application/json description: 对应的平台强制登出 operationId: ForceLogout parameters: - description: im token in: header name: token required: true type: string - description: platform为平台ID, fromUserID为要执行强制登出的用户ID in: body name: req required: true schema: $ref: '#/definitions/base_info.ForceLogoutReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.ForceLogoutResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.ForceLogoutResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.ForceLogoutResp' summary: 强制登出 tags: - 鉴权认证 /auth/parse_token: post: consumes: - application/json description: 解析用户token operationId: ParseToken parameters: - description: im token in: header name: token required: true type: string - description: secret为openIM密钥, 详细见服务端config.yaml secret字段, platform为平台ID in: body name: req required: true schema: $ref: '#/definitions/base_info.ParseTokenReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.ParseTokenResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.ParseTokenResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.ParseTokenResp' summary: 解析token tags: - 鉴权认证 /auth/user_register: post: consumes: - application/json description: 用户登录 operationId: UserRegister parameters: - description: im token in: header name: token required: true type: string - description: secret为openIM密钥, 详细见服务端config.yaml secret字段
platform为平台ID
ex为拓展字段 in: body name: req required: true schema: $ref: '#/definitions/base_info.UserRegisterReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.UserRegisterResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.UserRegisterResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.UserRegisterResp' summary: 用户登录 tags: - 鉴权认证 /auth/user_token: post: consumes: - application/json description: 获取用户的token operationId: UserToken parameters: - description: im token in: header name: token required: true type: string - description: secret为openIM密钥, 详细见服务端config.yaml secret字段, platform为平台ID in: body name: req required: true schema: $ref: '#/definitions/base_info.UserTokenReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.UserTokenResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.UserTokenResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.UserTokenResp' summary: 用户登录 tags: - 鉴权认证 /friend/add_black: post: consumes: - application/json description: 添加黑名单 operationId: AddBlack parameters: - description: im token in: header name: token required: true type: string - description: fromUserID为设置的用户, toUserID为被设置的用户 in: body name: req required: true schema: $ref: '#/definitions/base_info.AddBlacklistReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.AddBlacklistResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.AddBlacklistResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.AddBlacklistResp' summary: 添加黑名单 tags: - 好友相关 /friend/add_friend: post: consumes: - application/json description: 添加好友 operationId: AddFriend parameters: - description: im token in: header name: token required: true type: string - description: reqMsg为申请信息, fromUserID为申请用户, toUserID为被添加用户 in: body name: req required: true schema: $ref: '#/definitions/base_info.AddFriendReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.AddFriendResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.AddFriendResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.AddFriendResp' summary: 添加好友 tags: - 好友相关 /friend/add_friend_response: post: consumes: - application/json description: 同意/拒绝好友请求 operationId: AddFriendResponse parameters: - description: im token in: header name: token required: true type: string - description: fromUserID同意/拒绝的用户ID, toUserID为申请用户, handleMsg为处理信息, flag为具体操作, 1为同意, 2为拒绝 in: body name: req required: true schema: $ref: '#/definitions/base_info.AddFriendResponseReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.AddFriendResponseResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.AddFriendResponseResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.AddFriendResponseResp' summary: 同意/拒绝好友请求 tags: - 好友相关 /friend/delete_friend: post: consumes: - application/json description: 删除好友 operationId: DeleteFriend parameters: - description: im token in: header name: token required: true type: string - description: fromUserID为操作用户, toUserID为被删除用户 in: body name: req required: true schema: $ref: '#/definitions/base_info.DeleteFriendReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.DeleteFriendResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.DeleteFriendResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.DeleteFriendResp' summary: 删除好友 tags: - 好友相关 /friend/get_black_list: post: consumes: - application/json description: 获取黑名单列表 operationId: GetBlacklist parameters: - description: im token in: header name: token required: true type: string - description: fromUserID要获取黑名单的用户 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetBlackListReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetBlackListResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetBlackListResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetBlackListResp' summary: 获取黑名单列表 tags: - 好友相关 /friend/get_friend_apply_list: post: consumes: - application/json description: 删除好友 operationId: GetFriendApplyList parameters: - description: im token in: header name: token required: true type: string - description: fromUserID为要获取申请列表的用户ID in: body name: req required: true schema: $ref: '#/definitions/base_info.GetFriendApplyListReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetFriendApplyListResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetFriendApplyListResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetFriendApplyListResp' summary: 获取好友申请列表 tags: - 好友相关 /friend/get_friend_list: post: consumes: - application/json description: 获取用户的好友列表 operationId: GetFriendList parameters: - description: im token in: header name: token required: true type: string - description: fromUserID为要获取好友列表的用户ID in: body name: req required: true schema: $ref: '#/definitions/base_info.GetFriendListReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetFriendListResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetFriendListResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetFriendListResp' summary: 获取用户的好友列表 tags: - 好友相关 /friend/get_self_friend_apply_list: post: consumes: - application/json description: 获取自己的好友申请列表 operationId: GetSelfFriendApplyList parameters: - description: im token in: header name: token required: true type: string - description: fromUserID为自己的用户ID in: body name: req required: true schema: $ref: '#/definitions/base_info.GetSelfApplyListReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetSelfApplyListResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetSelfApplyListResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetSelfApplyListResp' summary: 获取自己的好友申请列表 tags: - 好友相关 /friend/import_friend: post: consumes: - application/json description: 批量加好友 operationId: ImportFriend parameters: - description: im token in: header name: token required: true type: string - description: fromUserID批量加好友的用户ID, friendUserIDList为 in: body name: req required: true schema: $ref: '#/definitions/base_info.ImportFriendReq' produces: - application/json responses: "0": description: data列表中对象的result-1为添加该用户失败, 0为成功 schema: $ref: '#/definitions/base_info.ImportFriendResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.ImportFriendResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.ImportFriendResp' summary: 批量加好友 tags: - 好友相关 /friend/is_friend: post: consumes: - application/json description: 检查用户之间是否为好友 operationId: IsFriend parameters: - description: im token in: header name: token required: true type: string - description: fromUserID为请求用户, toUserID为要检查的用户 in: body name: req required: true schema: $ref: '#/definitions/base_info.IsFriendReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.IsFriendResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.IsFriendResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.IsFriendResp' summary: 检查用户之间是否为好友 tags: - 好友相关 /friend/remove_black: post: consumes: - application/json description: 把用户移除黑名单 operationId: RemoveBlack parameters: - description: im token in: header name: token required: true type: string - description: fromUserID要获取黑名单的用户 in: body name: req required: true schema: $ref: '#/definitions/base_info.RemoveBlackListReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.RemoveBlackListResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.RemoveBlackListResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.RemoveBlackListResp' summary: 把用户移除黑名单 tags: - 好友相关 /friend/set_friend_remark: post: consumes: - application/json description: 设置好友备注 operationId: SetFriendRemark parameters: - description: im token in: header name: token required: true type: string - description: fromUserID为设置的用户, toUserID为被设置的用户， remark为好友备注 in: body name: req required: true schema: $ref: '#/definitions/base_info.SetFriendRemarkReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.SetFriendRemarkResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.SetFriendRemarkResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.SetFriendRemarkResp' summary: 设置好友备注 tags: - 好友相关 /group/cancel_mute_group: post: consumes: - application/json description: 取消禁言群组 operationId: CancelMuteGroup parameters: - description: im token in: header name: token required: true type: string - description: groupID为群组ID in: body name: req required: true schema: $ref: '#/definitions/base_info.CancelMuteGroupReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.CancelMuteGroupResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.CancelMuteGroupResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.CancelMuteGroupResp' summary: 取消禁言群组 tags: - 群组相关 /group/cancel_mute_group_member: post: consumes: - application/json description: 取消禁言群成员 operationId: CancelMuteGroupMember parameters: - description: im token in: header name: token required: true type: string - description: groupID为群组ID
userID为要取消禁言的用户ID in: body name: req required: true schema: $ref: '#/definitions/base_info.CancelMuteGroupMemberReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.CancelMuteGroupMemberResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.CancelMuteGroupMemberResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.CancelMuteGroupMemberResp' summary: 取消禁言群成员 tags: - 群组相关 /group/create_group: post: consumes: - application/json description: 创建群组 operationId: CreateGroup parameters: - description: im token in: header name: token required: true type: string - description: ownerUserID为群主ID
ex为群扩展字段
roleLevel为群员角色,1为普通用户 2为群主 3为管理员 in: body name: req required: true schema: $ref: '#/definitions/base_info.CreateGroupReq' produces: - application/json responses: "0": description: "" schema: allOf: - $ref: '#/definitions/base_info.CreateGroupResp' - properties: data: $ref: '#/definitions/server_api_params.GroupInfo' type: object "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.CreateGroupResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.CreateGroupResp' summary: 创建群组 tags: - 群组相关 /group/dismiss_group: post: consumes: - application/json description: 解散群组 operationId: DismissGroup parameters: - description: im token in: header name: token required: true type: string - description: groupID为要解散的群组ID in: body name: req required: true schema: $ref: '#/definitions/base_info.DismissGroupReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.DismissGroupResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.DismissGroupResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.DismissGroupResp' summary: 解散群组 tags: - 群组相关 /group/get_group_all_member_list: post: consumes: - application/json description: 获取全部群成员列表 operationId: GetGroupAllMemberList parameters: - description: im token in: header name: token required: true type: string - description: GroupID为要获取群成员的群ID in: body name: req required: true schema: $ref: '#/definitions/base_info.GetGroupAllMemberReq' produces: - application/json responses: "0": description: "" schema: allOf: - $ref: '#/definitions/base_info.GetGroupAllMemberResp' - properties: data: items: $ref: '#/definitions/server_api_params.GroupMemberFullInfo' type: array type: object "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetGroupAllMemberResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetGroupAllMemberResp' summary: 获取全部群成员列表 tags: - 群组相关 /group/get_group_members_info: post: consumes: - application/json description: 获取群成员信息 operationId: GetGroupMembersInfo parameters: - description: im token in: header name: token required: true type: string - description: memberList为要获取群成员的群ID列表 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetGroupMembersInfoReq' produces: - application/json responses: "0": description: "" schema: allOf: - $ref: '#/definitions/base_info.GetGroupMembersInfoResp' - properties: data: items: $ref: '#/definitions/server_api_params.GroupMemberFullInfo' type: array type: object "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetGroupMembersInfoResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetGroupMembersInfoResp' summary: 获取群成员信息 tags: - 群组相关 /group/get_groups_info: post: consumes: - application/json description: 通过群ID列表获取群信息 operationId: GetGroupsInfo parameters: - description: im token in: header name: token required: true type: string - description: groupIDList为群ID列表 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetGroupInfoReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetGroupInfoResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetGroupInfoResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetGroupInfoResp' summary: 通过群ID列表获取群信息 tags: - 群组相关 /group/get_joined_group_list: post: consumes: - application/json description: 获取用户加入群列表 operationId: GetJoinedGroupList parameters: - description: im token in: header name: token required: true type: string - description: fromUserID为要获取的用户ID in: body name: req required: true schema: $ref: '#/definitions/base_info.GetJoinedGroupListReq' produces: - application/json responses: "0": description: "" schema: allOf: - $ref: '#/definitions/base_info.GetJoinedGroupListResp' - properties: data: items: $ref: '#/definitions/server_api_params.GroupInfo' type: array type: object "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetJoinedGroupListResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetJoinedGroupListResp' summary: 获取用户加入群列表 tags: - 群组相关 /group/get_recv_group_applicationList: post: consumes: - application/json description: 获取用户收到的加群信息列表 operationId: GetRecvGroupApplicationList parameters: - description: im token in: header name: token required: true type: string - description: fromUserID为要获取的用户ID in: body name: req required: true schema: $ref: '#/definitions/base_info.GetGroupApplicationListReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetGroupApplicationListResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetGroupApplicationListResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetGroupApplicationListResp' summary: 获取用户收到的加群信息列表 tags: - 群组相关 /group/get_user_req_group_applicationList: post: consumes: - application/json description: 获取用户加群申请列表 operationId: GetUserReqGroupApplicationList parameters: - description: im token in: header name: token required: true type: string - description: userID为要获取的用户ID in: body name: req required: true schema: $ref: '#/definitions/base_info.GetUserReqGroupApplicationListReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetGroupApplicationListResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetGroupApplicationListResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetGroupApplicationListResp' summary: 获取用户加群申请列表 tags: - 群组相关 /group/group_application_response: post: consumes: - application/json description: 处理加群消息 operationId: ApplicationGroupResponse parameters: - description: im token in: header name: token required: true type: string - description: groupID为要处理的群ID
fromUserID为要处理的用户ID
handleMsg为处理结果信息
handleResult为处理结果 1为同意加群 2为拒绝加群 in: body name: req required: true schema: $ref: '#/definitions/base_info.ApplicationGroupResponseReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.ApplicationGroupResponseResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.ApplicationGroupResponseResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.ApplicationGroupResponseResp' summary: 处理加群消息 tags: - 群组相关 /group/invite_user_to_group: post: consumes: - application/json description: 将用户拉入群组 operationId: InviteUserToGroup parameters: - description: im token in: header name: token required: true type: string - description: groupID为要拉进的群组ID
invitedUserIDList为要获取群成员的群ID列表
reason为原因 in: body name: req required: true schema: $ref: '#/definitions/base_info.InviteUserToGroupReq' produces: - application/json responses: "0": description: result为结果码, -1为失败, 0为成功 schema: $ref: '#/definitions/base_info.InviteUserToGroupResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.InviteUserToGroupResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.InviteUserToGroupResp' summary: 将用户拉入群组 tags: - 群组相关 /group/join_group: post: consumes: - application/json description: 加入群聊 operationId: JoinGroup parameters: - description: im token in: header name: token required: true type: string - description: reqMessage为申请进群信息 in: body name: req required: true schema: $ref: '#/definitions/base_info.JoinGroupReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.JoinGroupResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.JoinGroupResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.JoinGroupResp' summary: 加入群聊 tags: - 群组相关 /group/kick_group: post: consumes: - application/json description: 把用户踢出群组 operationId: KickGroupMember parameters: - description: im token in: header name: token required: true type: string - description: GroupID为要操作的群ID
kickedUserIDList为要踢出的群用户ID
reason为原因 in: body name: req required: true schema: $ref: '#/definitions/base_info.KickGroupMemberReq' produces: - application/json responses: "0": description: result为结果码, -1为失败, 0为成功 schema: $ref: '#/definitions/base_info.KickGroupMemberResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.KickGroupMemberResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.KickGroupMemberResp' summary: 把用户踢出群组 tags: - 群组相关 /group/mute_group: post: consumes: - application/json description: 禁言群组 operationId: MuteGroup parameters: - description: im token in: header name: token required: true type: string - description: groupID为群组ID in: body name: req required: true schema: $ref: '#/definitions/base_info.MuteGroupReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.MuteGroupResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.MuteGroupResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.MuteGroupResp' summary: 禁言群组 tags: - 群组相关 /group/mute_group_member: post: consumes: - application/json description: 禁言群成员 operationId: MuteGroupMember parameters: - description: im token in: header name: token required: true type: string - description: groupID为群组ID
userID为要禁言的用户ID
mutedSeconds为禁言秒数 in: body name: req required: true schema: $ref: '#/definitions/base_info.MuteGroupMemberReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.DismissGroupResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.DismissGroupResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.DismissGroupResp' summary: 禁言群成员 tags: - 群组相关 /group/quit_group: post: consumes: - application/json description: 退出群聊 operationId: QuitGroup parameters: - description: im token in: header name: token required: true type: string - description: groupID为要退出的群ID in: body name: req required: true schema: $ref: '#/definitions/base_info.QuitGroupReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.QuitGroupResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.QuitGroupResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.QuitGroupResp' summary: 退出群聊 tags: - 群组相关 /group/set_group_info: post: consumes: - application/json description: 设置群信息 operationId: SetGroupInfo parameters: - description: im token in: header name: token required: true type: string - description: notification为群介绍
introduction为群公告
needVerification为加群验证 0为申请需要同意 邀请直接进 1为所有人进群需要验证，除了群主管理员邀请进群 2为直接进群 in: body name: req required: true schema: $ref: '#/definitions/base_info.SetGroupInfoReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.SetGroupInfoResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.SetGroupInfoResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.SetGroupInfoResp' summary: 设置群信息 tags: - 群组相关 /group/set_group_member_info: post: consumes: - application/json description: 修改群成员信息 operationId: SetGroupMemberInfo parameters: - description: im token in: header name: token required: true type: string - description: 除了operationID, userID, groupID其他参数可选 in: body name: req required: true schema: $ref: '#/definitions/base_info.SetGroupMemberInfoReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.SetGroupMemberInfoResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.SetGroupMemberInfoResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.SetGroupMemberInfoResp' summary: 修改群成员信息 tags: - 群组相关 /group/transfer_group: post: consumes: - application/json description: 转让群主 operationId: TransferGroupOwner parameters: - description: im token in: header name: token required: true type: string - description: GroupID为要操作的群ID
oldOwnerUserID为老群主ID
newOwnerUserID为新群主ID in: body name: req required: true schema: $ref: '#/definitions/base_info.TransferGroupOwnerReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.TransferGroupOwnerResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.TransferGroupOwnerResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.TransferGroupOwnerResp' summary: 转让群主 tags: - 群组相关 /msg/clear_msg: post: consumes: - application/json description: 清空用户消息 operationId: ClearMsg parameters: - description: im token in: header name: token required: true type: string - description: userID为要清空的用户ID in: body name: req required: true schema: $ref: '#/definitions/base_info.CleanUpMsgReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.CleanUpMsgResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.CleanUpMsgResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.CleanUpMsgResp' summary: 清空用户消息 tags: - 消息相关 /msg/del_msg: post: consumes: - application/json description: 根据seq列表删除消息 operationId: DelMsg parameters: - description: im token in: header name: token required: true type: string - description: userID为要删除的用户ID
seqList为seq列表 in: body name: req required: true schema: $ref: '#/definitions/base_info.DelMsgReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.DelMsgResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.DelMsgResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.DelMsgResp' summary: 根据seq列表删除消息 tags: - 消息相关 /office/comment_one_work_moment: post: consumes: - application/json description: 评论一条工作圈 operationId: CommentOneWorkMoment parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.CommentOneWorkMomentReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.CommentOneWorkMomentResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.CommentOneWorkMomentResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.CommentOneWorkMomentResp' summary: 评论一条工作圈 tags: - 工作圈 /office/create_one_work_moment: post: consumes: - application/json description: 用户创建一条工作圈 operationId: CreateOneWorkMoment parameters: - description: im token in: header name: token required: true type: string - description: 请求 atUserList likeUserList permissionGroupList permissionUserList 字段中userName可以不填 in: body name: req required: true schema: $ref: '#/definitions/base_info.CreateOneWorkMomentReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.CreateOneWorkMomentResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.CreateOneWorkMomentResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.CreateOneWorkMomentResp' summary: 创建一条工作圈 tags: - 工作圈 /office/create_tag: post: consumes: - application/json description: 创建标签 operationId: CreateTag parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.CreateTagReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.CreateTagResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.CreateTagResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.CreateTagResp' summary: 创建标签 tags: - 标签 /office/delete_comment: post: consumes: - application/json description: 删除一条评论 operationId: DeleteComment parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.DeleteCommentReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.DeleteCommentResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.DeleteCommentResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.DeleteCommentResp' summary: 删除一条评论 tags: - 工作圈 /office/delete_one_work_moment: post: consumes: - application/json description: 根据用户工作圈ID删除一条工作圈 operationId: DeleteOneWorkMoment parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.DeleteOneWorkMomentReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.DeleteOneWorkMomentResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.DeleteOneWorkMomentResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.DeleteOneWorkMomentResp' summary: 删除一条工作圈 tags: - 工作圈 /office/delete_tag: post: consumes: - application/json description: 根据标签ID创建标签 operationId: DeleteTag parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.DeleteTagReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.DeleteTagResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.DeleteTagResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.DeleteTagResp' summary: 删除标签 tags: - 标签 /office/get_send_tag_log: post: consumes: - application/json description: 分页获取发送历史记录 operationId: GetTagSendLogs parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetTagSendLogsReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetTagSendLogsResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetTagSendLogsResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetTagSendLogsResp' summary: 获取发送历史记录 tags: - 标签 /office/get_user_friend_work_moments: post: consumes: - application/json description: 查询用户工作圈页面 operationId: GetUserFriendWorkMoments parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetUserFriendWorkMomentsReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetUserFriendWorkMomentsResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetUserFriendWorkMomentsResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetUserFriendWorkMomentsResp' summary: 查询自己大工作圈页面 tags: - 工作圈 /office/get_user_tag_by_id: post: consumes: - application/json description: 通过标签id获取该用户的标签信息 operationId: GetUserTagByID parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetUserTagByIDReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetUserTagByIDResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetUserTagByIDResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetUserTagByIDResp' summary: 获取该用户的标签信息 tags: - 标签 /office/get_user_tags: post: consumes: - application/json description: 用户获取自己的所有的标签 operationId: GetUserTags parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetUserTagsReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetUserTagsResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetUserTagsResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetUserTagsResp' summary: 获取用户标签信息 tags: - 标签 /office/get_user_work_moments: post: consumes: - application/json description: 查询用户工作圈 operationId: GetUserWorkMoments parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetUserWorkMomentsReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetUserWorkMomentsResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetUserWorkMomentsResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetUserWorkMomentsResp' summary: 查询用户工作圈 tags: - 工作圈 /office/get_work_moment_by_id: post: consumes: - application/json description: 通过ID获取工作圈 operationId: GetWorkMomentByID parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetWorkMomentByIDReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetWorkMomentByIDResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetWorkMomentByIDResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetWorkMomentByIDResp' summary: 通过ID获取工作圈 tags: - 工作圈 /office/like_one_work_moment: post: consumes: - application/json description: 工作圈ID点赞一条工作圈 operationId: LikeOneWorkMoment parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.LikeOneWorkMomentReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.LikeOneWorkMomentResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.LikeOneWorkMomentResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.LikeOneWorkMomentResp' summary: 点赞一条工作圈 tags: - 工作圈 /office/send_msg_to_tag: post: consumes: - application/json description: 对标签用户发送消息 operationId: SendMsg2Tag parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.SendMsg2TagReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.SendMsg2TagResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.SendMsg2TagResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.SendMsg2TagResp' summary: 发送标签消息 tags: - 标签 /office/set_tag: post: consumes: - application/json description: 根据标签ID修改标签用户列表, 名称 operationId: SetTag parameters: - description: im token in: header name: token required: true type: string - description: 请求 in: body name: req required: true schema: $ref: '#/definitions/base_info.SetTagReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.SetTagResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.SetTagResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.SetTagResp' summary: 修改标签 tags: - 标签 /third/minio_upload: post: consumes: - application/json description: minio上传文件(web api), 请注意本api请求为form并非json operationId: MinioUploadFile parameters: - description: im token in: header name: token required: true type: string - description: 要上传的文件文件 in: formData name: file required: true type: file - description: 文件类型 in: formData name: fileType required: true type: integer - description: 操作唯一ID in: formData name: operationID required: true type: string produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.MinioUploadFileResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.MinioUploadFileResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.MinioUploadFileResp' summary: minio上传文件(web api) tags: - 第三方服务相关 /user/account_check: post: consumes: - application/json description: 传入UserIDList检查列表账户注册状态，并且返回结果 operationId: AccountCheck parameters: - description: im token in: header name: token required: true type: string - description: 请求体 in: body name: req required: true schema: $ref: '#/definitions/base_info.AccountCheckReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.AccountCheckResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.AccountCheckResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.AccountCheckResp' summary: 检查列表账户注册状态，并且返回结果 tags: - 用户相关 /user/get_all_users_uid: post: consumes: - application/json description: 获取所有用户uid列表 operationId: GetAllUsersUid parameters: - description: im token in: header name: token required: true type: string - description: 请求体 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetAllUsersUidReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetAllUsersUidResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetAllUsersUidResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetAllUsersUidResp' summary: 获取所有用户uid列表 tags: - 用户相关 /user/get_self_user_info: post: consumes: - application/json description: 传入ID获取自己的信息 operationId: GetSelfUserInfo parameters: - description: im token in: header name: token required: true type: string - description: 请求体 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetSelfUserInfoReq' produces: - application/json responses: "0": description: "" schema: allOf: - $ref: '#/definitions/base_info.GetSelfUserInfoResp' - properties: data: $ref: '#/definitions/server_api_params.UserInfo' type: object "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetSelfUserInfoResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetSelfUserInfoResp' summary: 获取自己的信息 tags: - 用户相关 /user/get_users_info: post: consumes: - application/json description: 根据用户列表批量获取用户信息 operationId: GetUsersInfo parameters: - description: im token in: header name: token required: true type: string - description: 请求体 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetUsersInfoReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetUsersInfoResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetUsersInfoResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetUsersInfoResp' summary: 获取用户信息 tags: - 用户相关 /user/get_users_online_status: post: consumes: - application/json description: 获取用户在线状态 operationId: GetUsersOnlineStatus parameters: - description: im token in: header name: token required: true type: string - description: 请求体 in: body name: req required: true schema: $ref: '#/definitions/base_info.GetUsersOnlineStatusReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.GetUsersOnlineStatusResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.GetUsersOnlineStatusResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.GetUsersOnlineStatusResp' summary: 获取用户在线状态 tags: - 用户相关 /user/set_global_msg_recv_opt: post: consumes: - application/json description: 设置全局免打扰 operationId: SetGlobalRecvMessageOpt parameters: - description: im token in: header name: token required: true type: string - description: 请求体 in: body name: req required: true schema: $ref: '#/definitions/base_info.SetGlobalRecvMessageOptReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.SetGlobalRecvMessageOptResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.SetGlobalRecvMessageOptResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.SetGlobalRecvMessageOptResp' summary: 设置全局免打扰 tags: - 用户相关 /user/update_user_info: post: consumes: - application/json description: 修改用户信息 userID faceURL等 operationId: UpdateUserInfo parameters: - description: im token in: header name: token required: true type: string - description: 请求体 in: body name: req required: true schema: $ref: '#/definitions/base_info.UpdateSelfUserInfoReq' produces: - application/json responses: "0": description: "" schema: $ref: '#/definitions/base_info.UpdateUserInfoResp' "400": description: errCode为400 一般为参数输入错误, token未带上等 schema: $ref: '#/definitions/base_info.UpdateUserInfoResp' "500": description: errCode为500 一般为服务器内部错误 schema: $ref: '#/definitions/base_info.UpdateUserInfoResp' summary: 修改用户信息 tags: - 用户相关 swagger: "2.0"