查询账号属性 - 即时通信

请求参数

Path 参数

account_id

string

必需

需要查询的云信账号 ID。

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://open.yunxinapi.com/im/v2/accounts/' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢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服务器错误