本接口适用于将 App 用户帐号的登录状态(例如 UserSig)失效。
例如,开发者判断一个用户为恶意帐号后,可以调用本接口将该用户当前的登录状态失效,这样用户使用历史 UserSig 登录即时通信 IM 会失败。
注意:使用该接口将用户登录状态失效后,用户如果使用重新生成的 UserSig 可以成功登录即时通信 IM,接口支持一次失效一个帐号。
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 adminapiind.im.qcloud.com adminapiusa.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 在线调试 工具调试本接口。
本页内容是否解决了您的问题?