please select
Docs Overview/
Chat/
Server APIs/
RESTful APIs/
Group Related/
Group Member Management/
Deleting Group Members/

Deleting Group Members

Feature Overview

This API is used by app admins to delete group members.

API Calling Description

Applicable group types

Group Type ID
RESTful API Support
Private
Yes. Same as work groups (Work) in the new version.
Public
Yes
ChatRoom
Yes. Same as meeting groups (Meeting) in the new version.
AVChatRoom
No
Community
Yes
These are the preset group types in Chat. For more information, see Group System.
Note
Audio-video groups (AVChatRoom) do not support deleting group members. If you attempt to delete members of an audio-video group, error 10004 will be returned. To achieve the effect of deleting group members, admins can batch mute and unmute group members.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/delete_group_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/group_open_http_svc/delete_group_member
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format, which should always be json.

Maximum call frequency

200 calls per second

Sample request

Basic format Used to delete group members. A single request supports deleting up to 100 group members. By default, the backend sends system notifications on the group member deletion to all group members, except for Private groups (same as Work groups in the new version) that have not been activated. Even if a user to be deleted is not in the group, the API will still return success.
{
  "GroupId": "@TGS#2J4SZEAEL", // Target group (required)
  "MemberToDel_Account": [ // List of group members to be deleted. A maximum of 100 members can be deleted.
      "tommy",
      "jared"
  ]
}
Silent deletion When Silence is set to 1, the system will not notify anyone after successfully deleting a member.
{
  "GroupId": "@TGS#2J4SZEAEL", // Target group (required)
  "Silence": 1, // Whether to delete members silently (optional)
  "MemberToDel_Account": [ // List of group members to be deleted. A maximum of 100 members can be deleted.
      "tommy",
      "jared"
  ]
}
Specifying the reason for deletion Specify the reason for deleting a user from a group, which will be reflected in the delivered notification.
{
  "GroupId": "@TGS#2J4SZEAEL", // Target group (required)
  "Reason": "kick reason", // Reason for deleting a user from a group (optional)
  "MemberToDel_Account": [ // List of group members to be deleted. A maximum of 100 members can be deleted.
      "tommy",
      "jared"
  ]
}

Request fields

Field
Type
Required
Description
GroupId
String
Yes
ID of the target group
Silence
Integer
No
Whether to adopt silent deletion. 0: No (default value); 1: Yes. Silent deletion means that no members in the group, except the deleted member, will be notified when a group member is deleted.
Reason
String
No
Reason for deleting a user from a group
MemberToDel_Account
Array
Yes
Group members to be deleted

Sample response

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode":0
}

Response fields

Field
Type
Description
ActionStatus
String
Request result. OK: Successful; FAIL: Failed
ErrorCode
Integer
Error code. 0: Successful; other values: Failed
ErrorInfo
String
Error information

Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively. For public error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API:
Error Code
Description
10002
Internal server error. Try again.
10003
Invalid command word.
10004
Invalid parameter. Check the error description and troubleshoot the issue.
10007
No operation permissions. For example, a common member in a public group tries to remove other users from the group, but only the app admin can do so.
10010
The group does not exist or has been deleted.
10015
Invalid group ID. Use the correct group ID.

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.

References

Possible Webhooks