网易云信 IM 服务端支持用户状态事件的订阅功能。该接口用于订阅指定用户的用户状态，包括在线状态，或自定义状态。每个账号最多有效订阅 3000 个账号。

• 若重复订阅后，当次订阅不生效。
• 1 分钟内单个账号不能重复订阅。

调用频率

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

请求信息

请求 URL

POST https://{endpoint}/im/v2/subscription/{account_id}

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

请求头参数

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

路径参数

参数名称	类型	是否必选	描述
account_id	String	是	订阅者账号 ID。

查询参数

参数名称	类型	是否必选	描述
duration	Long	是	订阅的有效时间，单位为秒。取值范围：60s～2592000s（30 天）

请求体参数

参数名称	类型	是否必选	描述
account_ids	Array of strings	是	发布用户状态事件的用户账号列表。单次最多操作 100 个账号。

请求体示例

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

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
- failed_list	Array of objects	订阅失败的用户账号列表。	是
account_id	String	用户账号 ID。	否
error_code	Integer	订阅失败的错误码。	否
error_msg	String	订阅失败的错误信息。	否

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "failed_list": [
            {
                "account_id": "account1",
                "error_code": 102404,
                "error_msg": "error"
            }
        ]
    }
}

错误码

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

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
119410	订阅服务未开通	Subscription service disabled
119434	订阅事件超限	Subscription event limit reached
119301	账号列表均未订阅	account ID list is not subscribed
119302	重复订阅	Repeated subscription
119303	订阅失败	Subscription failed
500	服务端内部错误	internal server error
503	服务器繁忙	server busy