Documentation
¶
Index ¶
- func ApplicationGroupResponse(c *gin.Context)
- func CancelMuteGroup(c *gin.Context)
- func CancelMuteGroupMember(c *gin.Context)
- func CreateGroup(c *gin.Context)
- func DismissGroup(c *gin.Context)
- func GetGroupAbstractInfo(c *gin.Context)
- func GetGroupAllMemberList(c *gin.Context)
- func GetGroupMemberList(c *gin.Context)
- func GetGroupMembersInfo(c *gin.Context)
- func GetGroupsInfo(c *gin.Context)
- func GetJoinedGroupList(c *gin.Context)
- func GetJoinedSuperGroupList(c *gin.Context)
- func GetRecvGroupApplicationList(c *gin.Context)
- func GetSuperGroupsInfo(c *gin.Context)
- func GetUserReqGroupApplicationList(c *gin.Context)
- func InviteUserToGroup(c *gin.Context)
- func InviteUserToGroups(c *gin.Context)
- func JoinGroup(c *gin.Context)
- func KickGroupMember(c *gin.Context)
- func MuteGroup(c *gin.Context)
- func MuteGroupMember(c *gin.Context)
- func QuitGroup(c *gin.Context)
- func SetGroupInfo(c *gin.Context)
- func SetGroupMemberInfo(c *gin.Context)
- func SetGroupMemberNickname(c *gin.Context)
- func TransferGroupOwner(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ApplicationGroupResponse ¶
@Summary 处理加群消息 @Description 处理加群消息 @Tags 群组相关 @ID ApplicationGroupResponse @Accept json @Param token header string true "im token" @Param req body api.ApplicationGroupResponseReq true "groupID为要处理的群ID <br> fromUserID为要处理的用户ID <br> handleMsg为处理结果信息 <br> handleResult为处理结果 1为同意加群 2为拒绝加群" @Produce json @Success 0 {object} api.ApplicationGroupResponseResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/group_application_response [post]
func CancelMuteGroup ¶
@Summary 取消禁言群组 @Description 取消禁言群组 @Tags 群组相关 @ID CancelMuteGroup @Accept json @Param token header string true "im token" @Param req body api.CancelMuteGroupReq true "groupID为群组ID" @Produce json @Success 0 {object} api.CancelMuteGroupResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/cancel_mute_group [post]
func CancelMuteGroupMember ¶
@Summary 取消禁言群成员 @Description 取消禁言群成员 @Tags 群组相关 @ID CancelMuteGroupMember @Accept json @Param token header string true "im token" @Param req body api.CancelMuteGroupMemberReq true "groupID为群组ID <br> userID为要取消禁言的用户ID" @Produce json @Success 0 {object} api.CancelMuteGroupMemberResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/cancel_mute_group_member [post]
func CreateGroup ¶
@Summary 创建群组 @Description 创建群组 @Tags 群组相关 @ID CreateGroup @Accept json @Param token header string true "im token" @Param req body api.CreateGroupReq true "groupType这里填0代表普通群 <br>groupName为群名称<br> introduction为群介绍<br> notification为群公共<br>ownerUserID为群主ID <br> ex为群扩展字段 <br> memberList中对象roleLevel为群员角色,1为普通用户 2为群主 3为管理员" @Produce json @Success 0 {object} api.CreateGroupResp{data=open_im_sdk.GroupInfo} @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/create_group [post]
func DismissGroup ¶
@Summary 解散群组 @Description 解散群组 @Tags 群组相关 @ID DismissGroup @Accept json @Param token header string true "im token" @Param req body api.DismissGroupReq true "groupID为要解散的群组ID" @Produce json @Success 0 {object} api.DismissGroupResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/dismiss_group [post]
func GetGroupAbstractInfo ¶
func GetGroupAllMemberList ¶
@Summary 获取全部群成员列表 @Description 获取全部群成员列表 @Tags 群组相关 @ID GetGroupAllMemberList @Accept json @Param token header string true "im token" @Param req body api.GetGroupAllMemberReq true "GroupID为要获取群成员的群ID" @Produce json @Success 0 {object} api.GetGroupAllMemberResp{data=[]open_im_sdk.GroupMemberFullInfo} @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/get_group_all_member_list [post]
func GetGroupMemberList ¶
func GetGroupMembersInfo ¶
@Summary 获取群成员信息 @Description 获取群成员信息 @Tags 群组相关 @ID GetGroupMembersInfo @Accept json @Param token header string true "im token" @Param req body api.GetGroupMembersInfoReq true "groupID为要获取的群ID <br> memberList为要获取群成员的群ID列表" @Produce json @Success 0 {object} api.GetGroupMembersInfoResp{data=[]open_im_sdk.GroupMemberFullInfo} @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/get_group_members_info [post]
func GetGroupsInfo ¶
@Summary 通过群ID列表获取群信息 @Description 通过群ID列表获取群信息 @Tags 群组相关 @ID GetGroupsInfo @Accept json @Param token header string true "im token" @Param req body api.GetGroupInfoReq true "groupIDList为群ID列表" @Produce json @Success 0 {object} api.GetGroupInfoResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/get_groups_info [post]
func GetJoinedGroupList ¶
@Summary 获取用户加入群列表 @Description 获取用户加入群列表 @Tags 群组相关 @ID GetJoinedGroupList @Accept json @Param token header string true "im token" @Param req body api.GetJoinedGroupListReq true "fromUserID为要获取的用户ID" @Produce json @Success 0 {object} api.GetJoinedGroupListResp{data=[]open_im_sdk.GroupInfo} @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/get_joined_group_list [post]
func GetJoinedSuperGroupList ¶
func GetRecvGroupApplicationList ¶
@Summary 获取用户收到的加群信息列表 @Description 获取用户收到的加群信息列表 @Tags 群组相关 @ID GetRecvGroupApplicationList @Accept json @Param token header string true "im token" @Param req body api.GetGroupApplicationListReq true "fromUserID为要获取的用户ID" @Produce json @Success 0 {object} api.GetGroupApplicationListResp{data=[]open_im_sdk.GroupRequest} @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/get_recv_group_applicationList [post]
func GetSuperGroupsInfo ¶
func GetUserReqGroupApplicationList ¶
@Summary 获取用户加群申请列表 @Description 获取用户加群申请列表 @Tags 群组相关 @ID GetUserReqGroupApplicationList @Accept json @Param token header string true "im token" @Param req body api.GetUserReqGroupApplicationListReq true "userID为要获取的用户ID" @Produce json @Success 0 {object} api.GetGroupApplicationListResp{data=[]open_im_sdk.GroupRequest} @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/get_user_req_group_applicationList [post]
func InviteUserToGroup ¶
@Summary 将用户拉入群组 @Description 将用户拉入群组 @Tags 群组相关 @ID InviteUserToGroup @Accept json @Param token header string true "im token" @Param req body api.InviteUserToGroupReq true "groupID为要拉进的群组ID <br> invitedUserIDList为要获取群成员的群ID列表 <br> reason为原因" @Produce json @Success 0 {object} api.InviteUserToGroupResp "result为结果码, -1为失败, 0为成功"" @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/invite_user_to_group [post]
func InviteUserToGroups ¶
func JoinGroup ¶
@Summary 加入群聊 @Description 加入群聊 @Tags 群组相关 @ID JoinGroup @Accept json @Param token header string true "im token" @Param req body api.JoinGroupReq true "reqMessage为申请进群信息<br>groupID为申请的群ID" @Produce json @Success 0 {object} api.JoinGroupResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/join_group [post]
func KickGroupMember ¶
@Summary 把用户踢出群组 @Description 把用户踢出群组 @Tags 群组相关 @ID KickGroupMember @Accept json @Param token header string true "im token" @Param req body api.KickGroupMemberReq true "GroupID为要操作的群ID <br> kickedUserIDList为要踢出的群用户ID <br> reason为原因" @Produce json @Success 0 {object} api.KickGroupMemberResp "result为结果码, -1为失败, 0为成功" @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/kick_group [post]
func MuteGroup ¶
@Summary 禁言群组 @Description 禁言群组 @Tags 群组相关 @ID MuteGroup @Accept json @Param token header string true "im token" @Param req body api.MuteGroupReq true "groupID为群组ID" @Produce json @Success 0 {object} api.MuteGroupResp @Failure 500 {object} api.MuteGroupResp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.MuteGroupResp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/mute_group [post]
func MuteGroupMember ¶
@Summary 禁言群成员 @Description 禁言群成员 @Tags 群组相关 @ID MuteGroupMember @Accept json @Param token header string true "im token" @Param req body api.MuteGroupMemberReq true "groupID为群组ID <br> userID为要禁言的用户ID <br> mutedSeconds为禁言秒数" @Produce json @Success 0 {object} api.DismissGroupResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/mute_group_member [post]
func QuitGroup ¶
@Summary 当前用户退出群聊 @Description 当前用户退出群聊 @Tags 群组相关 @ID QuitGroup @Accept json @Param token header string true "im token" @Param req body api.QuitGroupReq true "groupID为要退出的群ID" @Produce json @Success 0 {object} api.QuitGroupResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/quit_group [post]
func SetGroupInfo ¶
@Summary 设置群信息 @Description 设置群信息 @Tags 群组相关 @ID SetGroupInfo @Accept json @Param token header string true "im token" @Param req body api.SetGroupInfoReq true "groupID为要修改的群ID<br>groupName为新的群名称<br>notification为群介绍 <br> introduction为群公告 <br> needVerification为加群验证 0为申请需要同意 邀请直接进 1为所有人进群需要验证，除了群主管理员邀请进群 2为直接进群" @Produce json @Success 0 {object} api.SetGroupInfoResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/set_group_info [post]
func SetGroupMemberInfo ¶
@Summary 修改群成员信息 @Description 修改群成员信息 @Tags 群组相关 @ID SetGroupMemberInfo @Accept json @Param token header string true "im token" @Param req body api.SetGroupMemberInfoReq true "除了operationID, userID, groupID其他参数可选<br>ex为拓展字段<br>faceURL为群头像<br>nickName为群昵称<br>roleLevel为群员角色,1为普通用户 2为群主 3为管理员" @Produce json @Success 0 {object} api.SetGroupMemberInfoResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/set_group_member_info [post]
func SetGroupMemberNickname ¶
func TransferGroupOwner ¶
@Summary 转让群主 @Description 转让群主 @Tags 群组相关 @ID TransferGroupOwner @Accept json @Param token header string true "im token" @Param req body api.TransferGroupOwnerReq true "GroupID为要操作的群ID <br> oldOwnerUserID为老群主ID <br> newOwnerUserID为新群主ID" @Produce json @Success 0 {object} api.TransferGroupOwnerResp @Failure 500 {object} api.Swagger500Resp "errCode为500 一般为服务器内部错误" @Failure 400 {object} api.Swagger400Resp "errCode为400 一般为参数输入错误, token未带上等" @Router /group/transfer_group [post]
Types ¶
This section is empty.
Source Files