该接口可以查询指定 IM 账号的完整属性信息。

调用频率

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

请求信息

请求 URL

GET https://{endpoint}/im/v2/accounts/{account_id}

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

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

路径参数

参数名称	类型	是否必选	描述
account_id	String	是	需要查询的 IM 账号 ID。

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
account_id	String	IM 账号 ID。	否
- configuration	Object	用户账号配置项。	否
enabled	Boolean	IM 账号的是否可用。禁用后账号无法登录（仍计入应用账号总数），且该账号不能进行任何 IM 账号相关操作，调用相关接口会报错。	否
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），当设备有登录记录时才支持设置，否则无法修改。	否

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "account_id": "123456",
        "configration": {
            "enabled": true,
            "p2p_muted": true,
            "team_muted": true,
            "chatroom_muted": true,
            "qchat_muted": true,
            "push_enabled_when_desktop_online": true
        }
    }
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

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