basePath: /api/v1 definitions: model.AddressLoginResp: properties: address: description: 用户地址 example: "123" type: string type: object model.FocusMsgReq: properties: logId: type: integer type: enum: - 0 - 1 type: integer required: - logId type: object model.GeneralResponse: properties: data: type: object message: type: string result: type: integer type: object model.GetModuleResp: properties: endPoints: items: type: string type: array isEnabled: type: boolean name: enum: - wallet - oa - redpacket type: string type: object model.GetPriRecordsReq: properties: count: description: 消息数量 type: integer logId: description: 消息 ID type: string targetId: description: 接受者 ID type: string required: - count - targetId type: object model.GetPriRecordsResp: properties: record_count: description: 聊天记录数量 type: integer records: description: 聊天记录 items: $ref: '#/definitions/model.Record' type: array type: object model.Record: properties: content: description: 消息内容 type: object createTime: description: 消息发送时间 type: integer fromId: description: 发送者 id type: string logId: description: log id type: string msgId: description: msg id (uuid) type: string msgType: description: 消息类型 type: integer targetId: description: 接收者 id type: string type: object model.RevokeMsgReq: properties: logId: type: integer type: enum: - 0 - 1 type: integer required: - logId type: object types.ChangeOwnerReq: properties: id: description: 群 ID type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string memberId: description: 被转让为群主的群成员 ID type: string required: - memberId type: object types.ChangeOwnerResp: type: object types.CreateGroupReq: properties: avatar: type: string introduce: type: string memberIds: items: type: string type: array name: type: string type: object types.CreateGroupResp: properties: adminNum: description: 群内管理员数量 type: integer avatar: description: 头像 url type: string createTime: description: 群创建时间 type: integer friendType: description: 加好友限制, 0=群内可加好友,1=群内禁止加好友 type: integer groupType: description: '群类型 (0: 普通群, 1: 全员群, 2: 部门群)' type: integer id: description: 群 ID type: integer idStr: type: string introduce: type: string joinType: description: 加群方式,0=无需审批(默认),1=禁止加群,群主和管理员邀请加群, 2=普通人邀请需要审批,群主和管理员直接加群 type: integer key: type: string markId: description: 群显示的 ID type: string maximum: description: 群人数上限 type: integer memberNum: description: 群人数 type: integer members: description: 群成员 items: $ref: '#/definitions/types.GroupMember' type: array muteNum: description: 群内当前被禁言的人数 type: integer muteType: description: 禁言, 0=全员可发言, 1=全员禁言(除群主和管理员) type: integer name: description: 群名称 加密的 type: string owner: $ref: '#/definitions/types.GroupMember' description: 群主 信息 person: $ref: '#/definitions/types.GroupMember' description: 本人在群内的信息 publicName: description: 公开的群名称 不加密的 type: string status: description: 群状态,0=正常 1=封禁 2=解散 type: integer type: object types.GeneralResp: properties: data: type: object message: type: integer result: type: integer type: object types.GetGroupInfoReq: properties: id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string type: object types.GetGroupInfoResp: properties: adminNum: description: 群内管理员数量 type: integer avatar: description: 头像 url type: string createTime: description: 群创建时间 type: integer friendType: description: 加好友限制, 0=群内可加好友,1=群内禁止加好友 type: integer groupType: description: '群类型 (0: 普通群, 1: 全员群, 2: 部门群)' type: integer id: description: 群 ID type: integer idStr: type: string introduce: type: string joinType: description: 加群方式,0=无需审批(默认),1=禁止加群,群主和管理员邀请加群, 2=普通人邀请需要审批,群主和管理员直接加群 type: integer key: type: string markId: description: 群显示的 ID type: string maximum: description: 群人数上限 type: integer memberNum: description: 群人数 type: integer members: items: $ref: '#/definitions/types.GroupMember' type: array muteNum: description: 群内当前被禁言的人数 type: integer muteType: description: 禁言, 0=全员可发言, 1=全员禁言(除群主和管理员) type: integer name: description: 群名称 加密的 type: string owner: $ref: '#/definitions/types.GroupMember' description: 群主 信息 person: $ref: '#/definitions/types.GroupMember' description: 本人在群内的信息 publicName: description: 公开的群名称 不加密的 type: string status: description: 群状态,0=正常 1=封禁 2=解散 type: integer type: object types.GetGroupListReq: type: object types.GetGroupListResp: properties: groups: items: $ref: '#/definitions/types.GroupInfo' type: array type: object types.GetGroupMemberInfoReq: properties: id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string memberId: type: string required: - memberId type: object types.GetGroupMemberInfoResp: properties: memberId: description: 用户 ID type: string memberMuteTime: description: 该用户被禁言结束的时间 9223372036854775807=永久禁言 type: integer memberName: description: 用户群昵称 type: string memberType: description: 用户角色,2=群主,1=管理员,0=群员,10=退群 type: integer type: object types.GetGroupMemberListReq: properties: id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string type: object types.GetGroupMemberListResp: properties: id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string members: items: $ref: '#/definitions/types.GroupMember' type: array type: object types.GetGroupPubInfoReq: properties: id: description: 群 ID type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string type: object types.GetGroupPubInfoResp: properties: adminNum: description: 群内管理员数量 type: integer avatar: description: 头像 url type: string createTime: description: 群创建时间 type: integer friendType: description: 加好友限制, 0=群内可加好友,1=群内禁止加好友 type: integer groupType: description: '群类型 (0: 普通群, 1: 全员群, 2: 部门群)' type: integer id: description: 群 ID type: integer idStr: type: string introduce: type: string joinType: description: 加群方式,0=无需审批(默认),1=禁止加群,群主和管理员邀请加群, 2=普通人邀请需要审批,群主和管理员直接加群 type: integer key: type: string markId: description: 群显示的 ID type: string maximum: description: 群人数上限 type: integer memberNum: description: 群人数 type: integer muteNum: description: 群内当前被禁言的人数 type: integer muteType: description: 禁言, 0=全员可发言, 1=全员禁言(除群主和管理员) type: integer name: description: 群名称 加密的 type: string owner: $ref: '#/definitions/types.GroupMember' description: 群主 信息 person: $ref: '#/definitions/types.GroupMember' description: 本人在群内的信息 publicName: description: 公开的群名称 不加密的 type: string status: description: 群状态,0=正常 1=封禁 2=解散 type: integer type: object types.GetMuteListReq: properties: id: description: 群 ID type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string type: object types.GetMuteListResp: properties: members: items: $ref: '#/definitions/types.GroupMember' type: array type: object types.GroupDisbandReq: properties: id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string type: object types.GroupDisbandResp: type: object types.GroupExitReq: properties: id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string type: object types.GroupExitResp: type: object types.GroupInfo: properties: adminNum: description: 群内管理员数量 type: integer avatar: description: 头像 url type: string createTime: description: 群创建时间 type: integer friendType: description: 加好友限制, 0=群内可加好友,1=群内禁止加好友 type: integer groupType: description: '群类型 (0: 普通群, 1: 全员群, 2: 部门群)' type: integer id: description: 群 ID type: integer idStr: type: string introduce: type: string joinType: description: 加群方式,0=无需审批(默认),1=禁止加群,群主和管理员邀请加群, 2=普通人邀请需要审批,群主和管理员直接加群 type: integer key: type: string markId: description: 群显示的 ID type: string maximum: description: 群人数上限 type: integer memberNum: description: 群人数 type: integer muteNum: description: 群内当前被禁言的人数 type: integer muteType: description: 禁言, 0=全员可发言, 1=全员禁言(除群主和管理员) type: integer name: description: 群名称 加密的 type: string owner: $ref: '#/definitions/types.GroupMember' description: 群主 信息 person: $ref: '#/definitions/types.GroupMember' description: 本人在群内的信息 publicName: description: 公开的群名称 不加密的 type: string status: description: 群状态,0=正常 1=封禁 2=解散 type: integer type: object types.GroupMember: properties: memberId: description: 用户 ID type: string memberMuteTime: description: 该用户被禁言结束的时间 9223372036854775807=永久禁言 type: integer memberName: description: 用户群昵称 type: string memberType: description: 用户角色,2=群主,1=管理员,0=群员,10=退群 type: integer type: object types.GroupRemoveReq: properties: id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string memberIds: items: type: string type: array required: - memberIds type: object types.GroupRemoveResp: properties: memberIds: description: 成功被踢的成员列表 items: type: string type: array memberNum: description: 群人数 type: integer type: object types.InviteGroupMembersReq: properties: id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string newMemberIds: items: type: string type: array required: - newMemberIds type: object types.InviteGroupMembersResp: properties: id: example: 123821199217135616 type: integer idStr: type: string memberNum: example: 5 type: integer type: object types.JoinGroupReq: properties: id: type: integer idStr: type: string inviterId: type: string type: object types.JoinGroupResp: properties: id: type: integer idStr: type: string type: object types.SetAdminReq: properties: id: description: 群 ID type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string memberId: description: 被设置的群成员 ID type: string memberType: description: 用户角色 0=群员, 1=管理员 type: integer required: - memberId type: object types.SetAdminResp: type: object types.UpdateGroupAvatarReq: properties: avatar: type: string id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string type: object types.UpdateGroupAvatarResp: type: object types.UpdateGroupFriendTypeReq: properties: friendType: description: 加好友限制, 0=群内可加好友,1=群内禁止加好友 type: integer id: description: 群 ID type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string type: object types.UpdateGroupFriendTypeResp: type: object types.UpdateGroupJoinTypeReq: properties: id: description: 群 ID type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string joinType: description: 加群方式,0=无需审批(默认),1=禁止加群,群主和管理员邀请加群, 2=普通人邀请需要审批,群主和管理员直接加群 type: integer type: object types.UpdateGroupJoinTypeResp: type: object types.UpdateGroupMemberMuteTimeReq: properties: id: description: 群 ID type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string memberIds: description: 被禁言的群员 ID items: type: string type: array muteTime: description: 禁言持续时间, 传9223372036854775807=永久禁言, 0=解除禁言 type: integer required: - memberIds type: object types.UpdateGroupMemberMuteTimeResp: properties: members: items: $ref: '#/definitions/types.GroupMember' type: array type: object types.UpdateGroupMemberNameReq: properties: id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string memberName: type: string type: object types.UpdateGroupMemberNameResp: type: object types.UpdateGroupMuteTypeReq: properties: id: description: 群 ID type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string muteType: description: 禁言, 0=全员可发言, 1=全员禁言(除群主和管理员) type: integer type: object types.UpdateGroupMuteTypeResp: type: object types.UpdateGroupNameReq: properties: id: type: integer idStr: description: 如果同时填了 idStr, 则优先选择 idStr type: string name: type: string publicName: type: string type: object types.UpdateGroupNameResp: type: object host: localhost:8080 info: contact: {} title: 即时通讯系统后端接口 version: "1.0" paths: /app/group-list: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.GetGroupListReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.GetGroupListResp' type: object summary: 查询群列表 tags: - group 群信息 /app/modules/all: post: consumes: - application/json produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/model.GeneralResponse' - properties: data: items: $ref: '#/definitions/model.GetModuleResp' type: array type: object summary: 获取模块启用状态 tags: - startup 初始化模块 /app/mute-list: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.GetMuteListReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.GetMuteListResp' type: object summary: 查询群内被禁言成员名单 tags: - group 禁言 /app/pri-chat-record: post: consumes: - application/json parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/model.GetPriRecordsReq' produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/model.GeneralResponse' - properties: data: $ref: '#/definitions/model.GetPriRecordsResp' type: object summary: 获得聊天记录 tags: - record 消息模块 /app/record/focus: post: consumes: - application/json parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data required: true schema: $ref: '#/definitions/model.FocusMsgReq' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/model.GeneralResponse' summary: 关注消息 tags: - record 消息模块 /app/record/revoke: post: consumes: - application/json parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data required: true schema: $ref: '#/definitions/model.RevokeMsgReq' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/model.GeneralResponse' summary: 撤回消息 tags: - record 消息模块 /group/app/avatar: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.UpdateGroupAvatarReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.UpdateGroupAvatarResp' type: object summary: 更新群头像 tags: - group 群信息 /group/app/change-owner: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.ChangeOwnerReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.ChangeOwnerResp' type: object summary: 转让群 tags: - group 群动作 /group/app/create-group: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.CreateGroupReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.CreateGroupResp' type: object summary: 创建群 tags: - group 群动作 /group/app/friendType: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.UpdateGroupFriendTypeReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.UpdateGroupFriendTypeResp' type: object summary: 更新群内加好友设置 tags: - group 群信息 /group/app/group-disband: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.GroupDisbandReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.GroupDisbandResp' type: object summary: 解散群 tags: - group 群动作 /group/app/group-exit: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.GroupExitReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.GroupExitResp' type: object summary: 退群 tags: - group 群动作 /group/app/group-info: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.GetGroupInfoReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.GetGroupInfoResp' type: object summary: 查询群信息 tags: - group 群信息 /group/app/group-member-info: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.GetGroupMemberInfoReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.GetGroupMemberInfoResp' type: object summary: 查询群成员信息 tags: - group 群成员信息 /group/app/group-member-list: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.GetGroupMemberListReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.GetGroupMemberListResp' type: object summary: 查询群成员列表 tags: - group 群成员信息 /group/app/group-pub-info: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.GetGroupPubInfoReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.GetGroupPubInfoResp' type: object summary: 查询群公开信息 tags: - group 群信息 /group/app/group-remove: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.GroupRemoveReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.GroupRemoveResp' type: object summary: 踢人 tags: - group 群动作 /group/app/invite-group-members: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.InviteGroupMembersReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.InviteGroupMembersResp' type: object summary: 邀请新群员 tags: - group 群动作 /group/app/join-group: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.JoinGroupReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.JoinGroupResp' type: object summary: 直接进群 tags: - group 群动作 /group/app/joinType: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.UpdateGroupJoinTypeReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.UpdateGroupJoinTypeResp' type: object summary: 更新群内加好友设置 tags: - group 群信息 /group/app/member/muteTime: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.UpdateGroupMemberMuteTimeReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.UpdateGroupMemberMuteTimeResp' type: object summary: 更新群成员禁言时间 tags: - group 禁言 /group/app/member/name: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.UpdateGroupMemberNameReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.UpdateGroupMemberNameResp' type: object summary: 更新群成员昵称 tags: - group 群成员信息 /group/app/member/type: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.SetAdminReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.SetAdminResp' type: object summary: 设置管理员 tags: - group 群成员信息 /group/app/muteType: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.UpdateGroupMuteTypeReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.UpdateGroupMuteTypeResp' type: object summary: 更新群内加好友设置 tags: - group 群信息 /group/app/name: post: parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: body in: body name: data schema: $ref: '#/definitions/types.UpdateGroupNameReq' responses: "200": description: OK schema: allOf: - $ref: '#/definitions/types.GeneralResp' - properties: data: $ref: '#/definitions/types.UpdateGroupNameResp' type: object summary: 更新群名称 tags: - group 群信息 /record/push: post: consumes: - multipart/form-data description: comet.Proto由接口组装,客户端只需传入comet.Proto的body部分 parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: 消息协议序列化 in: body name: message required: true schema: type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/model.GeneralResponse' summary: 推送消息 tags: - record 消息模块 /record/push2: post: consumes: - multipart/form-data description: comet.Proto由客户端传入 parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string - description: 消息协议序列化 in: body name: message required: true schema: type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/model.GeneralResponse' summary: 推送消息2 tags: - record 消息模块 /user/login: post: consumes: - application/json description: 内部接口,comet层使用 parameters: - description: MOCK in: header name: FZM-SIGNATURE required: true type: string produces: - application/json responses: "200": description: OK schema: allOf: - $ref: '#/definitions/model.GeneralResponse' - properties: data: $ref: '#/definitions/model.AddressLoginResp' type: object summary: 用户登录 tags: - account 账户模块 schemes: - https swagger: "2.0"