封禁账号
PATCH
/im/v2/accounts/{account_id}/actions/disable请求参数
Path 参数
account_id
string
必需
需要刷新 Token 的云信账号 ID。
Body 参数application/json
enabled
boolean
该账号是否可用
若设为 false,则表示封禁账号。 禁用后账号无法登录,且该账号不能进行任何云信账号相关操作,调用相关接口会报错。 被禁用的账号仍计入应用账号总数。
need_kick
boolean
强制退出标记
禁用用户(enabled = false)时可配置是否在禁用的同时踢掉该用户账号。如果设置为 true,则使该账号强制退出登录。
kick_notify_extension
string
强制退出扩展
禁用用户(enabled = false)时可设置强制踢下线操作的扩展字段,可透传至客户端 SDK(v7.7.0 及以上版本才支持)
<= 256 字符
示例
{
"enabled": true
}
示例代码
返回响应
Object200(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
code
integer
状态码
200 表示请求成功。
msg
string
提示信息
请求失败时返回错误信息,请求成功时返回 "success"。
data
object
返回的 JSON数据对象
请求失败则返回空对象。
示例
{
"code": 200,
"msg": "success",
"data": {
"account_id": "123456",
"configuration": {
"enabled": false,
"p2p_chat_banned": false,
"team_chat_banned": false,
"chatroom_chat_banned": false,
"qchat_chat_banned": false,
"push_enabled_when_desktop_online": true
}
}
}
最后修改时间: 8 个月前