Skip to main content

Remove Group Member

Brief Description

  • Remove group member from the group. If the group owner needs to be removed, the group ownership needs to be transferred to another member first.

Request Method

  • post

Request URL

  • {API_ADDRESS}/group/kick_group
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"groupID": "2137448827",
"kickedUserIDs": [
"2137448827"
],
"reason": "nihao"
}
Field NameOptionalTypeDescription
groupIDRequiredstringGroup ID
kickedUserIDsRequiredarrayKicked user ID list
reasonOptionalstringRemoved reason

Success Return Example

{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means successful
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty
dataobjectGeneric data object, specific structure is below

Failure Return Example

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, specifically check the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message