이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.
Docs Overview/
Deleting Permission Group Members/

Deleting Permission Group Members

Feature Overview

App admins can call this API to delete members from permission groups.

API Calling Description

Applicable Group Types

Group Type ID
Whether This RESTful API Is Supported
Private
Not supported, same as Work (Work Friend Group) in the new version
Public
Not supported
ChatRoom
Not supported, same as Meeting (Temporary Meeting Group) in the new version
AVChatRoom
Not supported
Community
Supported
Chat provides the aforementioned group types. For details, refer to Group System.

Sample Request URL

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

Request Parameters

The table below only lists the parameters modified when calling this API and their descriptions. For details on the parameters, refer to RESTful API Overview.
Parameter
Description
xxxxxx
The dedicated domain name for 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_permission_group_member
Request API
sdkappid
SDKAppID assigned by the Chat console when an application is created
identifier
You must be an app admin account. For details, refer to App Admins.
usersig
The signature generated by the app admin account. For details, refer to Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295
contenttype
Request format fixed value: json

Maximum Calling Frequency

200 queries/sec.

Sample Request Packet

Basic Form It is used to delete members from the permission group. A maximum of 100 members can be deleted per request. By default, a system notification for the deletion of group members is sent to all members in the group. If the user to be deleted is not in the permission group, the API still returns success.
{
  "GroupId": "@TGS#_@TGS#cQVLVHIM62CJ", // Group to operate on (required)
  "PermissionGroupId":"@PMG#_@PMG#cDR",// Permission group to operate on (required)
  "MemberList": [ // Up to 100 members can be deleted at once.
  {
      "Member_Account": "tommy" // ID of the permission group member to be deleted (required)
  },
  {
      "Member_Account": "jared"
  }]
}

Description of Request Packet Fields

Field
Type
Attribute
Description
GroupId
String
Required
ID of the group to operate on
PermissionGroupId
String
Required
ID of the permission group to operate on
MemberList
Array
Required
Array of permission group members to be deleted
Member_Account
String
Required
UserID of the permission group member to be deleted

Sample Response Packet

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "MemberList": [
    {
         "Member_Account": "tommy",
         "Result": 0 // Deletion result: 0 indicates success. For other results, refer to the error code description.
    },
    {
         "Member_Account": "jared",
         "Result": 10013
    }]
}

Description of Response Packet Fields

Field
Type
Description
ActionStatus
String
Result of the request processing
OK: Indicates successful processing.
FAIL: Indicates failure.
ErrorCode
Integer
Error code
0: Indicates success.
Non-zero: Indicates failure.
ErrorInfo
String
Error message
MemberList
Array
Returned result of deleted group members
Member_Account
String
Returned group member UserID
Result
Integer
Addition result:
0: success
For other results, refer to the error codes.

Error Codes

Unless a network error (such as a 502 error) occurs, the HTTP return code for this API is always 200. The real error code and error message are indicated by ErrorCode and ErrorInfo in the response packet body. Common error codes (60000 to 79999) can be found in the Error Codes document. The private error codes for this API are as follows:
Error Code
Description
10002
Internal server error. Try again.
10003
Illegal request command word
10004
Invalid parameter. Check if the request is correct based on the error description.
10007
Insufficient operation permissions, such as lacking the permission to delete permission group members
10010
The group does not exist, or it existed in the past but has now been dissolved.
10015
Invalid group ID. Check if the group ID is filled in correctly.
10016
The developer backend has denied this operation through third-party callback.
10019
The requested UserID does not exist. Check if all Member_Accounts in the MemberList are correct.
110006
The permission group does not exist, or it existed in the past but has now been dissolved.
110008
Invalid permission group ID. Check if the permission group ID is filled in correctly.

API Debugging Tool

Use the RESTful API Online Debugging Tool to debug this API.

References

Adding Members to a Permission Group (Adding Members to a Permission Group)