API 参考
在线调试

封禁账号

更新时间: 2024/05/20 11:14:48

功能描述

该接口可以封禁指定的云信账号。

禁用后账号无法登录,但是仍计入应用账号总数。禁用后的账号不能进行任何云信账号相关操作,调用相关接口会报错。

  • 出于安全目的,云信账号创建后只能封禁,不能删除。
  • 建议优先使用更新账号属性接口封禁账号。

调用频率

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

请求

URL

PATCH https://open.yunxinapi.com/im/v2/accounts/{account_id}/actions/disable

请求 Header 的参数说明请参见请求 Header

路径参数

参数名称 类型 是否必选 描述
account_id String 必选 需要封禁的云信账号 ID。

请求体参数

参数名称 类型 是否必选 描述 默认值
enabled Boolean 必填 该账号是否可用。若设为 false,则表示封禁账号。
  • 禁用后账号无法登录,且该账号不能进行任何云信账号相关操作,调用相关接口会报错。
  • 被禁用的账号仍计入应用账号总数。
  • -
    need_kick Boolean 可选 禁用用户(enabled = false)时可配置是否在禁用的同时踢掉该用户账号。如果设置为 true,则使该账号强制退出登录。 false
    kick_notify_extension String 可选 禁用用户(enabled = false)时可设置强制踢下线操作的扩展字段,可透传至客户端 SDK(v7.7.0 及以上版本才支持),长度上限 256 位字符。 -

    请求体示例

    json{
        "enabled": true,
        "need_kick": true,
        "kick_notify_extension": "notification"
    }
    

    响应

    Header

    响应 Header 的参数说明请参见响应 Header

    响应体

    参数名称 类型 描述 是否必返回
    code Integer 状态码,200 表示请求成功。
    msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
    data Object 返回的 JSON 数据对象,请求失败则返回空对象。

    响应体示例

    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
            }
        }
    }
    

    错误码

    错误码 错误码描述 错误信息示例
    200 请求成功 success
    414 参数错误 parameter error
    102404 用户不存在 account not exist
    102449 账号请求需要重试 account operation need retry
    500 服务器内部错误 internal server error
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能描述
    • 调用频率
    • 请求
    • URL
    • Header
    • 路径参数
    • 请求体参数
    • 请求体示例
    • 响应
    • Header
    • 响应体
    • 响应体示例
    • 错误码