有奖捉虫:云通信与企业服务文档专题,速来> HOT

功能说明

仅支持删除套餐包类型为 IM 体验版的账号,其他类型的账号(如:TRTC、白板、专业版、旗舰版)无法删除。
说明
具体套餐包类型,可以在 控制台 进入应用,单击基础配置 > 应用套餐包 > 套餐包进行查看。
账号删除时,该用户的关系链、资料等数据也会被删除。
账号删除后,该用户的数据将无法恢复,请谨慎使用该接口。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/im_open_login_svc/account_delete?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
孟买:adminapiind.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/im_open_login_svc/account_delete
请求接口
sdkappid
创建应用时控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

100次/秒。

请求包示例

{
"DeleteItem":
[
{
"UserID":"UserID_1"
},
{
"UserID":"UserID_2"
}
]
}

请求包字段说明

字段
类型
属性
说明
DeleteItem
Array
必填
请求删除的账号对象数组,单次请求最多支持100个账号
UserID
String
必填
请求删除的账号的 UserID

应答包体示例

{
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"ResultItem": [
{
"ResultCode": 0,
"ResultInfo": "",
"UserID": "UserID_1"
},
{
"ResultCode": 70107,
"ResultInfo": "Err_TLS_PT_Open_Login_Account_Not_Exist",
"UserID": "UserID_2"
}
]
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求的处理结果:
OK:表示处理成功
FAIL:表示失败
ErrorCode
Integer
错误码:
0:表示成功
非0:表示失败
ErrorInfo
String
请求处理失败时的错误信息
ResultItem
Array
单个账号的结果对象数组
ResultCode
Integer
单个账号的错误码:
0:表示成功
非0:表示失败
ResultInfo
String
单个账号删除失败时的错误描述信息
UserID
String
请求删除的账号的 UserID

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
错误码
含义说明
30006
清理关系链数据时服务器内部出错,请稍后重试
30007
清理关系链数据时服务器内部超时,请稍后重试
30008
并发写关系链数据触发写冲突,建议使用批量方式
40006
清理资料数据时服务器内部出错,请稍后重试
70107
请求删除的 UserID 不存在,请确认 UserID 的合法性
70169
服务端内部超时,请稍后重试
70202
服务端内部超时,请稍后重试
70402
参数非法,请检查必填字段是否填充,或者字段的填充是否符合协议要求
70403
请求失败,需要 App 管理员权限
70500
服务器内部错误,请稍后重试
71000
删除账号失败。仅支持删除体验版账号

接口调试工具

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

参考

导入单个账号(v4/im_open_login_svc/account_import
失效账号登录态(v4/im_open_login_svc/kick
查询账号在线状态( v4/openim/query_online_status