功能描述

该接口可以查询一批指定云信账号的属性，包括创建账号时传入的 Token 信息和账号相关配置。

如果提供的账号列表中某个账号 ID 不存在，则返回其他存在的账号 ID 的账号信息以及查询失败的账号列表。

调用频率

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

请求

URL

GET https://open.yunxinapi.com/im/v2/accounts

Header

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

查询参数

参数名称	类型	是否必选	说明	示例
account_ids	Array of strings	必选	需要查询的云信账号 ID 列表，该值是由多个经过 URL 编码后的用户 ID 组成，以逗号分隔，一次最多查询 100 个账号。如果提供的账号列表中某个账号 ID 不存在，则返回其他存在的账号 ID 的账号信息以及查询失败的账号列表。	"account1,account2,account3"

响应

Header

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
+ data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
+ success_list	Array of objects	查询成功的云信账号信息列表。	否
account_id	String	云信账号 ID。	否
+ configuration	Object	用户账号配置项。	否
enabled	Boolean	云信账号的是否可用。禁用后账号无法登录（仍计入应用账号总数），且该账号不能进行任何云信账号相关操作，调用相关接口会报错。	否
p2p_chat_banned	Boolean	单聊禁言标记。true：禁言。	否
team_chat_banned	Boolean	群聊禁言标记。true：禁言。	否
chatroom_chat_banned	Boolean	聊天室禁言标记。true：禁言。	否
qchat_chat_banned	Boolean	圈组禁言标记。true：禁言。	否
push_enabled_when_desktop_online	Boolean	桌面端在线时是否允许移动端推送（默认为 true），当设备有登录记录时才支持设置，否则无法修改。	否
+ failed_list	Array of objects	查询失败的云信账号列表。	否
account_id	String	查询失败的云信账号 ID。	否
error_code	Integer	查询失败的错误码。	否
error_msg	String	查询失败的提示信息。	否

响应体示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "success_list": [
            {
                "account_id": "123456",
                "configration": {
                    "enabled": false,
                    "p2p_chat_banned": false,
                    "team_chat_banned": false,
                    "chatroom_chat_banned": false,
                    "qchat_chat_banned": false,
                    "push_enabled_when_desktop_online": true
                }
            },
            {
                "account_id": "123456",
                "configration": {
                    "enabled": false,
                    "p2p_chat_banned": false,
                    "team_chat_banned": false,
                    "chatroom_chat_banned": false,
                    "qchat_chat_banned": false,
                    "push_enabled_when_desktop_online": true
                }
            }
        ],
        "failed_list": [
            {
                "account_id": "Accid1",
                "error_code": 102404,
                "error_msg": "account_id not exist"
            }
        ]
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
500	服务器内部错误	internal server error