OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse SDKs · uni-app / uni-app x
SDKsuni-app

Remove group members

OpenIM uni-app / uni-app x SDK guide for Remove group members.

Copy

An authorized owner or administrator can call kickGroupMember().

Parameters

ParameterTypeRequiredDescription
groupIDstringYesGroup from which to remove members.
reasonstringYesRemoval comment; use an empty string when no public explanation is needed.
userIDListstring[]YesMembers to remove.
import { kickGroupMember } from '@/uni_modules/unix-openim-sdk'

await kickGroupMember({ groupID, userIDList: ['user_b'], reason: 'Removed by moderator' })

This operation cannot remove the owner; transfer ownership first. The server checks whether an administrator may act on each target. Confirm this high-impact moderation action and keep private evidence out of a potentially visible reason.

Promise success means that the removal request completed. Merge later onGroupMemberDeleted events by groupID:userID or reload membership. Do not remove a target locally before a failed request.