- 제품 소개
- 구매 가이드
- 다운로드 센터
- 시나리오 솔루션
- 클라이언트 APIs
- 서버 APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- 그룹 생성 전 콜백
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- 그룹 내 발언 전 콜백
- 그룹 내 발언 후 콜백
- 그룹 만원 후 콜백
- After a Group Is Disbanded
- 그룹 정보 변경 후 콜백
- 그룹 메시지 회수 후 콜백
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- 토픽 생성 전 콜백
- 토픽 생성 후 콜백
- 토픽 해산 후 콜백
- 토픽 프로필 수정 후 콜백
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- 콘솔 가이드
- FAQ
- 협약 및 인증
- IM 정책
- 에러 코드
- 문의하기
- 제품 소개
- 구매 가이드
- 다운로드 센터
- 시나리오 솔루션
- 클라이언트 APIs
- 서버 APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- 그룹 생성 전 콜백
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- 그룹 내 발언 전 콜백
- 그룹 내 발언 후 콜백
- 그룹 만원 후 콜백
- After a Group Is Disbanded
- 그룹 정보 변경 후 콜백
- 그룹 메시지 회수 후 콜백
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- 토픽 생성 전 콜백
- 토픽 생성 후 콜백
- 토픽 해산 후 콜백
- 토픽 프로필 수정 후 콜백
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- 콘솔 가이드
- FAQ
- 협약 및 인증
- IM 정책
- 에러 코드
- 문의하기
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 |
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.comSingapore: adminapisgp.im.qcloud.comSeoul: adminapikr.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: 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 | |
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. |
예
아니오
문제 해결에 도움이 되었나요?