删除权限组成员

功能说明

App 管理员可以通过该接口删除权限组成员。

接口调用说明

适用的群组类型

群组类型 ID
是否支持此 REST API
Private
不支持,同新版本中的 Work(好友工作群)
Public
不支持
ChatRoom
不支持,同新版本中的 Meeting(临时会议群)
AVChatRoom
不支持
Community(社群)
支持
即时通信 IM 内置上述群组类型,详情介绍请参见 群组系统

请求 URL示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
首尔: adminapikr.im.qcloud.com
法兰克福:adminapiger.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/group_open_http_svc/delete_permission_group_member
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

基础形式 用来向权限组中删除成员,一次请求最多支持删除100个成员。后台默认情况下会给群中所有成员下发删除群成员系统通知。 如果删除的用户原本就不在权限组中,该接口依然返回成功。
{
"GroupId": "@TGS#_@TGS#cQVLVHIM62CJ", // 要操作的群组(必填)
"PermissionGroupId":"@PMG#_@PMG#cDR",// 要操作的权限组(必填)
"MemberList": [ // 一次最多删除100个成员
{
"Member_Account": "tommy" // 要删除的权限组成员ID(必填)
},
{
"Member_Account": "jared"
}]
}

请求包字段说明

字段
类型
属性
说明
GroupId
String
必填
操作的群 ID
PermissionGroupId
String
必填
操作的权限组 ID
MemberList
Array
必填
待删除的权限组成员数组
Member_Account
String
必填
待删除的权限组成员 UserID

应答包体示例

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"MemberList": [
{
"Member_Account": "tommy",
"Result": 0 // 删除结果:0 为成功,其他结果可以参考错误码说明
},
{
"Member_Account": "jared",
"Result": 10013
}]
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果
OK:表示处理成功
FAIL:表示失败
ErrorCode
Integer
错误码
0:表示成功
非0:表示失败
ErrorInfo
String
错误信息
MemberList
Array
返回删除的群成员结果
Member_Account
String
返回的群成员 UserID
Result
Integer
加人结果:
0:成功
其他结果参考错误码

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
错误码
含义说明
10002
服务器内部错误,请重试
10003
请求命令字非法
10004
参数非法,请根据错误描述检查请求是否正确
10007
操作权限不足,例如没有删除权限组成员的权限
10010
群组不存在,或者曾经存在过,但是目前已经被解散
10015
群组 ID 非法,请检查群组 ID 是否填写正确
10016
开发者后台通过第三方回调拒绝本次操作
10019
请求的 UserID 不存在,请检查 MemberList 中的所有 Member_Account 是否正确
110006
权限组不存在,或者曾经存在过,但是目前已经被解散
110008
权限组 ID 非法,请检查权限组 ID 是否填写正确

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

增加权限组成员(增加权限组成员