tencent cloud

Feature Description

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

API Calling Description

Applicable group types

These are the 4 built-in group types in IM. For detailed information, see the Group System.

Note：

AVChatRooms (livestreaming groups) do not support deleting group members. If you attempt to delete members of an AVChatRoom group, error 10004 will be returned. To achieve the effect of deleting 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 list below contains only the parameters commonly used when calling this API and their descriptions. For more parameters, see RESTful API Overview.

Maximum calling frequency

The maximum calling frequency is 200 calls per second.

Sample request packet

• Basic form
  Delete up to 100 group members in one request. The backend sends system deletion notifications to all group members by default, except for Private (work group for friends, same as Work in the new version) groups.
  Even if the 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 silently (optional)
   "MemberToDel_Account": [ // List of group members to be deleted. A maximum of 100 members can be deleted.
       "tommy",
       "jared"
   ]
  }
  

• Specify the reason for removal
  Specify the reason for removing a user from a group, which will be reflected in the delivered notification.

  {
   "GroupId": "@TGS#2J4SZEAEL", // Target group (required)
   "Reason": "kick reason", // Reason for removing the member from the group (optional)
   "MemberToDel_Account": [ // List of group members to be deleted. A maximum of 100 members can be deleted.
       "tommy",
       "jared"
   ]
  }
  

Request packet fields

Sample response packet body

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

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the returned HTTP status code for this API is always 200. The specific error code and details can be found in the response packet fields such as ErrorCode and ErrorInfo.
For public error codes (60000 to 79999), see Error Codes.
The list below contains error codes specific to this API:

API Debugging Tool

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

Reference

Adding a group member (v4/group_open_http_svc/add_group_member)

Possible Callbacks

Callback when a group member quits