Files
open-im-server/cmd/open_im_api/docs/swagger.yaml
T

5625 lines
141 KiB
YAML
Raw Normal View History

2022-06-29 18:48:17 +08:00
basePath: /
2022-06-24 20:29:53 +08:00
definitions:
2022-06-29 18:48:17 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.AccountCheckReq:
2022-06-24 20:29:53 +08:00
properties:
2022-06-28 10:29:14 +08:00
checkUserIDList:
items:
type: string
maxItems: 100
type: array
operationID:
type: string
required:
- checkUserIDList
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.AccountCheckResp:
2022-06-28 10:29:14 +08:00
properties:
data:
items:
$ref: '#/definitions/user.AccountCheckResp_SingleUserStatus'
type: array
errCode:
2022-06-24 20:29:53 +08:00
type: integer
2022-06-28 10:29:14 +08:00
errMsg:
2022-06-24 20:29:53 +08:00
type: string
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.AddBlacklistReq:
2022-06-29 11:18:19 +08:00
properties:
fromUserID:
type: string
operationID:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
2023-01-30 16:45:40 +08:00
api_struct.AddBlacklistResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.AddFriendReq:
2022-06-29 11:18:19 +08:00
properties:
fromUserID:
type: string
operationID:
type: string
reqMsg:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
2023-01-30 16:45:40 +08:00
api_struct.AddFriendResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.AddFriendResponseReq:
2022-06-29 11:18:19 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.AddFriendResponseResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.ApplicationGroupResponseReq:
2022-06-29 11:18:19 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.ApplicationGroupResponseResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.CancelMuteGroupMemberReq:
2022-06-29 11:18:19 +08:00
properties:
groupID:
type: string
operationID:
type: string
userID:
type: string
required:
- groupID
- operationID
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.CancelMuteGroupMemberResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.CancelMuteGroupReq:
2022-06-29 11:18:19 +08:00
properties:
groupID:
type: string
operationID:
type: string
required:
- groupID
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.CancelMuteGroupResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.CleanUpMsgReq:
2022-06-29 11:18:19 +08:00
properties:
operationID:
type: string
userID:
type: string
required:
- operationID
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.CleanUpMsgResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.Comment:
2022-06-28 10:29:14 +08:00
properties:
content:
2022-06-24 20:29:53 +08:00
type: string
2022-06-28 10:29:14 +08:00
contentID:
2022-06-24 20:29:53 +08:00
type: string
2022-06-28 10:29:14 +08:00
createTime:
2022-06-24 20:29:53 +08:00
type: integer
2022-06-28 10:29:14 +08:00
replyUserID:
type: string
replyUserName:
type: string
userID:
type: string
userName:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.CommentOneWorkMomentReq:
2022-06-28 10:29:14 +08:00
properties:
content:
2022-06-24 20:29:53 +08:00
type: string
operationID:
type: string
2022-06-28 10:29:14 +08:00
replyUserID:
type: string
workMomentID:
type: string
required:
- content
- operationID
- workMomentID
type: object
2023-01-30 16:45:40 +08:00
api_struct.CommentOneWorkMomentResp:
2022-06-28 10:29:14 +08:00
properties:
data:
type: object
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.Conversation:
2022-06-29 18:48:17 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.CreateDepartmentMemberReq:
2022-06-29 18:48:17 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.CreateDepartmentMemberResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.CreateDepartmentReq:
2022-06-29 18:48:17 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.CreateDepartmentResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.CreateGroupReq:
2022-06-29 11:18:19 +08:00
properties:
ex:
type: string
faceURL:
type: string
groupID:
type: string
groupName:
type: string
groupType:
type: integer
introduction:
type: string
memberList:
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GroupAddMemberInfo'
2022-06-29 11:18:19 +08:00
type: array
notification:
type: string
operationID:
type: string
ownerUserID:
type: string
required:
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.CreateGroupResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.CreateOneWorkMomentReq:
2022-06-28 10:29:14 +08:00
properties:
operationID:
type: string
workMoment:
$ref: '#/definitions/office.WorkMoment'
type: object
2023-01-30 16:45:40 +08:00
api_struct.CreateOneWorkMomentResp:
2022-06-28 10:29:14 +08:00
properties:
data:
type: object
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.CreateOrganizationUserReq:
2022-06-29 18:48:17 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.CreateOrganizationUserResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.CreateTagReq:
2022-06-28 10:29:14 +08:00
properties:
operationID:
type: string
tagName:
description: tag名称
type: string
userIDList:
description: 用户ID列表
items:
type: string
type: array
required:
- operationID
- tagName
- userIDList
type: object
2023-01-30 16:45:40 +08:00
api_struct.CreateTagResp:
2022-06-28 10:29:14 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.DelMsgReq:
2022-06-29 11:18:19 +08:00
properties:
operationID:
type: string
seqList:
items:
type: integer
type: array
userID:
type: string
required:
- operationID
- seqList
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.DelMsgResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteCommentReq:
2022-06-28 10:29:14 +08:00
properties:
contentID:
type: string
operationID:
type: string
workMomentID:
type: string
required:
- contentID
- operationID
- workMomentID
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteCommentResp:
2022-06-28 10:29:14 +08:00
properties:
data:
type: object
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteDepartmentReq:
2022-06-29 18:48:17 +08:00
properties:
departmentID:
type: string
operationID:
type: string
required:
- departmentID
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteDepartmentResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteFriendReq:
2022-06-29 11:18:19 +08:00
properties:
fromUserID:
type: string
operationID:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteFriendResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteOneWorkMomentReq:
2022-06-28 10:29:14 +08:00
properties:
operationID:
type: string
workMomentID:
type: string
required:
- operationID
- workMomentID
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteOneWorkMomentResp:
2022-06-28 10:29:14 +08:00
properties:
data:
type: object
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteOrganizationUserReq:
2022-06-29 18:48:17 +08:00
properties:
operationID:
type: string
userID:
type: string
required:
- operationID
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteOrganizationUserResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteTagReq:
2022-06-28 10:29:14 +08:00
properties:
operationID:
type: string
tagID:
type: string
required:
- operationID
- tagID
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteTagResp:
2022-06-28 10:29:14 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteUserInDepartmentReq:
2022-06-29 18:48:17 +08:00
properties:
departmentID:
type: string
operationID:
type: string
userID:
type: string
required:
- departmentID
- operationID
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.DeleteUserInDepartmentResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.DismissGroupReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
groupID:
type: string
2022-06-28 10:29:14 +08:00
operationID:
type: string
required:
2022-06-29 11:18:19 +08:00
- groupID
2022-06-28 10:29:14 +08:00
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.DismissGroupResp:
2022-06-28 10:29:14 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.ExpireTime:
2022-06-29 18:48:17 +08:00
properties:
expireTimeSeconds:
type: integer
type: object
2023-01-30 16:45:40 +08:00
api_struct.ForceLogoutReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
fromUserID:
maxLength: 64
minLength: 1
2022-06-24 20:29:53 +08:00
type: string
2022-06-29 11:18:19 +08:00
operationID:
2022-06-24 20:29:53 +08:00
type: string
2022-06-29 11:18:19 +08:00
platform:
maximum: 8
minimum: 1
type: integer
2022-06-24 20:29:53 +08:00
required:
2022-06-29 11:18:19 +08:00
- fromUserID
2022-06-24 20:29:53 +08:00
- operationID
2022-06-29 11:18:19 +08:00
- platform
2022-06-24 20:29:53 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.ForceLogoutResp:
2022-06-24 20:29:53 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetAllConversationsReq:
2022-06-28 10:29:14 +08:00
properties:
operationID:
2022-06-24 17:45:33 +08:00
type: string
2022-06-29 18:48:17 +08:00
ownerUserID:
type: string
2022-06-28 10:29:14 +08:00
required:
- operationID
2022-06-29 18:48:17 +08:00
- ownerUserID
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetAllConversationsResp:
2022-06-28 10:29:14 +08:00
properties:
data:
2022-06-29 11:18:19 +08:00
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Conversation'
2022-06-29 11:18:19 +08:00
type: array
2022-06-28 10:29:14 +08:00
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetAllUsersUidReq:
2022-06-28 10:29:14 +08:00
properties:
operationID:
type: string
required:
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetAllUsersUidResp:
2022-06-28 10:29:14 +08:00
properties:
data:
2022-06-29 11:18:19 +08:00
items:
2022-06-29 18:48:17 +08:00
type: string
2022-06-29 11:18:19 +08:00
type: array
2022-06-28 10:29:14 +08:00
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetBlackListReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
fromUserID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
operationID:
2022-06-28 10:29:14 +08:00
type: string
required:
2022-06-29 11:18:19 +08:00
- fromUserID
2022-06-28 10:29:14 +08:00
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetBlackListResp:
2022-06-28 10:29:14 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetConversationReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 18:48:17 +08:00
conversationID:
2022-06-29 11:18:19 +08:00
type: string
2022-06-28 10:29:14 +08:00
operationID:
type: string
2022-06-29 18:48:17 +08:00
ownerUserID:
type: string
2022-06-28 10:29:14 +08:00
required:
2022-06-29 18:48:17 +08:00
- conversationID
2022-06-28 10:29:14 +08:00
- operationID
2022-06-29 18:48:17 +08:00
- ownerUserID
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetConversationResp:
2022-06-28 10:29:14 +08:00
properties:
data:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Conversation'
2022-06-28 10:29:14 +08:00
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetConversationsReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 18:48:17 +08:00
conversationIDs:
items:
type: string
type: array
2022-06-29 11:18:19 +08:00
operationID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 18:48:17 +08:00
ownerUserID:
type: string
2022-06-28 10:29:14 +08:00
required:
2022-06-29 18:48:17 +08:00
- conversationIDs
2022-06-28 10:29:14 +08:00
- operationID
2022-06-29 18:48:17 +08:00
- ownerUserID
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetConversationsResp:
2022-06-29 18:48:17 +08:00
properties:
data:
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Conversation'
2022-06-29 18:48:17 +08:00
type: array
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetDepartmentMemberReq:
2022-06-29 18:48:17 +08:00
properties:
departmentID:
type: string
operationID:
type: string
required:
- departmentID
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetDepartmentMemberResp:
2022-06-28 10:29:14 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetFriendApplyListReq:
2022-06-29 18:48:17 +08:00
properties:
fromUserID:
type: string
operationID:
type: string
required:
- fromUserID
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetFriendApplyListResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetFriendListReq:
2022-06-29 18:48:17 +08:00
properties:
fromUserID:
type: string
operationID:
type: string
required:
- fromUserID
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetFriendListResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetGroupAllMemberReq:
2022-06-29 18:48:17 +08:00
properties:
2022-08-05 18:56:00 +08:00
count:
type: integer
2022-06-29 18:48:17 +08:00
groupID:
type: string
2022-08-05 18:56:00 +08:00
offset:
type: integer
2022-06-29 18:48:17 +08:00
operationID:
type: string
required:
2022-08-08 11:30:10 +08:00
- count
2022-06-29 18:48:17 +08:00
- groupID
2022-08-08 11:30:10 +08:00
- offset
2022-06-29 18:48:17 +08:00
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetGroupAllMemberResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetGroupApplicationListReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
fromUserID:
description: 作为管理员或群主收到的 进群申请
type: string
2022-06-28 10:29:14 +08:00
operationID:
type: string
2022-06-29 11:18:19 +08:00
required:
- fromUserID
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetGroupApplicationListResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetGroupInfoReq:
2022-06-29 11:18:19 +08:00
properties:
groupIDList:
2022-06-28 10:29:14 +08:00
items:
type: string
type: array
2022-06-29 11:18:19 +08:00
operationID:
type: string
2022-06-28 10:29:14 +08:00
required:
2022-06-29 11:18:19 +08:00
- groupIDList
2022-06-28 10:29:14 +08:00
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetGroupInfoResp:
2022-06-28 10:29:14 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetGroupMembersInfoReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
groupID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
memberList:
2022-06-28 10:29:14 +08:00
items:
type: string
type: array
2022-06-29 11:18:19 +08:00
operationID:
type: string
2022-06-28 10:29:14 +08:00
required:
2022-06-29 11:18:19 +08:00
- groupID
- memberList
2022-06-28 10:29:14 +08:00
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetGroupMembersInfoResp:
2022-06-28 10:29:14 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetJoinedGroupListReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
fromUserID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
operationID:
2022-06-28 10:29:14 +08:00
type: string
required:
2022-06-29 11:18:19 +08:00
- fromUserID
2022-06-28 10:29:14 +08:00
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetJoinedGroupListResp:
2022-06-28 10:29:14 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetSelfApplyListReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
fromUserID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
operationID:
2022-06-28 10:29:14 +08:00
type: string
required:
2022-06-29 11:18:19 +08:00
- fromUserID
2022-06-28 10:29:14 +08:00
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetSelfApplyListResp:
2022-06-28 10:29:14 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetSelfUserInfoReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
operationID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
userID:
type: string
required:
- operationID
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetSelfUserInfoResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetSubDepartmentReq:
2022-06-29 18:48:17 +08:00
properties:
departmentID:
type: string
operationID:
type: string
required:
- departmentID
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetSubDepartmentResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetTagSendLogsReq:
2022-06-29 11:18:19 +08:00
properties:
2022-06-28 10:29:14 +08:00
operationID:
type: string
2022-06-29 11:18:19 +08:00
pageNumber:
type: integer
showNumber:
2022-06-28 10:29:14 +08:00
type: integer
required:
- operationID
2022-06-29 11:18:19 +08:00
- pageNumber
- showNumber
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetTagSendLogsResp:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
data:
properties:
currentPage:
type: integer
logs:
items:
$ref: '#/definitions/office.TagSendLog'
type: array
showNumber:
type: integer
type: object
2022-06-28 10:29:14 +08:00
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserFriendWorkMomentsReq:
2022-06-28 10:29:14 +08:00
properties:
operationID:
type: string
2022-06-29 11:18:19 +08:00
pageNumber:
type: integer
showNumber:
type: integer
2022-06-28 10:29:14 +08:00
required:
- operationID
2022-06-29 11:18:19 +08:00
- pageNumber
- showNumber
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserFriendWorkMomentsResp:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
data:
properties:
currentPage:
type: integer
showNumber:
type: integer
workMoments:
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.WorkMoment'
2022-06-29 11:18:19 +08:00
type: array
type: object
2022-06-28 10:29:14 +08:00
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserInDepartmentReq:
2022-06-29 18:48:17 +08:00
properties:
operationID:
type: string
userID:
type: string
required:
- operationID
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserInDepartmentResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserReqGroupApplicationListReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
operationID:
type: string
userID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
required:
- operationID
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserTagByIDReq:
2022-06-29 11:18:19 +08:00
properties:
2022-06-28 10:29:14 +08:00
operationID:
type: string
tagID:
type: string
required:
- operationID
- tagID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserTagByIDResp:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
data:
properties:
tag:
$ref: '#/definitions/office.Tag'
type: object
2022-06-28 10:29:14 +08:00
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserTagsReq:
2022-06-28 10:29:14 +08:00
properties:
operationID:
type: string
required:
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserTagsResp:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
data:
properties:
tags:
items:
$ref: '#/definitions/office.Tag'
type: array
type: object
2022-06-28 10:29:14 +08:00
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserWorkMomentsReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
operationID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
pageNumber:
2022-06-28 10:29:14 +08:00
type: integer
2022-06-29 11:18:19 +08:00
showNumber:
type: integer
userID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
required:
- operationID
- pageNumber
- showNumber
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUserWorkMomentsResp:
2022-06-29 11:18:19 +08:00
properties:
data:
properties:
currentPage:
type: integer
showNumber:
type: integer
workMoments:
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.WorkMoment'
2022-06-29 11:18:19 +08:00
type: array
type: object
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUsersInfoReq:
2022-06-29 11:18:19 +08:00
properties:
operationID:
type: string
userIDList:
2022-06-28 10:29:14 +08:00
items:
2022-06-29 11:18:19 +08:00
type: string
2022-06-28 10:29:14 +08:00
type: array
2022-06-29 11:18:19 +08:00
required:
- operationID
- userIDList
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUsersInfoResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
2022-06-28 10:29:14 +08:00
type: integer
2022-06-29 11:18:19 +08:00
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUsersOnlineStatusReq:
2022-06-29 11:18:19 +08:00
properties:
operationID:
type: string
userIDList:
2022-06-28 10:29:14 +08:00
items:
2022-06-29 11:18:19 +08:00
type: string
maxItems: 200
2022-06-28 10:29:14 +08:00
type: array
2022-06-29 11:18:19 +08:00
required:
- operationID
- userIDList
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetUsersOnlineStatusResp:
2022-06-29 11:18:19 +08:00
properties:
data:
items:
$ref: '#/definitions/pbRelay.GetUsersOnlineStatusResp_SuccessResult'
type: array
errCode:
type: integer
errMsg:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetWorkMomentByIDReq:
2022-06-29 11:18:19 +08:00
properties:
operationID:
2022-06-28 10:29:14 +08:00
type: string
workMomentID:
type: string
2022-06-29 11:18:19 +08:00
required:
- operationID
- workMomentID
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.GetWorkMomentByIDResp:
2022-06-29 11:18:19 +08:00
properties:
data:
properties:
workMoment:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.WorkMoment'
2022-06-29 11:18:19 +08:00
type: object
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.GroupAddMemberInfo:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
roleLevel:
2022-08-05 18:56:00 +08:00
enum:
- 1
- 3
2022-06-29 11:18:19 +08:00
type: integer
2022-06-28 10:29:14 +08:00
userID:
type: string
2022-06-29 11:18:19 +08:00
required:
- roleLevel
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.ImportFriendReq:
2022-06-29 11:18:19 +08:00
properties:
friendUserIDList:
items:
type: string
type: array
fromUserID:
type: string
operationID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
required:
- friendUserIDList
- fromUserID
- operationID
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.ImportFriendResp:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
data:
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UserIDResult'
2022-06-29 11:18:19 +08:00
type: array
errCode:
type: integer
errMsg:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.InviteUserToGroupReq:
2022-06-29 11:18:19 +08:00
properties:
groupID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
invitedUserIDList:
items:
type: string
type: array
operationID:
type: string
reason:
type: string
required:
- groupID
- invitedUserIDList
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.InviteUserToGroupResp:
2022-06-29 11:18:19 +08:00
properties:
data:
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UserIDResult'
2022-06-29 11:18:19 +08:00
type: array
errCode:
2022-06-28 10:29:14 +08:00
type: integer
2022-06-29 11:18:19 +08:00
errMsg:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.IsFriendReq:
2022-06-29 11:18:19 +08:00
properties:
fromUserID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
operationID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
toUserID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
required:
- fromUserID
- operationID
- toUserID
type: object
2023-01-30 16:45:40 +08:00
api_struct.IsFriendResp:
2022-06-29 11:18:19 +08:00
properties:
data:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Response'
2022-06-29 11:18:19 +08:00
errCode:
type: integer
errMsg:
2022-06-28 10:29:14 +08:00
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.JoinGroupReq:
2022-06-28 10:29:14 +08:00
properties:
groupID:
type: string
2022-08-05 18:56:00 +08:00
inviterUserID:
type: string
joinSource:
type: integer
2022-06-29 11:18:19 +08:00
operationID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
reqMessage:
type: string
required:
- groupID
- operationID
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.JoinGroupResp:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
errCode:
type: integer
errMsg:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.KickGroupMemberReq:
2022-06-29 11:18:19 +08:00
properties:
groupID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
kickedUserIDList:
2022-06-28 10:29:14 +08:00
items:
2022-06-29 11:18:19 +08:00
type: string
2022-06-28 10:29:14 +08:00
type: array
2022-06-29 11:18:19 +08:00
operationID:
type: string
reason:
type: string
required:
- groupID
- kickedUserIDList
- operationID
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.KickGroupMemberResp:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
data:
2022-06-28 10:29:14 +08:00
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UserIDResult'
2022-06-28 10:29:14 +08:00
type: array
2022-06-29 11:18:19 +08:00
errCode:
type: integer
errMsg:
type: string
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.LikeOneWorkMomentReq:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
operationID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
workMomentID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
required:
- operationID
- workMomentID
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.LikeOneWorkMomentResp:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
data:
type: object
errCode:
2022-06-28 10:29:14 +08:00
type: integer
2022-06-29 11:18:19 +08:00
errMsg:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.ManagementBatchSendMsgReq:
2022-06-29 11:18:19 +08:00
properties:
2022-08-05 18:56:00 +08:00
businessOperationID:
type: string
2022-06-29 18:48:17 +08:00
contentType:
type: integer
groupID:
2022-06-29 11:18:19 +08:00
type: string
2022-06-29 18:48:17 +08:00
isOnlineOnly:
type: boolean
2022-08-05 18:56:00 +08:00
notOfflinePush:
type: boolean
2022-06-29 18:48:17 +08:00
offlinePushInfo:
$ref: '#/definitions/server_api_params.OfflinePushInfo'
operationID:
type: string
recvIDList:
items:
type: string
type: array
sendID:
2022-06-29 11:18:19 +08:00
type: string
2022-06-29 18:48:17 +08:00
senderFaceURL:
2022-06-29 11:18:19 +08:00
type: string
2022-06-29 18:48:17 +08:00
senderNickname:
type: string
senderPlatformID:
type: integer
sessionType:
type: integer
required:
- contentType
- operationID
- sendID
- sessionType
type: object
2023-01-30 16:45:40 +08:00
api_struct.ManagementSendMsgReq:
2022-06-29 18:48:17 +08:00
properties:
2022-08-05 18:56:00 +08:00
businessOperationID:
type: string
2022-06-29 18:48:17 +08:00
contentType:
type: integer
groupID:
type: string
isOnlineOnly:
type: boolean
2022-08-05 18:56:00 +08:00
notOfflinePush:
type: boolean
2022-06-29 18:48:17 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.ManagementSendMsgResp:
2022-06-29 18:48:17 +08:00
properties:
data:
$ref: '#/definitions/server_api_params.UserSendMsgResp'
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.MinioUploadFileResp:
2022-06-29 18:48:17 +08:00
properties:
data:
properties:
URL:
type: string
newName:
type: string
snapshotName:
type: string
snapshotURL:
type: string
type: object
errCode:
type: integer
errMsg:
2022-06-29 11:18:19 +08:00
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.MuteGroupMemberReq:
2022-06-29 11:18:19 +08:00
properties:
groupID:
type: string
mutedSeconds:
2022-06-28 10:29:14 +08:00
type: integer
2022-06-29 11:18:19 +08:00
operationID:
type: string
2022-06-28 10:29:14 +08:00
userID:
type: string
2022-06-29 11:18:19 +08:00
required:
- groupID
- mutedSeconds
- operationID
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.MuteGroupReq:
2022-06-29 11:18:19 +08:00
properties:
groupID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
operationID:
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 11:18:19 +08:00
required:
- groupID
- operationID
2022-06-28 10:29:14 +08:00
type: object
2023-01-30 16:45:40 +08:00
api_struct.MuteGroupResp:
2022-06-28 10:29:14 +08:00
properties:
2022-06-29 11:18:19 +08:00
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.ParseTokenReq:
2022-06-29 11:18:19 +08:00
properties:
operationID:
type: string
required:
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.ParseTokenResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.QuitGroupReq:
2022-06-29 11:18:19 +08:00
properties:
groupID:
type: string
operationID:
type: string
required:
- groupID
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.QuitGroupResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.RemoveBlackListReq:
2022-06-29 11:18:19 +08:00
properties:
fromUserID:
type: string
operationID:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
2023-01-30 16:45:40 +08:00
api_struct.RemoveBlackListResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.Response:
2022-06-29 11:18:19 +08:00
properties:
isFriend:
type: boolean
type: object
2023-01-30 16:45:40 +08:00
api_struct.SendMsg2TagReq:
2022-06-29 11:18:19 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.SendMsg2TagResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.SetFriendRemarkReq:
2022-06-29 11:18:19 +08:00
properties:
fromUserID:
type: string
operationID:
type: string
remark:
type: string
toUserID:
type: string
required:
- fromUserID
- operationID
- toUserID
type: object
2023-01-30 16:45:40 +08:00
api_struct.SetFriendRemarkResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.SetGlobalRecvMessageOptReq:
2022-06-29 11:18:19 +08:00
properties:
globalRecvMsgOpt:
enum:
- 0
- 1
- 2
type: integer
operationID:
type: string
required:
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.SetGlobalRecvMessageOptResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.SetGroupInfoReq:
2022-06-29 11:18:19 +08:00
properties:
2022-08-05 18:56:00 +08:00
applyMemberFriend:
type: integer
2022-06-29 11:18:19 +08:00
ex:
type: string
faceURL:
type: string
groupID:
type: string
groupName:
type: string
introduction:
type: string
2022-08-05 18:56:00 +08:00
lookMemberInfo:
type: integer
2022-06-29 11:18:19 +08:00
needVerification:
type: integer
notification:
type: string
operationID:
type: string
required:
- groupID
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.SetGroupInfoResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.SetGroupMemberInfoReq:
2022-06-29 11:18:19 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.SetGroupMemberInfoResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.SetTagReq:
2022-06-29 11:18:19 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.SetTagResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.Swagger400Resp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
example: 400
type: integer
errMsg:
example: err msg
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.Swagger500Resp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
example: 500
type: integer
errMsg:
example: err msg
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.TransferGroupOwnerReq:
2022-06-29 11:18:19 +08:00
properties:
groupID:
type: string
newOwnerUserID:
type: string
oldOwnerUserID:
type: string
operationID:
type: string
required:
- groupID
- newOwnerUserID
- oldOwnerUserID
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.TransferGroupOwnerResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.UpdateDepartmentReq:
2022-06-29 18:48:17 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.UpdateDepartmentResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.UpdateOrganizationUserReq:
2022-06-29 11:18:19 +08:00
properties:
birth:
type: integer
2022-06-29 18:48:17 +08:00
createTime:
type: integer
2022-06-29 11:18:19 +08:00
email:
2022-06-29 18:48:17 +08:00
type: string
englishName:
2022-06-29 11:18:19 +08:00
type: string
ex:
type: string
faceURL:
type: string
gender:
type: integer
2022-06-29 18:48:17 +08:00
mobile:
type: string
2022-06-29 11:18:19 +08:00
nickname:
type: string
operationID:
type: string
2022-06-29 18:48:17 +08:00
telephone:
2022-06-29 11:18:19 +08:00
type: string
userID:
type: string
required:
- operationID
type: object
2023-01-30 16:45:40 +08:00
api_struct.UpdateOrganizationUserResp:
2022-06-29 11:18:19 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.UpdateSelfUserInfoReq:
2022-06-29 11:18:19 +08:00
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
2022-06-29 18:48:17 +08:00
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.UpdateUserInDepartmentReq:
2022-06-29 18:48:17 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.UpdateUserInDepartmentResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.UpdateUserInfoResp:
2022-06-29 18:48:17 +08:00
properties:
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.UserIDResult:
2022-06-29 18:48:17 +08:00
properties:
result:
type: integer
userID:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.UserRegisterReq:
2022-06-29 18:48:17 +08:00
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
2022-06-29 11:18:19 +08:00
- userID
type: object
2023-01-30 16:45:40 +08:00
api_struct.UserRegisterResp:
2022-06-29 11:18:19 +08:00
properties:
data:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UserTokenInfo'
2022-06-29 11:18:19 +08:00
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.UserTokenInfo:
2022-06-29 11:18:19 +08:00
properties:
expiredTime:
type: integer
token:
type: string
userID:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.UserTokenReq:
2022-06-29 11:18:19 +08:00
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
2023-01-30 16:45:40 +08:00
api_struct.UserTokenResp:
2022-06-29 11:18:19 +08:00
properties:
data:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UserTokenInfo'
2022-06-29 11:18:19 +08:00
errCode:
type: integer
errMsg:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.WorkMoment:
2022-06-29 11:18:19 +08:00
properties:
atUsers:
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.WorkMomentUser'
2022-06-29 11:18:19 +08:00
type: array
comments:
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Comment'
2022-06-29 11:18:19 +08:00
type: array
content:
type: string
createTime:
type: integer
faceURL:
type: string
likeUsers:
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.WorkMomentUser'
2022-06-29 11:18:19 +08:00
type: array
permission:
type: integer
permissionUsers:
items:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.WorkMomentUser'
2022-06-29 11:18:19 +08:00
type: array
userID:
type: string
userName:
type: string
workMomentID:
type: string
type: object
2023-01-30 16:45:40 +08:00
api_struct.WorkMomentUser:
2022-06-29 11:18:19 +08:00
properties:
userID:
type: string
userName:
type: string
type: object
2022-06-29 18:48:17 +08:00
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
2022-06-29 11:18:19 +08:00
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
2022-06-29 18:48:17 +08:00
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
2022-06-29 11:18:19 +08:00
server_api_params.GroupInfo:
properties:
2022-08-05 18:56:00 +08:00
applyMemberFriend:
type: integer
2022-06-29 11:18:19 +08:00
createTime:
type: integer
creatorUserID:
type: string
ex:
type: string
faceURL:
type: string
groupID:
type: string
groupName:
type: string
groupType:
type: integer
introduction:
type: string
2022-08-05 18:56:00 +08:00
lookMemberInfo:
type: integer
2022-06-29 11:18:19 +08:00
memberCount:
type: integer
needVerification:
2022-06-29 18:48:17 +08:00
type: integer
2022-06-29 11:18:19 +08:00
notification:
type: string
2022-08-05 18:56:00 +08:00
notificationUpdateTime:
type: integer
notificationUserID:
type: string
2022-06-29 11:18:19 +08:00
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
2022-08-05 18:56:00 +08:00
inviterUserID:
type: string
2022-06-29 11:18:19 +08:00
joinSource:
type: integer
joinTime:
type: integer
muteEndTime:
type: integer
nickname:
type: string
operatorUserID:
type: string
roleLevel:
type: integer
userID:
type: string
type: object
2022-06-29 18:48:17 +08:00
server_api_params.GroupRequest:
2022-06-29 11:18:19 +08:00
properties:
2022-06-29 18:48:17 +08:00
ex:
type: string
groupInfo:
$ref: '#/definitions/server_api_params.GroupInfo'
handleMsg:
type: string
handleResult:
type: integer
handleTime:
type: integer
handleUserID:
type: string
2022-08-05 18:56:00 +08:00
inviterUserID:
type: string
joinSource:
type: integer
2022-06-29 18:48:17 +08:00
reqMsg:
type: string
reqTime:
2022-06-29 11:18:19 +08:00
type: integer
2022-06-29 18:48:17 +08:00
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:
2022-06-29 11:18:19 +08:00
birth:
type: integer
createTime:
type: integer
email:
type: string
2022-06-29 18:48:17 +08:00
englishName:
type: string
2022-06-29 11:18:19 +08:00
ex:
type: string
faceURL:
type: string
gender:
type: integer
2022-06-29 18:48:17 +08:00
mobile:
type: string
2022-06-29 11:18:19 +08:00
nickname:
type: string
2022-06-29 18:48:17 +08:00
telephone:
2022-06-29 11:18:19 +08:00
type: string
userID:
type: string
type: object
2022-06-29 18:48:17 +08:00
server_api_params.PublicUserInfo:
2022-06-29 11:18:19 +08:00
properties:
2022-06-29 18:48:17 +08:00
ex:
type: string
faceURL:
type: string
gender:
type: integer
nickname:
2022-06-29 11:18:19 +08:00
type: string
userID:
type: string
type: object
2022-06-29 18:48:17 +08:00
server_api_params.UserDepartmentMember:
2022-06-29 11:18:19 +08:00
properties:
2022-06-29 18:48:17 +08:00
departmentMember:
$ref: '#/definitions/server_api_params.DepartmentMember'
organizationUser:
$ref: '#/definitions/server_api_params.OrganizationUser'
2022-06-29 11:18:19 +08:00
type: object
2022-06-29 18:48:17 +08:00
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
2022-06-29 11:18:19 +08:00
type: string
2022-06-29 18:48:17 +08:00
- description: platform为平台ID <br> fromUserID为要执行强制登出的用户ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ForceLogoutReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ForceLogoutResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 11:18:19 +08:00
summary: 强制登出
tags:
- 鉴权认证
/auth/parse_token:
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 解析当前用户token(token在请求头中传入)
2022-06-29 11:18:19 +08:00
operationId: ParseToken
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: secret为openIM密钥, 详细见服务端config.yaml secret字段<br>platform为平台ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ParseTokenReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2022-06-29 18:48:17 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.ParseTokenResp'
2022-06-29 18:48:17 +08:00
- properties:
Data:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ExpireTime'
2022-06-29 18:48:17 +08:00
type: object
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 解析当前用户token
2022-06-29 11:18:19 +08:00
tags:
- 鉴权认证
/auth/user_register:
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 用户注册
2022-06-29 11:18:19 +08:00
operationId: UserRegister
parameters:
- description: secret为openIM密钥, 详细见服务端config.yaml secret字段 <br> platform为平台ID
2022-06-29 18:48:17 +08:00
<br> ex为拓展字段 <br> gender为性别, 0为女, 1为男
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UserRegisterReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UserRegisterResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 用户注册
2022-06-29 11:18:19 +08:00
tags:
- 鉴权认证
/auth/user_token:
post:
consumes:
- application/json
description: 获取用户的token
operationId: UserToken
parameters:
2022-06-29 18:48:17 +08:00
- description: secret为openIM密钥, 详细见服务端config.yaml secret字段 <br> platform为平台ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UserTokenReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UserTokenResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 11:18:19 +08:00
summary: 用户登录
tags:
- 鉴权认证
/friend/add_black:
post:
consumes:
- application/json
description: 添加黑名单
operationId: AddBlack
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: fromUserID为设置的用户 <br> toUserID为被设置的用户
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.AddBlacklistReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.AddBlacklistResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 11:18:19 +08:00
summary: 添加黑名单
tags:
- 好友相关
/friend/add_friend:
post:
consumes:
- application/json
description: 添加好友
operationId: AddFriend
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: reqMsg为申请信息 <br> fromUserID为申请用户 <br> toUserID为被添加用户
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.AddFriendReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.AddFriendResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 11:18:19 +08:00
summary: 添加好友
tags:
- 好友相关
/friend/add_friend_response:
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.AddFriendResponseReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.AddFriendResponseResp'
2022-06-29 18:48:17 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteFriendReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteFriendResp'
2022-06-29 18:48:17 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetBlackListReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetBlackListResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
items:
$ref: '#/definitions/server_api_params.PublicUserInfo'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetFriendApplyListReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetFriendApplyListResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
items:
$ref: '#/definitions/server_api_params.FriendRequest'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetFriendListReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetFriendListResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
items:
$ref: '#/definitions/server_api_params.FriendInfo'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetSelfApplyListReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetSelfApplyListResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
items:
$ref: '#/definitions/server_api_params.FriendRequest'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ImportFriendReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: data列表中对象的result-1为添加该用户失败<br>0为成功
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ImportFriendResp'
2022-06-29 18:48:17 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.IsFriendReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.IsFriendResp'
2022-06-29 18:48:17 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.RemoveBlackListReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.RemoveBlackListResp'
2022-06-29 18:48:17 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SetFriendRemarkReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SetFriendRemarkResp'
2022-06-29 18:48:17 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CancelMuteGroupReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CancelMuteGroupResp'
2022-06-29 18:48:17 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CancelMuteGroupMemberReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CancelMuteGroupMemberResp'
2022-06-29 18:48:17 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CreateGroupReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.CreateGroupResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
$ref: '#/definitions/server_api_params.GroupInfo'
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DismissGroupReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DismissGroupResp'
2022-06-29 18:48:17 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetGroupAllMemberReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetGroupAllMemberResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
items:
$ref: '#/definitions/server_api_params.GroupMemberFullInfo'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetGroupMembersInfoReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetGroupMembersInfoResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
items:
$ref: '#/definitions/server_api_params.GroupMemberFullInfo'
type: array
type: object
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetGroupInfoReq'
2022-06-29 18:48:17 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetGroupInfoResp'
2022-06-29 18:48:17 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 18:48:17 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 通过群ID列表获取群信息
tags:
- 群组相关
/group/get_joined_group_list:
post:
consumes:
- application/json
description: 获取用户加入群列表
operationId: GetJoinedGroupList
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: fromUserID为要获取的用户ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetJoinedGroupListReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2022-06-29 18:48:17 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetJoinedGroupListResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
items:
$ref: '#/definitions/server_api_params.GroupInfo'
type: array
type: object
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 获取用户加入群列表
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 群组相关
/group/get_recv_group_applicationList:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 获取用户收到的加群信息列表
operationId: GetRecvGroupApplicationList
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: fromUserID为要获取的用户ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetGroupApplicationListReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2022-06-29 18:48:17 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetGroupApplicationListResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
items:
$ref: '#/definitions/server_api_params.GroupRequest'
type: array
type: object
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 获取用户收到的加群信息列表
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 群组相关
/group/get_user_req_group_applicationList:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 获取用户加群申请列表
operationId: GetUserReqGroupApplicationList
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: userID为要获取的用户ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUserReqGroupApplicationListReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2022-06-29 18:48:17 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetGroupApplicationListResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
items:
$ref: '#/definitions/server_api_params.GroupRequest'
type: array
type: object
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 获取用户加群申请列表
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 群组相关
/group/group_application_response:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 处理加群消息
operationId: ApplicationGroupResponse
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: groupID为要处理的群ID <br> fromUserID为要处理的用户ID <br> handleMsg为处理结果信息
<br> handleResult为处理结果 1为同意加群 2为拒绝加群
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ApplicationGroupResponseReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ApplicationGroupResponseResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 处理加群消息
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 群组相关
/group/invite_user_to_group:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 将用户拉入群组
operationId: InviteUserToGroup
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: groupID为要拉进的群组ID <br> invitedUserIDList为要获取群成员的群ID列表 <br> reason为原因
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.InviteUserToGroupReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
2022-06-29 18:48:17 +08:00
description: result为结果码, -1为失败, 0为成功
2022-06-29 11:18:19 +08:00
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.InviteUserToGroupResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 将用户拉入群组
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 群组相关
/group/join_group:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 加入群聊
operationId: JoinGroup
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: reqMessage为申请进群信息<br>groupID为申请的群ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.JoinGroupReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.JoinGroupResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 加入群聊
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 群组相关
/group/kick_group:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 把用户踢出群组
operationId: KickGroupMember
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: GroupID为要操作的群ID <br> kickedUserIDList为要踢出的群用户ID <br> reason为原因
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.KickGroupMemberReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
2022-06-29 18:48:17 +08:00
description: result为结果码, -1为失败, 0为成功
2022-06-29 11:18:19 +08:00
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.KickGroupMemberResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 把用户踢出群组
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 群组相关
/group/mute_group:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 禁言群组
operationId: MuteGroup
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: groupID为群组ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.MuteGroupReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.MuteGroupResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.MuteGroupResp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.MuteGroupResp'
2022-06-29 18:48:17 +08:00
summary: 禁言群组
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 群组相关
/group/mute_group_member:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 禁言群成员
operationId: MuteGroupMember
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: groupID为群组ID <br> userID为要禁言的用户ID <br> mutedSeconds为禁言秒数
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.MuteGroupMemberReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DismissGroupResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 禁言群成员
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 群组相关
/group/quit_group:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 当前用户退出群聊
operationId: QuitGroup
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: groupID为要退出的群ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.QuitGroupReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.QuitGroupResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 当前用户退出群聊
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 群组相关
/group/set_group_info:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 设置群信息
operationId: SetGroupInfo
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: groupID为要修改的群ID<br>groupName为新的群名称<br>notification为群介绍 <br> introduction为群公告
<br> needVerification为加群验证 0为申请需要同意 邀请直接进 1为所有人进群需要验证,除了群主管理员邀请进群 2为直接进群
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SetGroupInfoReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SetGroupInfoResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 设置群信息
2022-06-29 11:18:19 +08:00
tags:
- 群组相关
2022-06-29 18:48:17 +08:00
/group/set_group_member_info:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 修改群成员信息
operationId: SetGroupMemberInfo
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: 除了operationID, userID, groupID其他参数可选<br>ex为拓展字段<br>faceURL为群头像<br>nickName为群昵称<br>roleLevel为群员角色,1为普通用户
2为群主 3为管理员
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SetGroupMemberInfoReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SetGroupMemberInfoResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 修改群成员信息
2022-06-29 11:18:19 +08:00
tags:
- 群组相关
2022-06-29 18:48:17 +08:00
/group/transfer_group:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 转让群主
operationId: TransferGroupOwner
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: GroupID为要操作的群ID <br> oldOwnerUserID为老群主ID <br> newOwnerUserID为新群主ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.TransferGroupOwnerReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.TransferGroupOwnerResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 转让群主
2022-06-29 11:18:19 +08:00
tags:
- 群组相关
2022-06-29 18:48:17 +08:00
/msg/batch_send_msg:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
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
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: 该请求和消息结构体一样 <br> recvIDList为接受消息的用户ID列表
2022-06-29 11:18:19 +08:00
in: body
2022-06-29 18:48:17 +08:00
name: 管理员批量发送单聊消息
2022-06-29 11:18:19 +08:00
required: true
schema:
2022-06-29 18:48:17 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.ManagementBatchSendMsgReq'
2022-06-29 18:48:17 +08:00
- properties:
content:
$ref: '#/definitions/Open_IM_internal_api_manage.TextElem'
type: object
- description: 该请求和消息结构体一样 <br> recvIDList为接受消息的用户ID列表
in: body
name: 管理员批量发送OA通知
required: true
schema:
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.ManagementSendMsgReq'
2022-06-29 18:48:17 +08:00
- properties:
content:
$ref: '#/definitions/Open_IM_internal_api_manage.OANotificationElem'
type: object
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
2022-06-29 18:48:17 +08:00
description: serverMsgID为服务器消息ID <br> clientMsgID为客户端消息ID <br> sendTime为发送消息时间
2022-06-29 11:18:19 +08:00
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ManagementBatchSendMsgReq'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ManagementBatchSendMsgReq'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ManagementBatchSendMsgReq'
2022-06-29 18:48:17 +08:00
summary: 管理员批量发送群聊单聊消息
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 消息相关
/msg/clear_msg:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 清空用户消息
operationId: ClearMsg
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: userID为要清空的用户ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CleanUpMsgReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CleanUpMsgResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 清空用户消息
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 消息相关
/msg/del_msg:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 根据seq列表删除消息
operationId: DelMsg
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: userID为要删除的用户ID <br> seqList为seq列表
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DelMsgReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DelMsgResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 根据seq列表删除消息
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 消息相关
/msg/get_all_conversations:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 获取用户所有会话
operationId: GetAllConversations
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: ownerUserID为要获取的用户ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetAllConversationsReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetAllConversationsResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 获取用户所有会话
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 会话相关
/msg/get_conversation:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 根据会话ID获取会话
operationId: GetConversation
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: ownerUserID为要获取的用户ID<br>conversationID为要获取的会话ID
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetConversationReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetConversationResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 根据会话ID获取会话
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 会话相关
/msg/get_conversations:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 根据会话ID列表获取会话
operationId: GetConversations
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: ownerUserID为要获取的用户ID<br>conversationIDs为要获取的会话ID列表
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetConversationsReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetConversationsResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 根据会话ID列表获取会话
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 会话相关
/msg/manage_send_msg:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
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
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: 该请求和消息结构体一样
2022-06-29 11:18:19 +08:00
in: body
2022-06-29 18:48:17 +08:00
name: 管理员发送文字消息
2022-06-29 11:18:19 +08:00
required: true
schema:
2022-06-29 18:48:17 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.ManagementSendMsgReq'
2022-06-29 18:48:17 +08:00
- properties:
content:
$ref: '#/definitions/Open_IM_internal_api_manage.TextElem'
type: object
- description: 该请求和消息结构体一样
in: body
name: 管理员发送OA通知消息
required: true
schema:
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.ManagementSendMsgReq'
2022-06-29 18:48:17 +08:00
- properties:
content:
$ref: '#/definitions/Open_IM_internal_api_manage.OANotificationElem'
type: object
- description: 该请求和消息结构体一样
in: body
name: 管理员撤回单聊消息
required: true
schema:
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.ManagementSendMsgReq'
2022-06-29 18:48:17 +08:00
- properties:
content:
$ref: '#/definitions/Open_IM_internal_api_manage.RevokeElem'
type: object
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
2022-06-29 18:48:17 +08:00
description: serverMsgID为服务器消息ID <br> clientMsgID为客户端消息ID <br> sendTime为发送消息时间
2022-06-29 11:18:19 +08:00
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ManagementSendMsgResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ManagementSendMsgResp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.ManagementSendMsgResp'
2022-06-29 18:48:17 +08:00
summary: 管理员发送/撤回消息
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 消息相关
/office/comment_one_work_moment:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 评论一条工作圈
operationId: CommentOneWorkMoment
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CommentOneWorkMomentReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CommentOneWorkMomentResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 评论一条工作圈
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 工作圈
/office/create_one_work_moment:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 用户创建一条工作圈
operationId: CreateOneWorkMoment
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: 请求 atUserList likeUserList permissionGroupList permissionUserList
字段中userName可以不填
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CreateOneWorkMomentReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
2022-06-29 18:48:17 +08:00
description: ""
2022-06-29 11:18:19 +08:00
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CreateOneWorkMomentResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 创建一条工作圈
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 工作圈
/office/create_tag:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 创建标签
operationId: CreateTag
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CreateTagReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CreateTagResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 创建标签
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 标签
/office/delete_comment:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 删除一条评论
operationId: DeleteComment
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteCommentReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
2022-06-29 18:48:17 +08:00
description: ""
2022-06-29 11:18:19 +08:00
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteCommentResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 删除一条评论
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 工作圈
/office/delete_one_work_moment:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 根据用户工作圈ID删除一条工作圈
operationId: DeleteOneWorkMoment
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteOneWorkMomentReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteOneWorkMomentResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 删除一条工作圈
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 工作圈
/office/delete_tag:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 根据标签ID创建标签
operationId: DeleteTag
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteTagReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteTagResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 删除标签
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 标签
/office/get_send_tag_log:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 分页获取发送历史记录
operationId: GetTagSendLogs
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetTagSendLogsReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetTagSendLogsResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 获取发送历史记录
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 标签
/office/get_user_friend_work_moments:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 查询用户工作圈页面
operationId: GetUserFriendWorkMoments
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUserFriendWorkMomentsReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUserFriendWorkMomentsResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 查询自己大工作圈页面
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 工作圈
/office/get_user_tag_by_id:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 通过标签id获取该用户的标签信息
operationId: GetUserTagByID
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUserTagByIDReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUserTagByIDResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 获取该用户的标签信息
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 标签
/office/get_user_tags:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 用户获取自己的所有的标签
operationId: GetUserTags
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUserTagsReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUserTagsResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 获取用户标签信息
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 标签
/office/get_user_work_moments:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 查询用户工作圈
operationId: GetUserWorkMoments
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUserWorkMomentsReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUserWorkMomentsResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 查询用户工作圈
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 工作圈
/office/get_work_moment_by_id:
2022-06-29 11:18:19 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 通过ID获取工作圈
operationId: GetWorkMomentByID
2022-06-29 11:18:19 +08:00
parameters:
- description: im token
in: header
name: token
required: true
2022-06-28 10:29:14 +08:00
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-29 11:18:19 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetWorkMomentByIDReq'
2022-06-29 11:18:19 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetWorkMomentByIDResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 通过ID获取工作圈
2022-06-29 11:18:19 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 工作圈
/office/like_one_work_moment:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 工作圈ID点赞一条工作圈
operationId: LikeOneWorkMoment
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.LikeOneWorkMomentReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.LikeOneWorkMomentResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 点赞一条工作圈
2022-06-28 10:29:14 +08:00
tags:
- 工作圈
2022-06-29 18:48:17 +08:00
/office/send_msg_to_tag:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 对标签用户发送消息
operationId: SendMsg2Tag
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
2022-06-29 18:48:17 +08:00
- description: 请求
2022-06-28 10:29:14 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SendMsg2TagReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SendMsg2TagResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 发送标签消息
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 标签
/office/set_tag:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 根据标签ID修改标签用户列表, 名称
operationId: SetTag
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SetTagReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SetTagResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 修改标签
2022-06-28 10:29:14 +08:00
tags:
- 标签
2022-06-29 18:48:17 +08:00
/organization/create_department:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 创建部门
operationId: CreateDepartment
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CreateDepartmentReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2022-06-29 18:48:17 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.CreateDepartmentResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
$ref: '#/definitions/server_api_params.Department'
type: object
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 创建部门
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/create_department_member:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 创建部门用户
operationId: CreateDepartmentMember
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CreateDepartmentMemberReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CreateDepartmentMemberResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 创建部门用户
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/create_organization_user:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 组织架构导入用户
operationId: CreateOrganizationUser
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CreateOrganizationUserReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.CreateOrganizationUserResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 组织架构导入用户
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/delete_department:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 删除部门
operationId: DeleteDepartment
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteDepartmentReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteDepartmentResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 删除部门
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/delete_organization_user:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 删除组织架构中某个用户
operationId: DeleteOrganizationUser
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteOrganizationUserReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteOrganizationUserResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 删除组织架构中某个用户
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/delete_user_in_department:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 删除部门中某个用户
operationId: DeleteUserInDepartment
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteUserInDepartmentReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.DeleteUserInDepartmentResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 删除部门中某个用户
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/get_department_member:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 获取部门中所有成员
operationId: GetDepartmentMember
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetDepartmentMemberReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2022-06-29 18:48:17 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetDepartmentMemberResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
2022-07-01 15:36:44 +08:00
items:
$ref: '#/definitions/server_api_params.UserDepartmentMember'
type: array
2022-06-29 18:48:17 +08:00
type: object
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 获取部门中所有成员
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/get_sub_department:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 获取子部门列表
operationId: GetSubDepartment
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetSubDepartmentReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2022-07-01 15:36:44 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetSubDepartmentResp'
2022-07-01 15:36:44 +08:00
- properties:
data:
items:
$ref: '#/definitions/server_api_params.Department'
type: array
type: object
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 获取子部门列表
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/get_user_in_department:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 获取部门中的所有用户
operationId: GetUserInDepartment
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUserInDepartmentReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2022-06-29 18:48:17 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetUserInDepartmentResp'
2022-06-29 18:48:17 +08:00
- properties:
data:
$ref: '#/definitions/server_api_params.UserInDepartment'
type: object
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 获取部门中的所有用户
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/update_department:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 更新部门信息
operationId: UpdateDepartment
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UpdateDepartmentReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UpdateDepartmentResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 更新部门信息
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/update_organization_user:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 更新组织架构中的用户
operationId: UpdateOrganizationUser
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UpdateOrganizationUserReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UpdateOrganizationUserResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 更新组织架构中的用户
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
/organization/update_user_in_department:
2022-06-28 10:29:14 +08:00
post:
consumes:
- application/json
2022-06-29 18:48:17 +08:00
description: 更新部门中某个用户
operationId: UpdateUserInDepartment
2022-06-28 10:29:14 +08:00
parameters:
- description: im token
in: header
name: token
required: true
type: string
- description: 请求
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UpdateUserInDepartmentReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UpdateUserInDepartmentResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 18:48:17 +08:00
summary: 更新部门中某个用户
2022-06-28 10:29:14 +08:00
tags:
2022-06-29 18:48:17 +08:00
- 组织架构相关
2022-06-29 11:18:19 +08:00
/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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.MinioUploadFileResp'
2022-06-29 11:18:19 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-29 11:18:19 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-29 11:18:19 +08:00
summary: minio上传文件(web api)
tags:
- 第三方服务相关
2022-06-28 10:29:14 +08:00
/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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.AccountCheckReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.AccountCheckResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-28 10:29:14 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetAllUsersUidReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetAllUsersUidResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-28 10:29:14 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetSelfUserInfoReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2022-06-29 11:18:19 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetSelfUserInfoResp'
2022-06-29 11:18:19 +08:00
- properties:
data:
$ref: '#/definitions/server_api_params.UserInfo'
type: object
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-28 10:29:14 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUsersInfoReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2022-06-29 18:48:17 +08:00
allOf:
2023-01-30 16:45:40 +08:00
- $ref: '#/definitions/api_struct.GetUsersInfoResp'
2022-06-29 18:48:17 +08:00
- properties:
Data:
items:
$ref: '#/definitions/server_api_params.PublicUserInfo'
type: array
type: object
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-28 10:29:14 +08:00
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:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUsersOnlineStatusReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.GetUsersOnlineStatusResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-28 10:29:14 +08:00
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
2022-06-29 18:48:17 +08:00
- description: globalRecvMsgOpt为全局免打扰设置0为关闭 1为开启
2022-06-28 10:29:14 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SetGlobalRecvMessageOptReq'
2022-06-28 10:29:14 +08:00
produces:
- application/json
responses:
"0":
description: ""
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.SetGlobalRecvMessageOptResp'
2022-06-28 10:29:14 +08:00
"400":
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-28 10:29:14 +08:00
"500":
description: errCode为500 一般为服务器内部错误
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-28 10:29:14 +08:00
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: 请求体
2022-06-24 20:29:53 +08:00
in: body
name: req
required: true
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UpdateSelfUserInfoReq'
2022-06-24 20:29:53 +08:00
produces:
- application/json
2022-06-24 17:45:33 +08:00
responses:
2022-06-24 20:29:53 +08:00
"0":
description: ""
2022-06-24 17:45:33 +08:00
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.UpdateUserInfoResp'
2022-06-24 17:45:33 +08:00
"400":
2022-06-24 20:29:53 +08:00
description: errCode为400 一般为参数输入错误, token未带上等
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger400Resp'
2022-06-24 20:29:53 +08:00
"500":
description: errCode为500 一般为服务器内部错误
2022-06-24 17:45:33 +08:00
schema:
2023-01-30 16:45:40 +08:00
$ref: '#/definitions/api_struct.Swagger500Resp'
2022-06-24 20:29:53 +08:00
summary: 修改用户信息
2022-06-24 17:45:33 +08:00
tags:
2022-06-28 10:29:14 +08:00
- 用户相关
2022-06-24 17:45:33 +08:00
swagger: "2.0"