强制账号退出登录
更新时间: 2025/11/28 10:24:27
该接口可以将指定账号的登录设备强制踢下线(退出登录)。
功能描述
- 若指定账号的设备此时处于在线状态,则调用接口成功后,会直接将其踢下线,并且不再允许改设备自动登录该账号。
- 若指定账号的设备此时处于离线状态,则调用接口成功后,会清理其推送信息,后续不再触发离线推送。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求信息
请求 URL
POST https://{endpoint}/im/v2/accounts/{account_id}/actions/kick
请求 URL 中的 {endpoint} 代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。
请求头参数
请求 Header 的参数说明请参考 请求 Header。
路径参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
account_id |
String | 是 | 需要踢下线的 IM 账号 ID。 |
请求体参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
type |
Integer | 是 | 操作类型。
|
device_id_list |
Array of strings | 否 | 设备 ID,最多传入 20 个。 |
kick_notify_extension |
String | 否 | 强制踢下线操作的扩展字段,长度上限 256 字符。 |
请求体示例
JSON{
"type": 2,
"device_id_list": ["id1", "id2", "id3"],
"kick_notify_extension": "notification"
}
响应信息
响应头参数
响应 Header 的参数说明请参考 响应 Header。
响应体
| 参数名称 | 类型 | 说明 | 是否必返回 |
|---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
-
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
-
success_list |
Array of objects | 操作成功列表。 | - |
device_id |
String | 踢下线的设备 ID。 | 是 |
client_type |
Integer | 踢下线的设备类型。 | 是 |
consid |
String | 设备在线标识,只有被踢设备在线才有本字段。 | 否 |
login_time |
Long | 设备在线时间戳,只有被踢设备在线才有本字段。 | 否 |
-
failed_list |
Array of objects | 操作失败列表。 | - |
device_id |
String | 操作失败的设备 ID。 | 否 |
error_code |
Integer | 操作错误码。 | 否 |
error_msg |
String | 操作错误信息。 | 否 |
响应体示例
JSON{
"code": 200,
"msg": "success",
"data": {
"success_list": [
{
"consid": "21704a5**1c9857e",
"device_id": "905f2ef**1893998",
"login_time": 1753253727035,
"client_type": 65
}
],
"failed_list": [
{
"device_id": "test",
"error_code": 102301,
"error_msg": "login record not found"
}
]
}
}
错误码
本文仅列举部分业务接口错误码,完整列表请参考客户端 API 错误码。
| 错误码 | 错误码描述 | 错误信息示例 |
|---|---|---|
| 200 | 请求成功 | success |
| 414 | 参数错误 | parameter error |
| 102404 | 用户不存在 | account not exist |
| 102301 | 找不到设备登录记录 | login record not found |
| 500 | 服务器内部错误 | internal server error |
此文档是否对你有帮助?





