即时通信

批量查询账号信息

GET

/im/v2/accounts

请求参数

Query 参数

account_ids

string

必需

需要查询的云信账号 ID 列表，该值是由多个经过 URL 编码后的用户 ID 组成，以逗号分隔，一次最多查询 100 个账号。

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://open.yunxinapi.com/im/v2/accounts?account_ids' \
--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数据对象

必需

请求失败则返回空对象。

success_list

array [object {2}]

必需

failed_list

array [object {3}]

必需

示例

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

修改于 2024-12-25 08:34:04

查询账号属性

强制账号退出登录