更新账号属性 - 即时通信

请求参数

Path 参数

account_id

string

必需

需要更新的云信账号 ID。

示例值:

apifoxtest200

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

token

string

账号登陆密钥

可选

云信账号对应的登录密钥 Token。

如果未指定，云信会自动生成 Token，并在创建账号成功后返回。

Token 如果没有更新，将永久有效。

<= 128 字符

configuration

object

账户配置项

可选

云信账号配置项。

enabled

boolean

账号禁用标记

可选

该账号是否可用。默认可用，若设为 false，则表示禁用该账号。- 禁用后账号无法登录，且该账号不能进行任何云信账号相关操作，调用相关接口会报错。- 被禁用的账号仍计入应用账号总数。

默认值:

true

p2p_chat_banned

boolean

单聊禁言标记

可选

单聊禁言标记。true：禁言。

默认值:

false

team_chat_banned

boolean

群聊禁言标记

可选

群聊禁言标记。true：禁言。

默认值:

false

chatroom_chat_banned

boolean

聊天室禁言标记

可选

聊天室禁言标记。true：禁言。

默认值:

false

qchat_chat_banned

boolean

圈组禁言标记

可选

圈组禁言标记。true：禁言。

默认值:

false

push_enabled_when_desktop_online

boolean

桌面端在线时是否关闭移动端推送

可选

当设备有登录记录时才支持设置，否则无法修改。

默认值:

false

need_kick

boolean

强制退出标记

可选

禁用用户（configuration.enabled = false）时可配置是否在禁用的同时踢掉该用户账号。如果设置为 true，则使该账号强制退出登录。

默认值:

false

kick_notify_extension

string

强制退出扩展

可选

禁用用户（configuration.enabled = false）时可设置强制踢下线操作的扩展字段，可透传至客户端 SDK（v7.7.0 及以上版本才支持）

<= 256 字符

account_id

string

账号Id

可选

云信账号，请确保唯一性。- 若涉及字母，传参时请一律小写处理。因此以返回结果中的 account_id 为准。- 只允许字母、数字、半角下划线、@、半角点以及半角横线。

示例

{
  "token": "apifoxtest200"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/accounts/apifoxtest200' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "apifoxtest200"
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

200 表示请求成功。

msg

string

提示信息

必需

请求失败时返回错误信息，请求成功时返回 "success"。

data

object

返回的JSON数据对象

必需

请求失败则返回空对象。

account_id

string

账号Id

必需

云信账号，请确保唯一性。

若涉及字母，传参时请一律小写处理。因此以返回结果中的 account_id 为准。

只允许字母、数字、半角下划线、@、半角点以及半角横线。

>= 1 字符<= 32 字符

token

string

账号登陆密钥

可选

云信账号对应的登录密钥 Token。

如果未指定，云信会自动生成 Token，并在创建账号成功后返回。

Token 如果没有更新，将永久有效。

<= 128 字符

configuration

object

账户配置项

可选

云信账号配置项。

示例

{
  "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请求参数错误

🟢200服务器错误