该接口用于批量查询指定 IM 账号的在线状态。

调用限制

• 单个应用默认最高调用频率请参考 频控说明。
• 仅 IM 旗舰版及以上套餐 支持使用该接口。如需使用，您可以在 网易云信控制台 上更改应用的套餐类型。

请求信息

请求 URL

POST https://{endpoint}/im/v2/users/actions/online_status

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

请求头参数

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

请求体参数

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

请求体示例

JSON{
    "account_ids": ["account1", "account2", "account3"]
}

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
- success_list	Array of objects	查询成功的用户在线状态信息列表。	否
account_id	String	IM 账号 ID。	否
- online_status	Array of objects	用户在线状态。	否
client_type	Integer	登录的客户端类型。 1：AOS。2：IOS：4：PC。16：WEB。64：MAC。65：HARMONY。	否
login_time	Long	登录时间。	否
- failed_list	Array of objects	查询失败的 IM 账号列表。	否
account_id	String	查询失败的 IM 账号 ID。	否
error_code	Integer	查询失败的错误码。	否
error_msg	String	查询失败的提示信息。	否

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "success_list": [
            {
                "account_id": "account1",
                "online_status": [
                    {
                        "login_time": 1571296813350,
                        "client_type": 16
                    },
                    {
                        "login_time": 1571296813750,
                        "client_type": 8
                    }
                ]
            },
            {
                "account_id": "account2",
                "online_status": [
                    {
                        "login_time": 1571296813350,
                        "client_type": 16
                    }
                ]
            }
        ],
        "failed_list": [
            {
                "account_id": "account1",
                "error_code": 102404,
                "error_msg": "account1 not exist"
            }
        ]
    }
}

错误码

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

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
103405	查询用户在线状态功能未开通	function is disabled
500	服务器内部错误	internal server error