You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Open-IM-Server/cmd/open_im_api/docs/swagger.yaml

5625 lines
141 KiB

This file contains ambiguous Unicode characters!

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.

basePath: /
definitions:
Open_IM_internal_api_manage.FileElem:
properties:
fileName:
type: string
filePath:
type: string
fileSize:
type: integer
sourceURL:
type: string
uuid:
type: string
type: object
Open_IM_internal_api_manage.OANotificationElem:
properties:
ex:
type: string
fileElem:
$ref: '#/definitions/Open_IM_internal_api_manage.FileElem'
mixType:
type: integer
notificationFaceURL:
type: string
notificationName:
type: string
notificationType:
type: integer
pictureElem:
$ref: '#/definitions/Open_IM_internal_api_manage.PictureElem'
soundElem:
$ref: '#/definitions/Open_IM_internal_api_manage.SoundElem'
text:
type: string
url:
type: string
videoElem:
$ref: '#/definitions/Open_IM_internal_api_manage.VideoElem'
required:
- notificationName
- notificationType
- text
type: object
Open_IM_internal_api_manage.PictureBaseInfo:
properties:
height:
type: integer
size:
type: integer
type:
type: string
url:
type: string
uuid:
type: string
width:
type: integer
type: object
Open_IM_internal_api_manage.PictureElem:
properties:
bigPicture:
$ref: '#/definitions/Open_IM_internal_api_manage.PictureBaseInfo'
snapshotPicture:
$ref: '#/definitions/Open_IM_internal_api_manage.PictureBaseInfo'
sourcePath:
type: string
sourcePicture:
$ref: '#/definitions/Open_IM_internal_api_manage.PictureBaseInfo'
type: object
Open_IM_internal_api_manage.RevokeElem:
properties:
revokeMsgClientID:
type: string
required:
- revokeMsgClientID
type: object
Open_IM_internal_api_manage.SoundElem:
properties:
dataSize:
type: integer
duration:
type: integer
soundPath:
type: string
sourceURL:
type: string
uuid:
type: string
type: object
Open_IM_internal_api_manage.TextElem:
properties:
text:
type: string
required:
- text
type: object
Open_IM_internal_api_manage.VideoElem:
properties:
duration:
type: integer
snapshotHeight:
type: integer
snapshotPath:
type: string
snapshotSize:
type: integer
snapshotURL:
type: string
snapshotUUID:
type: string
snapshotWidth:
type: integer
videoPath:
type: string
videoSize:
type: integer
videoType:
type: string
videoURL:
type: string
videoUUID:
type: string
type: object
api_struct.AccountCheckReq:
properties:
checkUserIDList:
items:
type: string
maxItems: 100
type: array
operationID:
type: string
required:
- checkUserIDList
- operationID
type: object
api_struct.AccountCheckResp:
properties:
data:
items:
$ref: '#/definitions/user.AccountCheckResp_SingleUserStatus'
type: array
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.AddBlacklistReq:
properties:
fromUserID:
type: string
operationID:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
api_struct.AddBlacklistResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.AddFriendReq:
properties:
fromUserID:
type: string
operationID:
type: string
reqMsg:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
api_struct.AddFriendResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.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
api_struct.AddFriendResponseResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.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
api_struct.ApplicationGroupResponseResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.CancelMuteGroupMemberReq:
properties:
groupID:
type: string
operationID:
type: string
userID:
type: string
required:
- groupID
- operationID
- userID
type: object
api_struct.CancelMuteGroupMemberResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.CancelMuteGroupReq:
properties:
groupID:
type: string
operationID:
type: string
required:
- groupID
- operationID
type: object
api_struct.CancelMuteGroupResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.CleanUpMsgReq:
properties:
operationID:
type: string
userID:
type: string
required:
- operationID
- userID
type: object
api_struct.CleanUpMsgResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.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
api_struct.CommentOneWorkMomentReq:
properties:
content:
type: string
operationID:
type: string
replyUserID:
type: string
workMomentID:
type: string
required:
- content
- operationID
- workMomentID
type: object
api_struct.CommentOneWorkMomentResp:
properties:
data:
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.Conversation:
properties:
attachedInfo:
type: string
conversationID:
type: string
conversationType:
type: integer
draftTextTime:
type: integer
ex:
type: string
groupAtType:
type: integer
groupID:
type: string
isNotInGroup:
type: boolean
isPinned:
type: boolean
isPrivateChat:
type: boolean
ownerUserID:
type: string
recvMsgOpt:
enum:
- 0
- 1
- 2
type: integer
unreadCount:
type: integer
userID:
type: string
required:
- conversationID
- conversationType
- ownerUserID
type: object
api_struct.CreateDepartmentMemberReq:
properties:
departmentID:
type: string
ex:
type: string
leader:
type: integer
operationID:
type: string
order:
type: integer
position:
type: string
status:
type: integer
userID:
type: string
required:
- operationID
type: object
api_struct.CreateDepartmentMemberResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.CreateDepartmentReq:
properties:
createTime:
type: integer
departmentID:
type: string
departmentType:
type: integer
ex:
type: string
faceURL:
type: string
memberNum:
type: integer
name:
type: string
operationID:
type: string
order:
type: integer
parentID:
type: string
subDepartmentNum:
type: integer
required:
- operationID
type: object
api_struct.CreateDepartmentResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.CreateGroupReq:
properties:
ex:
type: string
faceURL:
type: string
groupID:
type: string
groupName:
type: string
groupType:
type: integer
introduction:
type: string
memberList:
items:
$ref: '#/definitions/api_struct.GroupAddMemberInfo'
type: array
notification:
type: string
operationID:
type: string
ownerUserID:
type: string
required:
- operationID
type: object
api_struct.CreateGroupResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.CreateOneWorkMomentReq:
properties:
operationID:
type: string
workMoment:
$ref: '#/definitions/office.WorkMoment'
type: object
api_struct.CreateOneWorkMomentResp:
properties:
data:
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.CreateOrganizationUserReq:
properties:
birth:
type: integer
createTime:
type: integer
email:
type: string
englishName:
type: string
ex:
type: string
faceURL:
type: string
gender:
type: integer
mobile:
type: string
nickname:
type: string
operationID:
type: string
telephone:
type: string
userID:
type: string
required:
- operationID
type: object
api_struct.CreateOrganizationUserResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.CreateTagReq:
properties:
operationID:
type: string
tagName:
description: tag名称
type: string
userIDList:
description: 用户ID列表
items:
type: string
type: array
required:
- operationID
- tagName
- userIDList
type: object
api_struct.CreateTagResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.DelMsgReq:
properties:
operationID:
type: string
seqList:
items:
type: integer
type: array
userID:
type: string
required:
- operationID
- seqList
- userID
type: object
api_struct.DelMsgResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.DeleteCommentReq:
properties:
contentID:
type: string
operationID:
type: string
workMomentID:
type: string
required:
- contentID
- operationID
- workMomentID
type: object
api_struct.DeleteCommentResp:
properties:
data:
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.DeleteDepartmentReq:
properties:
departmentID:
type: string
operationID:
type: string
required:
- departmentID
- operationID
type: object
api_struct.DeleteDepartmentResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.DeleteFriendReq:
properties:
fromUserID:
type: string
operationID:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
api_struct.DeleteFriendResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.DeleteOneWorkMomentReq:
properties:
operationID:
type: string
workMomentID:
type: string
required:
- operationID
- workMomentID
type: object
api_struct.DeleteOneWorkMomentResp:
properties:
data:
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.DeleteOrganizationUserReq:
properties:
operationID:
type: string
userID:
type: string
required:
- operationID
- userID
type: object
api_struct.DeleteOrganizationUserResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.DeleteTagReq:
properties:
operationID:
type: string
tagID:
type: string
required:
- operationID
- tagID
type: object
api_struct.DeleteTagResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.DeleteUserInDepartmentReq:
properties:
departmentID:
type: string
operationID:
type: string
userID:
type: string
required:
- departmentID
- operationID
- userID
type: object
api_struct.DeleteUserInDepartmentResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.DismissGroupReq:
properties:
groupID:
type: string
operationID:
type: string
required:
- groupID
- operationID
type: object
api_struct.DismissGroupResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.ExpireTime:
properties:
expireTimeSeconds:
type: integer
type: object
api_struct.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
api_struct.ForceLogoutResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetAllConversationsReq:
properties:
operationID:
type: string
ownerUserID:
type: string
required:
- operationID
- ownerUserID
type: object
api_struct.GetAllConversationsResp:
properties:
data:
items:
$ref: '#/definitions/api_struct.Conversation'
type: array
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetAllUsersUidReq:
properties:
operationID:
type: string
required:
- operationID
type: object
api_struct.GetAllUsersUidResp:
properties:
data:
items:
type: string
type: array
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetBlackListReq:
properties:
fromUserID:
type: string
operationID:
type: string
required:
- fromUserID
- operationID
type: object
api_struct.GetBlackListResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetConversationReq:
properties:
conversationID:
type: string
operationID:
type: string
ownerUserID:
type: string
required:
- conversationID
- operationID
- ownerUserID
type: object
api_struct.GetConversationResp:
properties:
data:
$ref: '#/definitions/api_struct.Conversation'
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetConversationsReq:
properties:
conversationIDs:
items:
type: string
type: array
operationID:
type: string
ownerUserID:
type: string
required:
- conversationIDs
- operationID
- ownerUserID
type: object
api_struct.GetConversationsResp:
properties:
data:
items:
$ref: '#/definitions/api_struct.Conversation'
type: array
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetDepartmentMemberReq:
properties:
departmentID:
type: string
operationID:
type: string
required:
- departmentID
- operationID
type: object
api_struct.GetDepartmentMemberResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetFriendApplyListReq:
properties:
fromUserID:
type: string
operationID:
type: string
required:
- fromUserID
- operationID
type: object
api_struct.GetFriendApplyListResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetFriendListReq:
properties:
fromUserID:
type: string
operationID:
type: string
required:
- fromUserID
- operationID
type: object
api_struct.GetFriendListResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetGroupAllMemberReq:
properties:
count:
type: integer
groupID:
type: string
offset:
type: integer
operationID:
type: string
required:
- count
- groupID
- offset
- operationID
type: object
api_struct.GetGroupAllMemberResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetGroupApplicationListReq:
properties:
fromUserID:
description: 作为管理员或群主收到的 进群申请
type: string
operationID:
type: string
required:
- fromUserID
- operationID
type: object
api_struct.GetGroupApplicationListResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetGroupInfoReq:
properties:
groupIDList:
items:
type: string
type: array
operationID:
type: string
required:
- groupIDList
- operationID
type: object
api_struct.GetGroupInfoResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetGroupMembersInfoReq:
properties:
groupID:
type: string
memberList:
items:
type: string
type: array
operationID:
type: string
required:
- groupID
- memberList
- operationID
type: object
api_struct.GetGroupMembersInfoResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetJoinedGroupListReq:
properties:
fromUserID:
type: string
operationID:
type: string
required:
- fromUserID
- operationID
type: object
api_struct.GetJoinedGroupListResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetSelfApplyListReq:
properties:
fromUserID:
type: string
operationID:
type: string
required:
- fromUserID
- operationID
type: object
api_struct.GetSelfApplyListResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetSelfUserInfoReq:
properties:
operationID:
type: string
userID:
type: string
required:
- operationID
- userID
type: object
api_struct.GetSelfUserInfoResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetSubDepartmentReq:
properties:
departmentID:
type: string
operationID:
type: string
required:
- departmentID
- operationID
type: object
api_struct.GetSubDepartmentResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetTagSendLogsReq:
properties:
operationID:
type: string
pageNumber:
type: integer
showNumber:
type: integer
required:
- operationID
- pageNumber
- showNumber
type: object
api_struct.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
api_struct.GetUserFriendWorkMomentsReq:
properties:
operationID:
type: string
pageNumber:
type: integer
showNumber:
type: integer
required:
- operationID
- pageNumber
- showNumber
type: object
api_struct.GetUserFriendWorkMomentsResp:
properties:
data:
properties:
currentPage:
type: integer
showNumber:
type: integer
workMoments:
items:
$ref: '#/definitions/api_struct.WorkMoment'
type: array
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetUserInDepartmentReq:
properties:
operationID:
type: string
userID:
type: string
required:
- operationID
- userID
type: object
api_struct.GetUserInDepartmentResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetUserReqGroupApplicationListReq:
properties:
operationID:
type: string
userID:
type: string
required:
- operationID
- userID
type: object
api_struct.GetUserTagByIDReq:
properties:
operationID:
type: string
tagID:
type: string
required:
- operationID
- tagID
type: object
api_struct.GetUserTagByIDResp:
properties:
data:
properties:
tag:
$ref: '#/definitions/office.Tag'
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetUserTagsReq:
properties:
operationID:
type: string
required:
- operationID
type: object
api_struct.GetUserTagsResp:
properties:
data:
properties:
tags:
items:
$ref: '#/definitions/office.Tag'
type: array
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetUserWorkMomentsReq:
properties:
operationID:
type: string
pageNumber:
type: integer
showNumber:
type: integer
userID:
type: string
required:
- operationID
- pageNumber
- showNumber
type: object
api_struct.GetUserWorkMomentsResp:
properties:
data:
properties:
currentPage:
type: integer
showNumber:
type: integer
workMoments:
items:
$ref: '#/definitions/api_struct.WorkMoment'
type: array
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetUsersInfoReq:
properties:
operationID:
type: string
userIDList:
items:
type: string
type: array
required:
- operationID
- userIDList
type: object
api_struct.GetUsersInfoResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetUsersOnlineStatusReq:
properties:
operationID:
type: string
userIDList:
items:
type: string
maxItems: 200
type: array
required:
- operationID
- userIDList
type: object
api_struct.GetUsersOnlineStatusResp:
properties:
data:
items:
$ref: '#/definitions/pbRelay.GetUsersOnlineStatusResp_SuccessResult'
type: array
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GetWorkMomentByIDReq:
properties:
operationID:
type: string
workMomentID:
type: string
required:
- operationID
- workMomentID
type: object
api_struct.GetWorkMomentByIDResp:
properties:
data:
properties:
workMoment:
$ref: '#/definitions/api_struct.WorkMoment'
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.GroupAddMemberInfo:
properties:
roleLevel:
enum:
- 1
- 3
type: integer
userID:
type: string
required:
- roleLevel
- userID
type: object
api_struct.ImportFriendReq:
properties:
friendUserIDList:
items:
type: string
type: array
fromUserID:
type: string
operationID:
type: string
required:
- friendUserIDList
- fromUserID
- operationID
type: object
api_struct.ImportFriendResp:
properties:
data:
items:
$ref: '#/definitions/api_struct.UserIDResult'
type: array
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.InviteUserToGroupReq:
properties:
groupID:
type: string
invitedUserIDList:
items:
type: string
type: array
operationID:
type: string
reason:
type: string
required:
- groupID
- invitedUserIDList
- operationID
type: object
api_struct.InviteUserToGroupResp:
properties:
data:
items:
$ref: '#/definitions/api_struct.UserIDResult'
type: array
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.IsFriendReq:
properties:
fromUserID:
type: string
operationID:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
api_struct.IsFriendResp:
properties:
data:
$ref: '#/definitions/api_struct.Response'
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.JoinGroupReq:
properties:
groupID:
type: string
inviterUserID:
type: string
joinSource:
type: integer
operationID:
type: string
reqMessage:
type: string
required:
- groupID
- operationID
type: object
api_struct.JoinGroupResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.KickGroupMemberReq:
properties:
groupID:
type: string
kickedUserIDList:
items:
type: string
type: array
operationID:
type: string
reason:
type: string
required:
- groupID
- kickedUserIDList
- operationID
type: object
api_struct.KickGroupMemberResp:
properties:
data:
items:
$ref: '#/definitions/api_struct.UserIDResult'
type: array
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.LikeOneWorkMomentReq:
properties:
operationID:
type: string
workMomentID:
type: string
required:
- operationID
- workMomentID
type: object
api_struct.LikeOneWorkMomentResp:
properties:
data:
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.ManagementBatchSendMsgReq:
properties:
businessOperationID:
type: string
contentType:
type: integer
groupID:
type: string
isOnlineOnly:
type: boolean
notOfflinePush:
type: boolean
offlinePushInfo:
$ref: '#/definitions/server_api_params.OfflinePushInfo'
operationID:
type: string
recvIDList:
items:
type: string
type: array
sendID:
type: string
senderFaceURL:
type: string
senderNickname:
type: string
senderPlatformID:
type: integer
sessionType:
type: integer
required:
- contentType
- operationID
- sendID
- sessionType
type: object
api_struct.ManagementSendMsgReq:
properties:
businessOperationID:
type: string
contentType:
type: integer
groupID:
type: string
isOnlineOnly:
type: boolean
notOfflinePush:
type: boolean
offlinePushInfo:
$ref: '#/definitions/server_api_params.OfflinePushInfo'
operationID:
type: string
recvID:
type: string
sendID:
type: string
senderFaceURL:
type: string
senderNickname:
type: string
senderPlatformID:
type: integer
sessionType:
type: integer
required:
- contentType
- operationID
- sendID
- sessionType
type: object
api_struct.ManagementSendMsgResp:
properties:
data:
$ref: '#/definitions/server_api_params.UserSendMsgResp'
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.MinioUploadFileResp:
properties:
data:
properties:
URL:
type: string
newName:
type: string
snapshotName:
type: string
snapshotURL:
type: string
type: object
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.MuteGroupMemberReq:
properties:
groupID:
type: string
mutedSeconds:
type: integer
operationID:
type: string
userID:
type: string
required:
- groupID
- mutedSeconds
- operationID
- userID
type: object
api_struct.MuteGroupReq:
properties:
groupID:
type: string
operationID:
type: string
required:
- groupID
- operationID
type: object
api_struct.MuteGroupResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.ParseTokenReq:
properties:
operationID:
type: string
required:
- operationID
type: object
api_struct.ParseTokenResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.QuitGroupReq:
properties:
groupID:
type: string
operationID:
type: string
required:
- groupID
- operationID
type: object
api_struct.QuitGroupResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.RemoveBlackListReq:
properties:
fromUserID:
type: string
operationID:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
api_struct.RemoveBlackListResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.Response:
properties:
isFriend:
type: boolean
type: object
api_struct.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
api_struct.SendMsg2TagResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.SetFriendRemarkReq:
properties:
fromUserID:
type: string
operationID:
type: string
remark:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
api_struct.SetFriendRemarkResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.SetGlobalRecvMessageOptReq:
properties:
globalRecvMsgOpt:
enum:
- 0
- 1
- 2
type: integer
operationID:
type: string
required:
- operationID
type: object
api_struct.SetGlobalRecvMessageOptResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.SetGroupInfoReq:
properties:
applyMemberFriend:
type: integer
ex:
type: string
faceURL:
type: string
groupID:
type: string
groupName:
type: string
introduction:
type: string
lookMemberInfo:
type: integer
needVerification:
type: integer
notification:
type: string
operationID:
type: string
required:
- groupID
- operationID
type: object
api_struct.SetGroupInfoResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.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
api_struct.SetGroupMemberInfoResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.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
api_struct.SetTagResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.Swagger400Resp:
properties:
errCode:
example: 400
type: integer
errMsg:
example: err msg
type: string
type: object
api_struct.Swagger500Resp:
properties:
errCode:
example: 500
type: integer
errMsg:
example: err msg
type: string
type: object
api_struct.TransferGroupOwnerReq:
properties:
groupID:
type: string
newOwnerUserID:
type: string
oldOwnerUserID:
type: string
operationID:
type: string
required:
- groupID
- newOwnerUserID
- oldOwnerUserID
- operationID
type: object
api_struct.TransferGroupOwnerResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.UpdateDepartmentReq:
properties:
createTime:
type: integer
departmentID:
type: string
departmentType:
type: integer
ex:
type: string
faceURL:
type: string
memberNum:
type: integer
name:
type: string
operationID:
type: string
order:
type: integer
parentID:
type: string
subDepartmentNum:
type: integer
required:
- departmentID
- operationID
type: object
api_struct.UpdateDepartmentResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.UpdateOrganizationUserReq:
properties:
birth:
type: integer
createTime:
type: integer
email:
type: string
englishName:
type: string
ex:
type: string
faceURL:
type: string
gender:
type: integer
mobile:
type: string
nickname:
type: string
operationID:
type: string
telephone:
type: string
userID:
type: string
required:
- operationID
type: object
api_struct.UpdateOrganizationUserResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.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
api_struct.UpdateUserInDepartmentReq:
properties:
departmentID:
type: string
ex:
type: string
leader:
type: integer
operationID:
type: string
order:
type: integer
position:
type: string
status:
type: integer
userID:
type: string
required:
- operationID
type: object
api_struct.UpdateUserInDepartmentResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.UpdateUserInfoResp:
properties:
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.UserIDResult:
properties:
result:
type: integer
userID:
type: string
type: object
api_struct.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
api_struct.UserRegisterResp:
properties:
data:
$ref: '#/definitions/api_struct.UserTokenInfo'
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.UserTokenInfo:
properties:
expiredTime:
type: integer
token:
type: string
userID:
type: string
type: object
api_struct.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
api_struct.UserTokenResp:
properties:
data:
$ref: '#/definitions/api_struct.UserTokenInfo'
errCode:
type: integer
errMsg:
type: string
type: object
api_struct.WorkMoment:
properties:
atUsers:
items:
$ref: '#/definitions/api_struct.WorkMomentUser'
type: array
comments:
items:
$ref: '#/definitions/api_struct.Comment'
type: array
content:
type: string
createTime:
type: integer
faceURL:
type: string
likeUsers:
items:
$ref: '#/definitions/api_struct.WorkMomentUser'
type: array
permission:
type: integer
permissionUsers:
items:
$ref: '#/definitions/api_struct.WorkMomentUser'
type: array
userID:
type: string
userName:
type: string
workMomentID:
type: string
type: object
api_struct.WorkMomentUser:
properties:
userID:
type: string
userName:
type: string
type: object
internal_api_manage.FileElem:
properties:
fileName:
type: string
filePath:
type: string
fileSize:
type: integer
sourceURL:
type: string
uuid:
type: string
type: object
internal_api_manage.OANotificationElem:
properties:
ex:
type: string
fileElem:
$ref: '#/definitions/internal_api_manage.FileElem'
mixType:
type: integer
notificationFaceURL:
type: string
notificationName:
type: string
notificationType:
type: integer
pictureElem:
$ref: '#/definitions/internal_api_manage.PictureElem'
soundElem:
$ref: '#/definitions/internal_api_manage.SoundElem'
text:
type: string
url:
type: string
videoElem:
$ref: '#/definitions/internal_api_manage.VideoElem'
required:
- notificationName
- notificationType
- text
type: object
internal_api_manage.PictureBaseInfo:
properties:
height:
type: integer
size:
type: integer
type:
type: string
url:
type: string
uuid:
type: string
width:
type: integer
type: object
internal_api_manage.PictureElem:
properties:
bigPicture:
$ref: '#/definitions/internal_api_manage.PictureBaseInfo'
snapshotPicture:
$ref: '#/definitions/internal_api_manage.PictureBaseInfo'
sourcePath:
type: string
sourcePicture:
$ref: '#/definitions/internal_api_manage.PictureBaseInfo'
type: object
internal_api_manage.RevokeElem:
properties:
revokeMsgClientID:
type: string
required:
- revokeMsgClientID
type: object
internal_api_manage.SoundElem:
properties:
dataSize:
type: integer
duration:
type: integer
soundPath:
type: string
sourceURL:
type: string
uuid:
type: string
type: object
internal_api_manage.TextElem:
properties:
text:
type: string
required:
- text
type: object
internal_api_manage.VideoElem:
properties:
duration:
type: integer
snapshotHeight:
type: integer
snapshotPath:
type: string
snapshotSize:
type: integer
snapshotURL:
type: string
snapshotUUID:
type: string
snapshotWidth:
type: integer
videoPath:
type: string
videoSize:
type: integer
videoType:
type: string
videoURL:
type: string
videoUUID:
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.Department:
properties:
createTime:
type: integer
departmentID:
type: string
departmentType:
type: integer
ex:
type: string
faceURL:
type: string
memberNum:
type: integer
name:
type: string
order:
type: integer
parentID:
type: string
subDepartmentNum:
type: integer
type: object
server_api_params.DepartmentMember:
properties:
departmentID:
type: string
ex:
type: string
leader:
type: integer
order:
type: integer
position:
type: string
status:
type: integer
userID:
type: string
type: object
server_api_params.FriendInfo:
properties:
addSource:
type: integer
createTime:
type: integer
ex:
type: string
friendUser:
$ref: '#/definitions/server_api_params.UserInfo'
operatorUserID:
type: string
ownerUserID:
type: string
remark:
type: string
type: object
server_api_params.FriendRequest:
properties:
createTime:
type: integer
ex:
type: string
fromFaceURL:
type: string
fromGender:
type: integer
fromNickname:
type: string
fromUserID:
type: string
handleMsg:
type: string
handleResult:
type: integer
handleTime:
type: integer
handlerUserID:
type: string
reqMsg:
type: string
toFaceURL:
type: string
toGender:
type: integer
toNickname:
type: string
toUserID:
type: string
type: object
server_api_params.GroupInfo:
properties:
applyMemberFriend:
type: integer
createTime:
type: integer
creatorUserID:
type: string
ex:
type: string
faceURL:
type: string
groupID:
type: string
groupName:
type: string
groupType:
type: integer
introduction:
type: string
lookMemberInfo:
type: integer
memberCount:
type: integer
needVerification:
type: integer
notification:
type: string
notificationUpdateTime:
type: integer
notificationUserID:
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
inviterUserID:
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.GroupRequest:
properties:
ex:
type: string
groupInfo:
$ref: '#/definitions/server_api_params.GroupInfo'
handleMsg:
type: string
handleResult:
type: integer
handleTime:
type: integer
handleUserID:
type: string
inviterUserID:
type: string
joinSource:
type: integer
reqMsg:
type: string
reqTime:
type: integer
userInfo:
$ref: '#/definitions/server_api_params.PublicUserInfo'
type: object
server_api_params.OfflinePushInfo:
properties:
desc:
type: string
ex:
type: string
iOSBadgeCount:
type: boolean
iOSPushSound:
type: string
title:
type: string
type: object
server_api_params.OrganizationUser:
properties:
birth:
type: integer
createTime:
type: integer
email:
type: string
englishName:
type: string
ex:
type: string
faceURL:
type: string
gender:
type: integer
mobile:
type: string
nickname:
type: string
telephone:
type: string
userID:
type: string
type: object
server_api_params.PublicUserInfo:
properties:
ex:
type: string
faceURL:
type: string
gender:
type: integer
nickname:
type: string
userID:
type: string
type: object
server_api_params.UserDepartmentMember:
properties:
departmentMember:
$ref: '#/definitions/server_api_params.DepartmentMember'
organizationUser:
$ref: '#/definitions/server_api_params.OrganizationUser'
type: object
server_api_params.UserInDepartment:
properties:
departmentMemberList:
items:
$ref: '#/definitions/server_api_params.DepartmentMember'
type: array
organizationUser:
$ref: '#/definitions/server_api_params.OrganizationUser'
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
server_api_params.UserSendMsgResp:
properties:
clientMsgID:
type: string
sendTime:
type: integer
serverMsgID:
type: string
type: object
user.AccountCheckResp_SingleUserStatus:
properties:
accountStatus:
type: string
userID:
type: string
type: object
info:
contact: {}
description: open-IM-Server 的API服务器文档, 文档中所有请求都有一个operationID字段用于链路追踪
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
title: open-IM-Server API
version: "1.0"
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 <br> fromUserID为要执行强制登出的用户ID
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.ForceLogoutReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.ForceLogoutResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 强制登出
tags:
- 鉴权认证
/auth/parse_token:
post:
consumes:
- application/json
description: 解析当前用户token(token在请求头中传入)
operationId: ParseToken
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: secret为openIM密钥, 详细见服务端config.yaml secret字段<br>platform为平台ID
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.ParseTokenReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.ParseTokenResp'
- properties:
Data:
$ref: '#/definitions/api_struct.ExpireTime'
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 解析当前用户token
tags:
- 鉴权认证
/auth/user_register:
post:
consumes:
- application/json
description: 用户注册
operationId: UserRegister
parameters:
- description: secret为openIM密钥, 详细见服务端config.yaml secret字段 <br> platform为平台ID
<br> ex为拓展字段 <br> gender为性别, 0为女, 1为男
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.UserRegisterReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.UserRegisterResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 用户注册
tags:
- 鉴权认证
/auth/user_token:
post:
consumes:
- application/json
description: 获取用户的token
operationId: UserToken
parameters:
- description: secret为openIM密钥, 详细见服务端config.yaml secret字段 <br> platform为平台ID
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.UserTokenReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.UserTokenResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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为设置的用户 <br> toUserID为被设置的用户
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.AddBlacklistReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.AddBlacklistResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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为申请信息 <br> fromUserID为申请用户 <br> toUserID为被添加用户
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.AddFriendReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.AddFriendResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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<br>toUserID为申请用户D<br>handleMsg为处理信息<br>flag为具体操作,
1为同意, 2为拒绝
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.AddFriendResponseReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.AddFriendResponseResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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为操作用户<br>toUserID为被删除用户
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.DeleteFriendReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.DeleteFriendResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetBlackListReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetBlackListResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.PublicUserInfo'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
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/api_struct.GetFriendApplyListReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetFriendApplyListResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.FriendRequest'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
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/api_struct.GetFriendListReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetFriendListResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.FriendInfo'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetSelfApplyListReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetSelfApplyListResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.FriendRequest'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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<br> friendUserIDList为
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.ImportFriendReq'
produces:
- application/json
responses:
"0":
description: data列表中对象的result-1为添加该用户失败<br>0为成功
schema:
$ref: '#/definitions/api_struct.ImportFriendResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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为请求用户<br> toUserID为要检查的用户
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.IsFriendReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.IsFriendResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.RemoveBlackListReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.RemoveBlackListResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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为设置的用户<br> toUserID为被设置的用户<br> remark为好友备注
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.SetFriendRemarkReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.SetFriendRemarkResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.CancelMuteGroupReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.CancelMuteGroupResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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 <br> userID为要取消禁言的用户ID
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.CancelMuteGroupMemberReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.CancelMuteGroupMemberResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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: groupType这里填0代表普通群 <br>groupName为群名称<br> introduction为群介绍<br>
notification为群公共<br>ownerUserID为群主ID <br> ex为群扩展字段 <br> memberList中对象roleLevel为群员角色,1为普通用户
2为群主 3为管理员
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.CreateGroupReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.CreateGroupResp'
- properties:
data:
$ref: '#/definitions/server_api_params.GroupInfo'
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.DismissGroupReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.DismissGroupResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetGroupAllMemberReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetGroupAllMemberResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.GroupMemberFullInfo'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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: groupID为要获取的群ID <br> memberList为要获取群成员的群ID列表
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.GetGroupMembersInfoReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetGroupMembersInfoResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.GroupMemberFullInfo'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetGroupInfoReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetGroupInfoResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetJoinedGroupListReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetJoinedGroupListResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.GroupInfo'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetGroupApplicationListReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetGroupApplicationListResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.GroupRequest'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetUserReqGroupApplicationListReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetGroupApplicationListResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.GroupRequest'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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 <br> fromUserID为要处理的用户ID <br> handleMsg为处理结果信息
<br> handleResult为处理结果 1为同意加群 2为拒绝加群
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.ApplicationGroupResponseReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.ApplicationGroupResponseResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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 <br> invitedUserIDList为要获取群成员的群ID列表 <br> reason为原因
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.InviteUserToGroupReq'
produces:
- application/json
responses:
"0":
description: result为结果码, -1为失败, 0为成功
schema:
$ref: '#/definitions/api_struct.InviteUserToGroupResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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为申请进群信息<br>groupID为申请的群ID
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.JoinGroupReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.JoinGroupResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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 <br> kickedUserIDList为要踢出的群用户ID <br> reason为原因
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.KickGroupMemberReq'
produces:
- application/json
responses:
"0":
description: result为结果码, -1为失败, 0为成功
schema:
$ref: '#/definitions/api_struct.KickGroupMemberResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.MuteGroupReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.MuteGroupResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.MuteGroupResp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.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 <br> userID为要禁言的用户ID <br> mutedSeconds为禁言秒数
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.MuteGroupMemberReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.DismissGroupResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.QuitGroupReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.QuitGroupResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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: groupID为要修改的群ID<br>groupName为新的群名称<br>notification为群介绍 <br> introduction为群公告
<br> needVerification为加群验证 0为申请需要同意 邀请直接进 1为所有人进群需要验证除了群主管理员邀请进群 2为直接进群
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.SetGroupInfoReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.SetGroupInfoResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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其他参数可选<br>ex为拓展字段<br>faceURL为群头像<br>nickName为群昵称<br>roleLevel为群员角色,1为普通用户
2为群主 3为管理员
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.SetGroupMemberInfoReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.SetGroupMemberInfoResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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 <br> oldOwnerUserID为老群主ID <br> newOwnerUserID为新群主ID
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.TransferGroupOwnerReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.TransferGroupOwnerResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 转让群主
tags:
- 群组相关
/msg/batch_send_msg:
post:
consumes:
- application/json
description: 管理员批量发送群聊单聊消息 消息格式详细见<a 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">消息格式</href>
operationId: ManagementBatchSendMsg
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 该请求和消息结构体一样 <br> recvIDList为接受消息的用户ID列表
in: body
name: 管理员批量发送单聊消息
required: true
schema:
allOf:
- $ref: '#/definitions/api_struct.ManagementBatchSendMsgReq'
- properties:
content:
$ref: '#/definitions/Open_IM_internal_api_manage.TextElem'
type: object
- description: 该请求和消息结构体一样 <br> recvIDList为接受消息的用户ID列表
in: body
name: 管理员批量发送OA通知
required: true
schema:
allOf:
- $ref: '#/definitions/api_struct.ManagementSendMsgReq'
- properties:
content:
$ref: '#/definitions/Open_IM_internal_api_manage.OANotificationElem'
type: object
produces:
- application/json
responses:
"0":
description: serverMsgID为服务器消息ID <br> clientMsgID为客户端消息ID <br> sendTime为发送消息时间
schema:
$ref: '#/definitions/api_struct.ManagementBatchSendMsgReq'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.ManagementBatchSendMsgReq'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.ManagementBatchSendMsgReq'
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/api_struct.CleanUpMsgReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.CleanUpMsgResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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 <br> seqList为seq列表
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.DelMsgReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.DelMsgResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 根据seq列表删除消息
tags:
- 消息相关
/msg/get_all_conversations:
post:
consumes:
- application/json
description: 获取用户所有会话
operationId: GetAllConversations
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: ownerUserID为要获取的用户ID
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.GetAllConversationsReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetAllConversationsResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 获取用户所有会话
tags:
- 会话相关
/msg/get_conversation:
post:
consumes:
- application/json
description: 根据会话ID获取会话
operationId: GetConversation
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: ownerUserID为要获取的用户ID<br>conversationID为要获取的会话ID
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.GetConversationReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetConversationResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 根据会话ID获取会话
tags:
- 会话相关
/msg/get_conversations:
post:
consumes:
- application/json
description: 根据会话ID列表获取会话
operationId: GetConversations
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: ownerUserID为要获取的用户ID<br>conversationIDs为要获取的会话ID列表
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.GetConversationsReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetConversationsResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 根据会话ID列表获取会话
tags:
- 会话相关
/msg/manage_send_msg:
post:
consumes:
- application/json
description: 管理员发送/撤回消息 消息格式详细见<a 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">消息格式</href>
operationId: ManagementSendMsg
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 该请求和消息结构体一样
in: body
name: 管理员发送文字消息
required: true
schema:
allOf:
- $ref: '#/definitions/api_struct.ManagementSendMsgReq'
- properties:
content:
$ref: '#/definitions/Open_IM_internal_api_manage.TextElem'
type: object
- description: 该请求和消息结构体一样
in: body
name: 管理员发送OA通知消息
required: true
schema:
allOf:
- $ref: '#/definitions/api_struct.ManagementSendMsgReq'
- properties:
content:
$ref: '#/definitions/Open_IM_internal_api_manage.OANotificationElem'
type: object
- description: 该请求和消息结构体一样
in: body
name: 管理员撤回单聊消息
required: true
schema:
allOf:
- $ref: '#/definitions/api_struct.ManagementSendMsgReq'
- properties:
content:
$ref: '#/definitions/Open_IM_internal_api_manage.RevokeElem'
type: object
produces:
- application/json
responses:
"0":
description: serverMsgID为服务器消息ID <br> clientMsgID为客户端消息ID <br> sendTime为发送消息时间
schema:
$ref: '#/definitions/api_struct.ManagementSendMsgResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.ManagementSendMsgResp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.ManagementSendMsgResp'
summary: 管理员发送/撤回消息
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/api_struct.CommentOneWorkMomentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.CommentOneWorkMomentResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.CreateOneWorkMomentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.CreateOneWorkMomentResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.CreateTagReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.CreateTagResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.DeleteCommentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.DeleteCommentResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.DeleteOneWorkMomentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.DeleteOneWorkMomentResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.DeleteTagReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.DeleteTagResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetTagSendLogsReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetTagSendLogsResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetUserFriendWorkMomentsReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetUserFriendWorkMomentsResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetUserTagByIDReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetUserTagByIDResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetUserTagsReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetUserTagsResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetUserWorkMomentsReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetUserWorkMomentsResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetWorkMomentByIDReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetWorkMomentByIDResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.LikeOneWorkMomentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.LikeOneWorkMomentResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.SendMsg2TagReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.SendMsg2TagResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.SetTagReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.SetTagResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 修改标签
tags:
- 标签
/organization/create_department:
post:
consumes:
- application/json
description: 创建部门
operationId: CreateDepartment
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.CreateDepartmentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.CreateDepartmentResp'
- properties:
data:
$ref: '#/definitions/server_api_params.Department'
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 创建部门
tags:
- 组织架构相关
/organization/create_department_member:
post:
consumes:
- application/json
description: 创建部门用户
operationId: CreateDepartmentMember
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.CreateDepartmentMemberReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.CreateDepartmentMemberResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 创建部门用户
tags:
- 组织架构相关
/organization/create_organization_user:
post:
consumes:
- application/json
description: 组织架构导入用户
operationId: CreateOrganizationUser
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.CreateOrganizationUserReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.CreateOrganizationUserResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 组织架构导入用户
tags:
- 组织架构相关
/organization/delete_department:
post:
consumes:
- application/json
description: 删除部门
operationId: DeleteDepartment
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.DeleteDepartmentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.DeleteDepartmentResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 删除部门
tags:
- 组织架构相关
/organization/delete_organization_user:
post:
consumes:
- application/json
description: 删除组织架构中某个用户
operationId: DeleteOrganizationUser
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.DeleteOrganizationUserReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.DeleteOrganizationUserResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 删除组织架构中某个用户
tags:
- 组织架构相关
/organization/delete_user_in_department:
post:
consumes:
- application/json
description: 删除部门中某个用户
operationId: DeleteUserInDepartment
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.DeleteUserInDepartmentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.DeleteUserInDepartmentResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 删除部门中某个用户
tags:
- 组织架构相关
/organization/get_department_member:
post:
consumes:
- application/json
description: 获取部门中所有成员
operationId: GetDepartmentMember
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.GetDepartmentMemberReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetDepartmentMemberResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.UserDepartmentMember'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 获取部门中所有成员
tags:
- 组织架构相关
/organization/get_sub_department:
post:
consumes:
- application/json
description: 获取子部门列表
operationId: GetSubDepartment
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.GetSubDepartmentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetSubDepartmentResp'
- properties:
data:
items:
$ref: '#/definitions/server_api_params.Department'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 获取子部门列表
tags:
- 组织架构相关
/organization/get_user_in_department:
post:
consumes:
- application/json
description: 获取部门中的所有用户
operationId: GetUserInDepartment
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.GetUserInDepartmentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetUserInDepartmentResp'
- properties:
data:
$ref: '#/definitions/server_api_params.UserInDepartment'
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 获取部门中的所有用户
tags:
- 组织架构相关
/organization/update_department:
post:
consumes:
- application/json
description: 更新部门信息
operationId: UpdateDepartment
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.UpdateDepartmentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.UpdateDepartmentResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 更新部门信息
tags:
- 组织架构相关
/organization/update_organization_user:
post:
consumes:
- application/json
description: 更新组织架构中的用户
operationId: UpdateOrganizationUser
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.UpdateOrganizationUserReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.UpdateOrganizationUserResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 更新组织架构中的用户
tags:
- 组织架构相关
/organization/update_user_in_department:
post:
consumes:
- application/json
description: 更新部门中某个用户
operationId: UpdateUserInDepartment
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.UpdateUserInDepartmentReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.UpdateUserInDepartmentResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.MinioUploadFileResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.AccountCheckReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.AccountCheckResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetAllUsersUidReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetAllUsersUidResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetSelfUserInfoReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetSelfUserInfoResp'
- properties:
data:
$ref: '#/definitions/server_api_params.UserInfo'
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetUsersInfoReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
- $ref: '#/definitions/api_struct.GetUsersInfoResp'
- properties:
Data:
items:
$ref: '#/definitions/server_api_params.PublicUserInfo'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.GetUsersOnlineStatusReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.GetUsersOnlineStatusResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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: globalRecvMsgOpt为全局免打扰设置0为关闭 1为开启
in: body
name: req
required: true
schema:
$ref: '#/definitions/api_struct.SetGlobalRecvMessageOptReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.SetGlobalRecvMessageOptResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
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/api_struct.UpdateSelfUserInfoReq'
produces:
- application/json
responses:
"0":
description: ""
schema:
$ref: '#/definitions/api_struct.UpdateUserInfoResp'
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
$ref: '#/definitions/api_struct.Swagger400Resp'
"500":
description: errCode为500 一般为服务器内部错误
schema:
$ref: '#/definitions/api_struct.Swagger500Resp'
summary: 修改用户信息
tags:
- 用户相关
swagger: "2.0"