API 参考
在线调试

更新账号属性

更新时间: 2024/07/17 16:48:52

功能描述

该接口可以更新指定云信账号的属性,包括账号的封禁状态,禁言状态等配置信息。

  • 该接口还可以更新云信账号的密钥 Token(用户指定)。

  • 由于敏感性原因,如果未更新 Token,该接口不会返回用户的 Token 信息,只有更新了 Token,才会返回更新的 Token 信息。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

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

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

路径参数

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

请求体参数

参数名称 类型 是否必选 说明 默认值
token String 可选 用户账号对应的登录密钥 Token。
  • 若需要更新 Token,则需要传入该字段,否则不更新。
  • 长度上限 128 位字符。
  • -
    configuration Object 可选 云信账号配置项。 -
    need_kick Boolean 可选 禁用用户(configuration.enabled = false)时可配置是否在禁用的同时踢掉该用户账号。如果设置为 true,则使该账号强制退出登录。 false
    kick_notify_extension String 可选 禁用用户(configuration.enabled = false)时可设置强制踢下线操作的扩展字段,可透传至客户端 SDK(v7.7.0 及以上版本才支持),长度上限 256 位字符。 -

    请求体示例

    json{
        "token": "abcdef",
        "configuration": {
            "enabled": false,
            "p2p_chat_banned": false,
            "team_chat_banned": false,
            "chatroom_chat_banned": false,
            "qchat_chat_banned": false,
            "push_enabled_when_desktop_online": false
        },
        "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
    102301 找不到设备登录记录当设置 push_enabled_when_desktop_online 时可能发生。 login record not found
    102449 账号请求需要重试 account operation need retry
    500 服务器内部错误 internal server error
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能描述
    • 调用频率
    • 请求
    • URL
    • Header
    • 路径参数
    • 请求体参数
    • 请求体示例
    • 响应
    • Header
    • 响应体参数
    • 响应体示例
    • 错误码