Docs Overview/
Chat/
服务端 API/
RESTful 接口/
用户管理/
用户状态/
账号登录状态失效/

账号登录状态失效

功能说明

本接口适用于将 App 用户账号的登录状态（例如 UserSig）失效。 例如，开发者判断一个用户为恶意账号后，可以调用本接口将该用户当前的登录状态失效，这样用户使用历史 UserSig 登录即时通信 IM 会失败。
注意
使用该接口将用户登录状态失效后，用户如果使用重新生成的 UserSig 可以成功登录即时通信 IM，接口支持一次失效一个账号。

接口调用说明

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
https
请求协议为 HTTPS，请求方式为 POST
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/im_open_login_svc/kick
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
   "UserID":"test"
}

请求包字段说明

字段
类型
属性
说明
UserID
String
必填
用户名

应答包体示例

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

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败
ErrorInfo
String
错误信息

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
70107
请求的用户账号不存在
70169
服务端内部超时，请稍后重试
70402
参数非法，请检查必填字段是否填充，或者字段的填充是否满足协议要求
70403
请求需要 App 管理员权限
70500
服务器内部错误，请稍后重试

接口调试工具

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

参考

导入单个账号（v4/im_open_login_svc/account_import）
导入多个账号（v4/im_open_login_svc/multiaccount_import）
删除账号（v4/im_open_login_svc/account_delete）
查询账号（v4/im_open_login_svc/account_check）
查询账号在线状态（ v4/openim/query_online_status）