This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.
{
"swagger": "2.0",
"info": {
"description": "open-IM-Server 的API服务器文档, 文档中所有请求都有一个operationID字段用于链路追踪",
"title": "open-IM-Server API",
"contact": {},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0"
"basePath": "/",
"paths": {
"/auth/force_logout": {
"post": {
"description": "对应的平台强制登出",
"consumes": [
"application/json"
],
"produces": [
"tags": [
"鉴权认证"
"summary": "强制登出",
"operationId": "ForceLogout",
"parameters": [
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
"description": "platform为平台ID \u003cbr\u003e fromUserID为要执行强制登出的用户ID",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.ForceLogoutReq"
}
"responses": {
"0": {
"description": "",
"$ref": "#/definitions/base_info.ForceLogoutResp"
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"$ref": "#/definitions/base_info.Swagger400Resp"
"500": {
"description": "errCode为500 一般为服务器内部错误",
"$ref": "#/definitions/base_info.Swagger500Resp"
"/auth/parse_token": {
"description": "解析当前用户token(token在请求头中传入)",
"summary": "解析当前用户token",
"operationId": "ParseToken",
"description": "secret为openIM密钥, 详细见服务端config.yaml secret字段\u003cbr\u003eplatform为平台ID",
"$ref": "#/definitions/base_info.ParseTokenReq"
"allOf": [
"$ref": "#/definitions/base_info.ParseTokenResp"
"type": "object",
"properties": {
"Data": {
"$ref": "#/definitions/base_info.ExpireTime"
]
"/auth/user_register": {
"description": "用户注册",
"summary": "用户注册",
"operationId": "UserRegister",
"description": "secret为openIM密钥, 详细见服务端config.yaml secret字段 \u003cbr\u003e platform为平台ID \u003cbr\u003e ex为拓展字段 \u003cbr\u003e gender为性别, 0为女, 1为男",
"$ref": "#/definitions/base_info.UserRegisterReq"
"$ref": "#/definitions/base_info.UserRegisterResp"
"/auth/user_token": {
"description": "获取用户的token",
"summary": "用户登录",
"operationId": "UserToken",
"description": "secret为openIM密钥, 详细见服务端config.yaml secret字段 \u003cbr\u003e platform为平台ID",
"$ref": "#/definitions/base_info.UserTokenReq"
"$ref": "#/definitions/base_info.UserTokenResp"
"/friend/add_black": {
"description": "添加黑名单",
"好友相关"
"summary": "添加黑名单",
"operationId": "AddBlack",
"description": "fromUserID为设置的用户 \u003cbr\u003e toUserID为被设置的用户",
"$ref": "#/definitions/base_info.AddBlacklistReq"
"$ref": "#/definitions/base_info.AddBlacklistResp"
"/friend/add_friend": {
"description": "添加好友",
"summary": "添加好友",
"operationId": "AddFriend",
"description": "reqMsg为申请信息 \u003cbr\u003e fromUserID为申请用户 \u003cbr\u003e toUserID为被添加用户",
"$ref": "#/definitions/base_info.AddFriendReq"
"$ref": "#/definitions/base_info.AddFriendResp"
"/friend/add_friend_response": {
"description": "同意/拒绝好友请求",
"summary": "同意/拒绝好友请求",
"operationId": "AddFriendResponse",
"description": "fromUserID同意/拒绝的用户ID\u003cbr\u003etoUserID为申请用户D\u003cbr\u003ehandleMsg为处理信息\u003cbr\u003eflag为具体操作, 1为同意, 2为拒绝",
"$ref": "#/definitions/base_info.AddFriendResponseReq"
"$ref": "#/definitions/base_info.AddFriendResponseResp"
"/friend/delete_friend": {
"description": "删除好友",
"summary": "删除好友",
"operationId": "DeleteFriend",
"description": "fromUserID为操作用户\u003cbr\u003etoUserID为被删除用户",
"$ref": "#/definitions/base_info.DeleteFriendReq"
"$ref": "#/definitions/base_info.DeleteFriendResp"
"/friend/get_black_list": {
"description": "获取黑名单列表",
"summary": "获取黑名单列表",
"operationId": "GetBlacklist",
"description": "fromUserID要获取黑名单的用户",
"$ref": "#/definitions/base_info.GetBlackListReq"
"$ref": "#/definitions/base_info.GetBlackListResp"
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/server_api_params.PublicUserInfo"
"/friend/get_friend_apply_list": {
"summary": "获取好友申请列表",
"operationId": "GetFriendApplyList",
"description": "fromUserID为要获取申请列表的用户ID",
"$ref": "#/definitions/base_info.GetFriendApplyListReq"
"$ref": "#/definitions/base_info.GetFriendApplyListResp"
"$ref": "#/definitions/server_api_params.FriendRequest"
"/friend/get_friend_list": {
"description": "获取用户的好友列表",
"summary": "获取用户的好友列表",
"operationId": "GetFriendList",
"description": "fromUserID为要获取好友列表的用户ID",
"$ref": "#/definitions/base_info.GetFriendListReq"
"$ref": "#/definitions/base_info.GetFriendListResp"
"$ref": "#/definitions/server_api_params.FriendInfo"
"/friend/get_self_friend_apply_list": {
"description": "获取自己的好友申请列表",
"summary": "获取自己的好友申请列表",
"operationId": "GetSelfFriendApplyList",
"description": "fromUserID为自己的用户ID",
"$ref": "#/definitions/base_info.GetSelfApplyListReq"
"$ref": "#/definitions/base_info.GetSelfApplyListResp"
"/friend/import_friend": {
"description": "批量加好友",
"summary": "批量加好友",
"operationId": "ImportFriend",
"description": "fromUserID批量加好友的用户ID\u003cbr\u003e friendUserIDList为",
"$ref": "#/definitions/base_info.ImportFriendReq"
"description": "data列表中对象的result-1为添加该用户失败\u003cbr\u003e0为成功",
"$ref": "#/definitions/base_info.ImportFriendResp"
"/friend/is_friend": {
"description": "检查用户之间是否为好友",
"summary": "检查用户之间是否为好友",
"operationId": "IsFriend",
"description": "fromUserID为请求用户\u003cbr\u003e toUserID为要检查的用户",
"$ref": "#/definitions/base_info.IsFriendReq"
"$ref": "#/definitions/base_info.IsFriendResp"
"/friend/remove_black": {
"description": "把用户移除黑名单",
"summary": "把用户移除黑名单",
"operationId": "RemoveBlack",
"$ref": "#/definitions/base_info.RemoveBlackListReq"
"$ref": "#/definitions/base_info.RemoveBlackListResp"
"/friend/set_friend_remark": {
"description": "设置好友备注",
"summary": "设置好友备注",
"operationId": "SetFriendRemark",
"description": "fromUserID为设置的用户\u003cbr\u003e toUserID为被设置的用户\u003cbr\u003e remark为好友备注",
"$ref": "#/definitions/base_info.SetFriendRemarkReq"
"$ref": "#/definitions/base_info.SetFriendRemarkResp"
"/group/cancel_mute_group": {
"description": "取消禁言群组",
"群组相关"
"summary": "取消禁言群组",
"operationId": "CancelMuteGroup",
"description": "groupID为群组ID",
"$ref": "#/definitions/base_info.CancelMuteGroupReq"
"$ref": "#/definitions/base_info.CancelMuteGroupResp"
"/group/cancel_mute_group_member": {
"description": "取消禁言群成员",
"summary": "取消禁言群成员",
"operationId": "CancelMuteGroupMember",
"description": "groupID为群组ID \u003cbr\u003e userID为要取消禁言的用户ID",
"$ref": "#/definitions/base_info.CancelMuteGroupMemberReq"
"$ref": "#/definitions/base_info.CancelMuteGroupMemberResp"
"/group/create_group": {
"description": "创建群组",
"summary": "创建群组",
"operationId": "CreateGroup",
"description": "groupType这里填0代表普通群 \u003cbr\u003egroupName为群名称\u003cbr\u003e introduction为群介绍\u003cbr\u003e notification为群公共\u003cbr\u003eownerUserID为群主ID \u003cbr\u003e ex为群扩展字段 \u003cbr\u003e memberList中对象roleLevel为群员角色,1为普通用户 2为群主 3为管理员",
"$ref": "#/definitions/base_info.CreateGroupReq"
"$ref": "#/definitions/base_info.CreateGroupResp"
"$ref": "#/definitions/server_api_params.GroupInfo"
"/group/dismiss_group": {
"description": "解散群组",
"summary": "解散群组",
"operationId": "DismissGroup",
"description": "groupID为要解散的群组ID",
"$ref": "#/definitions/base_info.DismissGroupReq"
"$ref": "#/definitions/base_info.DismissGroupResp"
"/group/get_group_all_member_list": {
"description": "获取全部群成员列表",
"summary": "获取全部群成员列表",
"operationId": "GetGroupAllMemberList",
"description": "GroupID为要获取群成员的群ID",
"$ref": "#/definitions/base_info.GetGroupAllMemberReq"
"$ref": "#/definitions/base_info.GetGroupAllMemberResp"
"$ref": "#/definitions/server_api_params.GroupMemberFullInfo"
"/group/get_group_members_info": {
"description": "获取群成员信息",
"summary": "获取群成员信息",
"operationId": "GetGroupMembersInfo",
"description": "groupID为要获取的群ID \u003cbr\u003e memberList为要获取群成员的群ID列表",
"$ref": "#/definitions/base_info.GetGroupMembersInfoReq"
"$ref": "#/definitions/base_info.GetGroupMembersInfoResp"
"/group/get_groups_info": {
"description": "通过群ID列表获取群信息",
"summary": "通过群ID列表获取群信息",
"operationId": "GetGroupsInfo",
"description": "groupIDList为群ID列表",
"$ref": "#/definitions/base_info.GetGroupInfoReq"
"$ref": "#/definitions/base_info.GetGroupInfoResp"
"/group/get_joined_group_list": {
"description": "获取用户加入群列表",
"summary": "获取用户加入群列表",
"operationId": "GetJoinedGroupList",
"description": "fromUserID为要获取的用户ID",
"$ref": "#/definitions/base_info.GetJoinedGroupListReq"
"$ref": "#/definitions/base_info.GetJoinedGroupListResp"
"/group/get_recv_group_applicationList": {
"description": "获取用户收到的加群信息列表",
"summary": "获取用户收到的加群信息列表",
"operationId": "GetRecvGroupApplicationList",
"$ref": "#/definitions/base_info.GetGroupApplicationListReq"
"$ref": "#/definitions/base_info.GetGroupApplicationListResp"
"$ref": "#/definitions/server_api_params.GroupRequest"
"/group/get_user_req_group_applicationList": {
"description": "获取用户加群申请列表",
"summary": "获取用户加群申请列表",
"operationId": "GetUserReqGroupApplicationList",
"description": "userID为要获取的用户ID",
"$ref": "#/definitions/base_info.GetUserReqGroupApplicationListReq"
"/group/group_application_response": {
"description": "处理加群消息",
"summary": "处理加群消息",
"operationId": "ApplicationGroupResponse",
"description": "groupID为要处理的群ID \u003cbr\u003e fromUserID为要处理的用户ID \u003cbr\u003e handleMsg为处理结果信息 \u003cbr\u003e handleResult为处理结果 1为同意加群 2为拒绝加群",
"$ref": "#/definitions/base_info.ApplicationGroupResponseReq"
"$ref": "#/definitions/base_info.ApplicationGroupResponseResp"
"/group/invite_user_to_group": {
"description": "将用户拉入群组",
"summary": "将用户拉入群组",
"operationId": "InviteUserToGroup",
"description": "groupID为要拉进的群组ID \u003cbr\u003e invitedUserIDList为要获取群成员的群ID列表 \u003cbr\u003e reason为原因",
"$ref": "#/definitions/base_info.InviteUserToGroupReq"
"description": "result为结果码, -1为失败, 0为成功",
"$ref": "#/definitions/base_info.InviteUserToGroupResp"
"/group/join_group": {
"description": "加入群聊",
"summary": "加入群聊",
"operationId": "JoinGroup",
"description": "reqMessage为申请进群信息\u003cbr\u003egroupID为申请的群ID",
"$ref": "#/definitions/base_info.JoinGroupReq"
"$ref": "#/definitions/base_info.JoinGroupResp"
"/group/kick_group": {
"description": "把用户踢出群组",
"summary": "把用户踢出群组",
"operationId": "KickGroupMember",
"description": "GroupID为要操作的群ID \u003cbr\u003e kickedUserIDList为要踢出的群用户ID \u003cbr\u003e reason为原因",
"$ref": "#/definitions/base_info.KickGroupMemberReq"
"$ref": "#/definitions/base_info.KickGroupMemberResp"
"/group/mute_group": {
"description": "禁言群组",
"summary": "禁言群组",
"operationId": "MuteGroup",
"$ref": "#/definitions/base_info.MuteGroupReq"
"$ref": "#/definitions/base_info.MuteGroupResp"
"/group/mute_group_member": {
"description": "禁言群成员",
"summary": "禁言群成员",
"operationId": "MuteGroupMember",
"description": "groupID为群组ID \u003cbr\u003e userID为要禁言的用户ID \u003cbr\u003e mutedSeconds为禁言秒数",
"$ref": "#/definitions/base_info.MuteGroupMemberReq"
"/group/quit_group": {
"description": "当前用户退出群聊",
"summary": "当前用户退出群聊",
"operationId": "QuitGroup",
"description": "groupID为要退出的群ID",
"$ref": "#/definitions/base_info.QuitGroupReq"
"$ref": "#/definitions/base_info.QuitGroupResp"
"/group/set_group_info": {
"description": "设置群信息",
"summary": "设置群信息",
"operationId": "SetGroupInfo",
"description": "groupID为要修改的群ID\u003cbr\u003egroupName为新的群名称\u003cbr\u003enotification为群介绍 \u003cbr\u003e introduction为群公告 \u003cbr\u003e needVerification为加群验证 0为申请需要同意 邀请直接进 1为所有人进群需要验证,除了群主管理员邀请进群 2为直接进群",
"$ref": "#/definitions/base_info.SetGroupInfoReq"
"$ref": "#/definitions/base_info.SetGroupInfoResp"
"/group/set_group_member_info": {
"description": "修改群成员信息",
"summary": "修改群成员信息",
"operationId": "SetGroupMemberInfo",
"description": "除了operationID, userID, groupID其他参数可选\u003cbr\u003eex为拓展字段\u003cbr\u003efaceURL为群头像\u003cbr\u003enickName为群昵称\u003cbr\u003eroleLevel为群员角色,1为普通用户 2为群主 3为管理员",
"$ref": "#/definitions/base_info.SetGroupMemberInfoReq"
"$ref": "#/definitions/base_info.SetGroupMemberInfoResp"
"/group/transfer_group": {
"description": "转让群主",
"summary": "转让群主",
"operationId": "TransferGroupOwner",
"description": "GroupID为要操作的群ID \u003cbr\u003e oldOwnerUserID为老群主ID \u003cbr\u003e newOwnerUserID为新群主ID",
"$ref": "#/definitions/base_info.TransferGroupOwnerReq"
"$ref": "#/definitions/base_info.TransferGroupOwnerResp"
"/msg/batch_send_msg": {
"description": "管理员批量发送群聊单聊消息 消息格式详细见\u003ca href=\"https://doc.rentsoft.cn/#/server_doc/admin?id=%e6%b6%88%e6%81%af%e7%b1%bb%e5%9e%8b%e6%a0%bc%e5%bc%8f%e6%8f%8f%e8%bf%b0\"\u003e消息格式\u003c/href\u003e",
"消息相关"
"summary": "管理员批量发送群聊单聊消息",
"operationId": "ManagementBatchSendMsg",
"description": "该请求和消息结构体一样 \u003cbr\u003e recvIDList为接受消息的用户ID列表",
"name": "管理员批量发送单聊消息",
"$ref": "#/definitions/base_info.ManagementBatchSendMsgReq"
"content": {
"$ref": "#/definitions/Open_IM_internal_api_manage.TextElem"
"name": "管理员批量发送OA通知",
"$ref": "#/definitions/base_info.ManagementSendMsgReq"
"$ref": "#/definitions/Open_IM_internal_api_manage.OANotificationElem"
"description": "serverMsgID为服务器消息ID \u003cbr\u003e clientMsgID为客户端消息ID \u003cbr\u003e sendTime为发送消息时间",
"/msg/clear_msg": {
"description": "清空用户消息",
"summary": "清空用户消息",
"operationId": "ClearMsg",
"description": "userID为要清空的用户ID",
"$ref": "#/definitions/base_info.CleanUpMsgReq"
"$ref": "#/definitions/base_info.CleanUpMsgResp"
"/msg/del_msg": {
"description": "根据seq列表删除消息",
"summary": "根据seq列表删除消息",
"operationId": "DelMsg",
"description": "userID为要删除的用户ID \u003cbr\u003e seqList为seq列表",
"$ref": "#/definitions/base_info.DelMsgReq"
"$ref": "#/definitions/base_info.DelMsgResp"
"/msg/get_all_conversations": {
"description": "获取用户所有会话",
"会话相关"
"summary": "获取用户所有会话",
"operationId": "GetAllConversations",
"description": "ownerUserID为要获取的用户ID",
"$ref": "#/definitions/base_info.GetAllConversationsReq"
"$ref": "#/definitions/base_info.GetAllConversationsResp"
"/msg/get_conversation": {
"description": "根据会话ID获取会话",
"summary": "根据会话ID获取会话",
"operationId": "GetConversation",
"description": "ownerUserID为要获取的用户ID\u003cbr\u003econversationID为要获取的会话ID",
"$ref": "#/definitions/base_info.GetConversationReq"
"$ref": "#/definitions/base_info.GetConversationResp"
"/msg/get_conversations": {
"description": "根据会话ID列表获取会话",
"summary": "根据会话ID列表获取会话",
"operationId": "GetConversations",
"description": "ownerUserID为要获取的用户ID\u003cbr\u003econversationIDs为要获取的会话ID列表",
"$ref": "#/definitions/base_info.GetConversationsReq"
"$ref": "#/definitions/base_info.GetConversationsResp"
"/msg/manage_send_msg": {
"description": "管理员发送/撤回消息 消息格式详细见\u003ca href=\"https://doc.rentsoft.cn/#/server_doc/admin?id=%e6%b6%88%e6%81%af%e7%b1%bb%e5%9e%8b%e6%a0%bc%e5%bc%8f%e6%8f%8f%e8%bf%b0\"\u003e消息格式\u003c/href\u003e",
"summary": "管理员发送/撤回消息",
"operationId": "ManagementSendMsg",
"description": "该请求和消息结构体一样",
"name": "管理员发送文字消息",
"name": "管理员发送OA通知消息",
"name": "管理员撤回单聊消息",
"$ref": "#/definitions/Open_IM_internal_api_manage.RevokeElem"
"$ref": "#/definitions/base_info.ManagementSendMsgResp"
"/office/comment_one_work_moment": {
"description": "评论一条工作圈",
"工作圈"
"summary": "评论一条工作圈",
"operationId": "CommentOneWorkMoment",
"description": "请求",
"$ref": "#/definitions/base_info.CommentOneWorkMomentReq"
"$ref": "#/definitions/base_info.CommentOneWorkMomentResp"
"/office/create_one_work_moment": {
"description": "用户创建一条工作圈",
"summary": "创建一条工作圈",
"operationId": "CreateOneWorkMoment",
"description": "请求 atUserList likeUserList permissionGroupList permissionUserList 字段中userName可以不填",
"$ref": "#/definitions/base_info.CreateOneWorkMomentReq"
"$ref": "#/definitions/base_info.CreateOneWorkMomentResp"
"/office/create_tag": {
"description": "创建标签",
"标签"
"summary": "创建标签",
"operationId": "CreateTag",
"$ref": "#/definitions/base_info.CreateTagReq"
"$ref": "#/definitions/base_info.CreateTagResp"
"/office/delete_comment": {
"description": "删除一条评论",
"summary": "删除一条评论",
"operationId": "DeleteComment",
"$ref": "#/definitions/base_info.DeleteCommentReq"
"$ref": "#/definitions/base_info.DeleteCommentResp"
"/office/delete_one_work_moment": {
"description": "根据用户工作圈ID删除一条工作圈",
"summary": "删除一条工作圈",
"operationId": "DeleteOneWorkMoment",
"$ref": "#/definitions/base_info.DeleteOneWorkMomentReq"
"$ref": "#/definitions/base_info.DeleteOneWorkMomentResp"
"/office/delete_tag": {
"description": "根据标签ID创建标签",
"summary": "删除标签",
"operationId": "DeleteTag",
"$ref": "#/definitions/base_info.DeleteTagReq"
"$ref": "#/definitions/base_info.DeleteTagResp"
"/office/get_send_tag_log": {
"description": "分页获取发送历史记录",
"summary": "获取发送历史记录",
"operationId": "GetTagSendLogs",
"$ref": "#/definitions/base_info.GetTagSendLogsReq"
"$ref": "#/definitions/base_info.GetTagSendLogsResp"
"/office/get_user_friend_work_moments": {
"description": "查询用户工作圈页面",
"summary": "查询自己大工作圈页面",
"operationId": "GetUserFriendWorkMoments",
"$ref": "#/definitions/base_info.GetUserFriendWorkMomentsReq"
"$ref": "#/definitions/base_info.GetUserFriendWorkMomentsResp"
"/office/get_user_tag_by_id": {
"description": "通过标签id获取该用户的标签信息",
"summary": "获取该用户的标签信息",
"operationId": "GetUserTagByID",
"$ref": "#/definitions/base_info.GetUserTagByIDReq"
"$ref": "#/definitions/base_info.GetUserTagByIDResp"
"/office/get_user_tags": {
"description": "用户获取自己的所有的标签",
"summary": "获取用户标签信息",
"operationId": "GetUserTags",
"$ref": "#/definitions/base_info.GetUserTagsReq"
"$ref": "#/definitions/base_info.GetUserTagsResp"
"/office/get_user_work_moments": {
"description": "查询用户工作圈",
"summary": "查询用户工作圈",
"operationId": "GetUserWorkMoments",
"$ref": "#/definitions/base_info.GetUserWorkMomentsReq"
"$ref": "#/definitions/base_info.GetUserWorkMomentsResp"
"/office/get_work_moment_by_id": {
"description": "通过ID获取工作圈",
"summary": "通过ID获取工作圈",
"operationId": "GetWorkMomentByID",
"$ref": "#/definitions/base_info.GetWorkMomentByIDReq"
"$ref": "#/definitions/base_info.GetWorkMomentByIDResp"
"/office/like_one_work_moment": {
"description": "工作圈ID点赞一条工作圈",
"summary": "点赞一条工作圈",
"operationId": "LikeOneWorkMoment",
"$ref": "#/definitions/base_info.LikeOneWorkMomentReq"
"$ref": "#/definitions/base_info.LikeOneWorkMomentResp"
"/office/send_msg_to_tag": {
"description": "对标签用户发送消息",
"summary": "发送标签消息",
"operationId": "SendMsg2Tag",
"$ref": "#/definitions/base_info.SendMsg2TagReq"
"$ref": "#/definitions/base_info.SendMsg2TagResp"
"/office/set_tag": {
"description": "根据标签ID修改标签用户列表, 名称",
"summary": "修改标签",
"operationId": "SetTag",
"$ref": "#/definitions/base_info.SetTagReq"
"$ref": "#/definitions/base_info.SetTagResp"
"/organization/create_department": {
"description": "创建部门",
"组织架构相关"
"summary": "创建部门",
"operationId": "CreateDepartment",
"$ref": "#/definitions/base_info.CreateDepartmentReq"
"$ref": "#/definitions/base_info.CreateDepartmentResp"
"$ref": "#/definitions/server_api_params.Department"
"/organization/create_department_member": {
"description": "创建部门用户",
"summary": "创建部门用户",
"operationId": "CreateDepartmentMember",
"$ref": "#/definitions/base_info.CreateDepartmentMemberReq"
"$ref": "#/definitions/base_info.CreateDepartmentMemberResp"
"/organization/create_organization_user": {
"description": "组织架构导入用户",
"summary": "组织架构导入用户",
"operationId": "CreateOrganizationUser",
"$ref": "#/definitions/base_info.CreateOrganizationUserReq"
"$ref": "#/definitions/base_info.CreateOrganizationUserResp"
"/organization/delete_department": {
"description": "删除部门",
"summary": "删除部门",
"operationId": "DeleteDepartment",
"$ref": "#/definitions/base_info.DeleteDepartmentReq"
"$ref": "#/definitions/base_info.DeleteDepartmentResp"
"/organization/delete_organization_user": {
"description": "删除组织架构中某个用户",
"summary": "删除组织架构中某个用户",
"operationId": "DeleteOrganizationUser",
"$ref": "#/definitions/base_info.DeleteOrganizationUserReq"
"$ref": "#/definitions/base_info.DeleteOrganizationUserResp"
"/organization/delete_user_in_department": {
"description": "删除部门中某个用户",
"summary": "删除部门中某个用户",
"operationId": "DeleteUserInDepartment",
"$ref": "#/definitions/base_info.DeleteUserInDepartmentReq"
"$ref": "#/definitions/base_info.DeleteUserInDepartmentResp"
"/organization/get_department_member": {
"description": "获取部门中所有成员",
"summary": "获取部门中所有成员",
"operationId": "GetDepartmentMember",
"$ref": "#/definitions/base_info.GetDepartmentMemberReq"
"$ref": "#/definitions/base_info.GetDepartmentMemberResp"
"$ref": "#/definitions/server_api_params.UserDepartmentMember"
"/organization/get_sub_department": {
"description": "获取子部门列表",
"summary": "获取子部门列表",
"operationId": "GetSubDepartment",
"$ref": "#/definitions/base_info.GetSubDepartmentReq"
"$ref": "#/definitions/base_info.GetSubDepartmentResp"
"/organization/get_user_in_department": {
"description": "获取部门中的所有用户",
"summary": "获取部门中的所有用户",
"operationId": "GetUserInDepartment",
"$ref": "#/definitions/base_info.GetUserInDepartmentReq"
"$ref": "#/definitions/base_info.GetUserInDepartmentResp"
"$ref": "#/definitions/server_api_params.UserInDepartment"
"/organization/update_department": {
"description": "更新部门信息",
"summary": "更新部门信息",
"operationId": "UpdateDepartment",
"$ref": "#/definitions/base_info.UpdateDepartmentReq"
"$ref": "#/definitions/base_info.UpdateDepartmentResp"
"/organization/update_organization_user": {
"description": "更新组织架构中的用户",
"summary": "更新组织架构中的用户",
"operationId": "UpdateOrganizationUser",
"$ref": "#/definitions/base_info.UpdateOrganizationUserReq"
"$ref": "#/definitions/base_info.UpdateOrganizationUserResp"
"/organization/update_user_in_department": {
"description": "更新部门中某个用户",
"summary": "更新部门中某个用户",
"operationId": "UpdateUserInDepartment",
"$ref": "#/definitions/base_info.UpdateUserInDepartmentReq"
"$ref": "#/definitions/base_info.UpdateUserInDepartmentResp"
"/third/minio_upload": {
"description": "minio上传文件(web api), 请注意本api请求为form并非json",
"第三方服务相关"
"summary": "minio上传文件(web api)",
"operationId": "MinioUploadFile",
"type": "file",
"description": "要上传的文件文件",
"name": "file",
"in": "formData",
"type": "integer",
"description": "文件类型",
"name": "fileType",
"description": "操作唯一ID",
"name": "operationID",
"$ref": "#/definitions/base_info.MinioUploadFileResp"
"/user/account_check": {
"description": "传入UserIDList检查列表账户注册状态,并且返回结果",
"用户相关"
"summary": "检查列表账户注册状态,并且返回结果",
"operationId": "AccountCheck",
"description": "请求体",
"$ref": "#/definitions/base_info.AccountCheckReq"
"$ref": "#/definitions/base_info.AccountCheckResp"
"/user/get_all_users_uid": {
"description": "获取所有用户uid列表",
"summary": "获取所有用户uid列表",
"operationId": "GetAllUsersUid",
"$ref": "#/definitions/base_info.GetAllUsersUidReq"
"$ref": "#/definitions/base_info.GetAllUsersUidResp"
"/user/get_self_user_info": {
"description": "传入ID获取自己的信息",
"summary": "获取自己的信息",
"operationId": "GetSelfUserInfo",
"$ref": "#/definitions/base_info.GetSelfUserInfoReq"
"$ref": "#/definitions/base_info.GetSelfUserInfoResp"
"$ref": "#/definitions/server_api_params.UserInfo"
"/user/get_users_info": {
"description": "根据用户列表批量获取用户信息",
"summary": "获取用户信息",
"operationId": "GetUsersInfo",
"$ref": "#/definitions/base_info.GetUsersInfoReq"
"$ref": "#/definitions/base_info.GetUsersInfoResp"
"/user/get_users_online_status": {
"description": "获取用户在线状态",
"summary": "获取用户在线状态",
"operationId": "GetUsersOnlineStatus",
"$ref": "#/definitions/base_info.GetUsersOnlineStatusReq"
"$ref": "#/definitions/base_info.GetUsersOnlineStatusResp"
"/user/set_global_msg_recv_opt": {
"description": "设置全局免打扰",
"summary": "设置全局免打扰",
"operationId": "SetGlobalRecvMessageOpt",
"description": "globalRecvMsgOpt为全局免打扰设置0为关闭 1为开启",
"$ref": "#/definitions/base_info.SetGlobalRecvMessageOptReq"
"$ref": "#/definitions/base_info.SetGlobalRecvMessageOptResp"
"/user/update_user_info": {
"description": "修改用户信息 userID faceURL等",
"summary": "修改用户信息",
"operationId": "UpdateUserInfo",
"$ref": "#/definitions/base_info.UpdateSelfUserInfoReq"
"$ref": "#/definitions/base_info.UpdateUserInfoResp"
"definitions": {
"Open_IM_internal_api_manage.FileElem": {
"fileName": {
"type": "string"
"filePath": {
"fileSize": {
"type": "integer"
"sourceURL": {
"uuid": {
"Open_IM_internal_api_manage.OANotificationElem": {
"required": [
"notificationFaceURL",
"notificationName",
"notificationType",
"text"
"ex": {
"fileElem": {
"$ref": "#/definitions/Open_IM_internal_api_manage.FileElem"
"mixType": {
"notificationFaceURL": {
"notificationName": {
"notificationType": {
"pictureElem": {
"$ref": "#/definitions/Open_IM_internal_api_manage.PictureElem"
"soundElem": {
"$ref": "#/definitions/Open_IM_internal_api_manage.SoundElem"
"text": {
"url": {
"videoElem": {
"$ref": "#/definitions/Open_IM_internal_api_manage.VideoElem"
"Open_IM_internal_api_manage.PictureBaseInfo": {
"height": {
"size": {
"type": {
"width": {
"Open_IM_internal_api_manage.PictureElem": {
"bigPicture": {
"$ref": "#/definitions/Open_IM_internal_api_manage.PictureBaseInfo"
"snapshotPicture": {
"sourcePath": {
"sourcePicture": {
"Open_IM_internal_api_manage.RevokeElem": {
"revokeMsgClientID"
"revokeMsgClientID": {
"Open_IM_internal_api_manage.SoundElem": {
"dataSize": {
"duration": {
"soundPath": {
"Open_IM_internal_api_manage.TextElem": {
"Open_IM_internal_api_manage.VideoElem": {
"snapshotHeight": {
"snapshotPath": {
"snapshotSize": {
"snapshotURL": {
"snapshotUUID": {
"snapshotWidth": {
"videoPath": {
"videoSize": {
"videoType": {
"videoURL": {
"videoUUID": {
"base_info.AccountCheckReq": {
"checkUserIDList",
"operationID"
"checkUserIDList": {
"maxItems": 100,
"operationID": {
"base_info.AccountCheckResp": {
"$ref": "#/definitions/user.AccountCheckResp_SingleUserStatus"
"errCode": {
"errMsg": {
"base_info.AddBlacklistReq": {
"fromUserID",
"operationID",
"toUserID"
"fromUserID": {
"toUserID": {
"base_info.AddBlacklistResp": {
"base_info.AddFriendReq": {
"reqMsg": {
"base_info.AddFriendResp": {
"base_info.AddFriendResponseReq": {
"flag",
"flag": {
"enum": [
-1,
0,
1
"handleMsg": {
"base_info.AddFriendResponseResp": {
"base_info.ApplicationGroupResponseReq": {
"groupID",
"handleResult",
"description": "application from FromUserID",
"groupID": {
"handleResult": {
"handledMsg": {
"base_info.ApplicationGroupResponseResp": {
"base_info.CancelMuteGroupMemberReq": {
"userID"
"userID": {
"base_info.CancelMuteGroupMemberResp": {
"base_info.CancelMuteGroupReq": {
"base_info.CancelMuteGroupResp": {
"base_info.CleanUpMsgReq": {
"base_info.CleanUpMsgResp": {
"base_info.Comment": {
"contentID": {
"createTime": {
"replyUserID": {
"replyUserName": {
"userName": {
"base_info.CommentOneWorkMomentReq": {
"content",
"workMomentID"
"workMomentID": {
"base_info.CommentOneWorkMomentResp": {
"type": "object"
"base_info.Conversation": {
"conversationID",
"conversationType",
"ownerUserID"
"attachedInfo": {
"conversationID": {
"conversationType": {
"draftTextTime": {
"groupAtType": {
"isNotInGroup": {
"type": "boolean"
"isPinned": {
"isPrivateChat": {
"ownerUserID": {
"recvMsgOpt": {
1,
2
"unreadCount": {
"base_info.CreateDepartmentMemberReq": {
"departmentID": {
"leader": {
"order": {
"position": {
"status": {
"base_info.CreateDepartmentMemberResp": {
"base_info.CreateDepartmentReq": {
"departmentType": {
"faceURL": {
"memberNum": {
"name": {
"parentID": {
"subDepartmentNum": {
"base_info.CreateDepartmentResp": {
"additionalProperties": true
"base_info.CreateGroupReq": {
"groupName": {
"groupType": {
"introduction": {
"memberList": {
"$ref": "#/definitions/base_info.GroupAddMemberInfo"
"notification": {
"base_info.CreateGroupResp": {
"base_info.CreateOneWorkMomentReq": {
"workMoment": {
"$ref": "#/definitions/office.WorkMoment"
"base_info.CreateOneWorkMomentResp": {
"base_info.CreateOrganizationUserReq": {
"birth": {
"email": {
"englishName": {
"gender": {
"mobile": {
"nickname": {
"telephone": {
"base_info.CreateOrganizationUserResp": {
"base_info.CreateTagReq": {
"tagName",
"userIDList"
"tagName": {
"description": "tag名称",
"userIDList": {
"description": "用户ID列表",
"base_info.CreateTagResp": {
"base_info.DelMsgReq": {
"seqList",
"seqList": {
"base_info.DelMsgResp": {
"base_info.DeleteCommentReq": {
"contentID",
"base_info.DeleteCommentResp": {
"base_info.DeleteDepartmentReq": {
"departmentID",
"base_info.DeleteDepartmentResp": {
"base_info.DeleteFriendReq": {
"base_info.DeleteFriendResp": {
"base_info.DeleteOneWorkMomentReq": {
"base_info.DeleteOneWorkMomentResp": {
"base_info.DeleteOrganizationUserReq": {
"base_info.DeleteOrganizationUserResp": {
"base_info.DeleteTagReq": {
"tagID"
"tagID": {
"base_info.DeleteTagResp": {
"base_info.DeleteUserInDepartmentReq": {
"base_info.DeleteUserInDepartmentResp": {
"base_info.DismissGroupReq": {
"base_info.DismissGroupResp": {
"base_info.ExpireTime": {
"expireTimeSeconds": {
"base_info.ForceLogoutReq": {
"platform"
"maxLength": 64,
"minLength": 1
"platform": {
"maximum": 8,
"minimum": 1
"base_info.ForceLogoutResp": {
"base_info.GetAllConversationsReq": {
"base_info.GetAllConversationsResp": {
"$ref": "#/definitions/base_info.Conversation"
"base_info.GetAllUsersUidReq": {
"base_info.GetAllUsersUidResp": {
"base_info.GetBlackListReq": {
"base_info.GetBlackListResp": {
"base_info.GetConversationReq": {
"base_info.GetConversationResp": {
"base_info.GetConversationsReq": {
"conversationIDs",
"conversationIDs": {
"base_info.GetConversationsResp": {
"base_info.GetDepartmentMemberReq": {
"base_info.GetDepartmentMemberResp": {
"base_info.GetFriendApplyListReq": {
"base_info.GetFriendApplyListResp": {
"base_info.GetFriendListReq": {
"base_info.GetFriendListResp": {
"base_info.GetGroupAllMemberReq": {
"base_info.GetGroupAllMemberResp": {
"base_info.GetGroupApplicationListReq": {
"description": "作为管理员或群主收到的 进群申请",
"base_info.GetGroupApplicationListResp": {
"base_info.GetGroupInfoReq": {
"groupIDList",
"groupIDList": {
"base_info.GetGroupInfoResp": {
"base_info.GetGroupMembersInfoReq": {
"memberList",
"base_info.GetGroupMembersInfoResp": {
"base_info.GetJoinedGroupListReq": {
"base_info.GetJoinedGroupListResp": {
"base_info.GetSelfApplyListReq": {
"base_info.GetSelfApplyListResp": {
"base_info.GetSelfUserInfoReq": {
"base_info.GetSelfUserInfoResp": {
"base_info.GetSubDepartmentReq": {
"base_info.GetSubDepartmentResp": {
"base_info.GetTagSendLogsReq": {
"pageNumber",
"showNumber"
"pageNumber": {
"showNumber": {
"base_info.GetTagSendLogsResp": {
"currentPage": {
"logs": {
"$ref": "#/definitions/office.TagSendLog"
"base_info.GetUserFriendWorkMomentsReq": {
"base_info.GetUserFriendWorkMomentsResp": {
"workMoments": {
"$ref": "#/definitions/base_info.WorkMoment"
"base_info.GetUserInDepartmentReq": {
"base_info.GetUserInDepartmentResp": {
"base_info.GetUserReqGroupApplicationListReq": {
"base_info.GetUserTagByIDReq": {
"base_info.GetUserTagByIDResp": {
"tag": {
"$ref": "#/definitions/office.Tag"
"base_info.GetUserTagsReq": {
"base_info.GetUserTagsResp": {
"tags": {
"base_info.GetUserWorkMomentsReq": {
"base_info.GetUserWorkMomentsResp": {
"base_info.GetUsersInfoReq": {
"base_info.GetUsersInfoResp": {
"base_info.GetUsersOnlineStatusReq": {
"maxItems": 200,
"base_info.GetUsersOnlineStatusResp": {
"$ref": "#/definitions/pbRelay.GetUsersOnlineStatusResp_SuccessResult"
"base_info.GetWorkMomentByIDReq": {
"base_info.GetWorkMomentByIDResp": {
"base_info.GroupAddMemberInfo": {
"roleLevel",
"roleLevel": {
"base_info.ImportFriendReq": {
"friendUserIDList",
"friendUserIDList": {
"base_info.ImportFriendResp": {
"$ref": "#/definitions/base_info.UserIDResult"
"base_info.InviteUserToGroupReq": {
"invitedUserIDList",
"invitedUserIDList": {
"reason": {
"base_info.InviteUserToGroupResp": {
"base_info.IsFriendReq": {
"base_info.IsFriendResp": {
"$ref": "#/definitions/base_info.Response"
"base_info.JoinGroupReq": {
"reqMessage": {
"base_info.JoinGroupResp": {
"base_info.KickGroupMemberReq": {
"kickedUserIDList",
"kickedUserIDList": {
"base_info.KickGroupMemberResp": {
"base_info.LikeOneWorkMomentReq": {
"base_info.LikeOneWorkMomentResp": {
"base_info.ManagementBatchSendMsgReq": {
"contentType",
"sendID",
"sessionType"
"contentType": {
"isOnlineOnly": {
"offlinePushInfo": {
"$ref": "#/definitions/server_api_params.OfflinePushInfo"
"recvIDList": {
"sendID": {
"senderFaceURL": {
"senderNickname": {
"senderPlatformID": {
"sessionType": {
"base_info.ManagementSendMsgReq": {
"recvID": {
"base_info.ManagementSendMsgResp": {
"$ref": "#/definitions/server_api_params.UserSendMsgResp"
"base_info.MinioUploadFileResp": {
"URL": {
"newName": {
"snapshotName": {
"base_info.MuteGroupMemberReq": {
"mutedSeconds",
"mutedSeconds": {
"base_info.MuteGroupReq": {
"base_info.MuteGroupResp": {
"base_info.ParseTokenReq": {
"base_info.ParseTokenResp": {
"base_info.QuitGroupReq": {
"base_info.QuitGroupResp": {
"base_info.RemoveBlackListReq": {
"base_info.RemoveBlackListResp": {
"base_info.Response": {
"isFriend": {
"base_info.SendMsg2TagReq": {
"senderPlatformID"
"groupList": {
"tagList": {
"userList": {
"base_info.SendMsg2TagResp": {
"base_info.SetFriendRemarkReq": {
"remark",
"remark": {
"base_info.SetFriendRemarkResp": {
"base_info.SetGlobalRecvMessageOptReq": {
"globalRecvMsgOpt": {
"base_info.SetGlobalRecvMessageOptResp": {
"base_info.SetGroupInfoReq": {
"needVerification": {
"base_info.SetGroupInfoResp": {
"base_info.SetGroupMemberInfoReq": {
"maximum": 3,
"userGroupFaceUrl": {
"base_info.SetGroupMemberInfoResp": {
"base_info.SetTagReq": {
"increaseUserIDList": {
"reduceUserIDList": {
"base_info.SetTagResp": {
"base_info.Swagger400Resp": {
"example": 400
"example": "err msg"
"base_info.Swagger500Resp": {
"example": 500
"base_info.TransferGroupOwnerReq": {
"newOwnerUserID",
"oldOwnerUserID",
"newOwnerUserID": {
"oldOwnerUserID": {
"base_info.TransferGroupOwnerResp": {
"base_info.UpdateDepartmentReq": {
"base_info.UpdateDepartmentResp": {
"base_info.UpdateOrganizationUserReq": {
"base_info.UpdateOrganizationUserResp": {
"base_info.UpdateSelfUserInfoReq": {
"maxLength": 64
"maxLength": 1024
"phoneNumber": {
"maxLength": 32
"base_info.UpdateUserInDepartmentReq": {
"base_info.UpdateUserInDepartmentResp": {
"base_info.UpdateUserInfoResp": {
"base_info.UserIDResult": {
"result": {
"base_info.UserRegisterReq": {
"platform",
"secret",
"maximum": 7,
"secret": {
"base_info.UserRegisterResp": {
"$ref": "#/definitions/base_info.UserTokenInfo"
"base_info.UserTokenInfo": {
"expiredTime": {
"token": {
"base_info.UserTokenReq": {
"base_info.UserTokenResp": {
"base_info.WorkMoment": {
"atUsers": {
"$ref": "#/definitions/base_info.WorkMomentUser"
"comments": {
"$ref": "#/definitions/base_info.Comment"
"likeUsers": {
"permission": {
"permissionUsers": {
"base_info.WorkMomentUser": {
"internal_api_manage.FileElem": {
"internal_api_manage.OANotificationElem": {
"$ref": "#/definitions/internal_api_manage.FileElem"
"$ref": "#/definitions/internal_api_manage.PictureElem"
"$ref": "#/definitions/internal_api_manage.SoundElem"
"$ref": "#/definitions/internal_api_manage.VideoElem"
"internal_api_manage.PictureBaseInfo": {
"internal_api_manage.PictureElem": {
"$ref": "#/definitions/internal_api_manage.PictureBaseInfo"
"internal_api_manage.RevokeElem": {
"internal_api_manage.SoundElem": {
"internal_api_manage.TextElem": {
"internal_api_manage.VideoElem": {
"office.Comment": {
"office.PermissionGroup": {
"office.Tag": {
"$ref": "#/definitions/office.TagUser"
"office.TagSendLog": {
"sendTime": {
"office.TagUser": {
"office.WorkMoment": {
"atUserList": {
"$ref": "#/definitions/office.WorkMomentUser"
"$ref": "#/definitions/office.Comment"
"likeUserList": {
"permissionGroupList": {
"$ref": "#/definitions/office.PermissionGroup"
"permissionUserList": {
"office.WorkMomentUser": {
"pbRelay.GetUsersOnlineStatusResp_SuccessDetail": {
"pbRelay.GetUsersOnlineStatusResp_SuccessResult": {
"detailPlatformStatus": {
"$ref": "#/definitions/pbRelay.GetUsersOnlineStatusResp_SuccessDetail"
"server_api_params.Department": {
"server_api_params.DepartmentMember": {
"server_api_params.FriendInfo": {
"addSource": {
"friendUser": {
"operatorUserID": {
"server_api_params.FriendRequest": {
"fromFaceURL": {
"fromGender": {
"fromNickname": {
"handleTime": {
"handlerUserID": {
"toFaceURL": {
"toGender": {
"toNickname": {
"server_api_params.GroupInfo": {
"creatorUserID": {
"memberCount": {
"server_api_params.GroupMemberFullInfo": {
"appMangerLevel": {
"joinSource": {
"joinTime": {
"muteEndTime": {
"server_api_params.GroupRequest": {
"groupInfo": {
"handleUserID": {
"reqTime": {
"userInfo": {
"server_api_params.OfflinePushInfo": {
"desc": {
"iOSBadgeCount": {
"iOSPushSound": {
"title": {
"server_api_params.OrganizationUser": {
"server_api_params.PublicUserInfo": {
"server_api_params.UserDepartmentMember": {
"departmentMember": {
"$ref": "#/definitions/server_api_params.DepartmentMember"
"organizationUser": {
"$ref": "#/definitions/server_api_params.OrganizationUser"
"server_api_params.UserInDepartment": {
"departmentMemberList": {
"server_api_params.UserInfo": {
"server_api_params.UserSendMsgResp": {
"clientMsgID": {
"serverMsgID": {
"user.AccountCheckResp_SingleUserStatus": {
"accountStatus": {