Skip to main content

kick_group

Brief Description

  • Remove a user from the group.

Request Method

  • post

Request URL

  • http://x.x.x.x:10002/group/kick_group
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID used for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"groupID": "2137448827",
"kickedUserIDs": [
"2137448827"
],
"reason": "nihao"
}
Field NameOptionalTypeDescription
groupIDRequiredstringGroup ID
kickedUserIDsRequiredarrayList of user IDs to be removed from the group
reasonOptionalstringReason for removal from the group

Successful Response Example

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

Successful Response Parameter Description

Parameter NameTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty when no error
errDlterrDltDetailed error message
dataobjectGeneric data object, specific structure seen below

Failed Response Example

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

Failed Response Parameter Description

Parameter NameTypeDescription
errCodeintError code, refer to the global error code documentation for specifics
errMsgstringBrief error message
errDlterrDltDetailed error message