该接口用于查询指定用户订阅的有效在线状态事件。

调用频率

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

请求

URL

PATCH https://open.yunxinapi.com/im/v2/subscription/{account_id}

Header

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

路径参数

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

请求体参数

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

请求体示例

json{
    "account_ids":["accid1", "accid2", "accid3"]
}

响应

Header

响应 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	查询失败的错误信息。	否
+ subscribes	Array of objects	订阅的用户账号列表。	是
account_id	String	订阅的用户账号 ID。	是
event_type	Integer	订阅的事件类型。固定为 1，表示用户在线状态事件。	是
subscribe_time	Long	订阅时间。	是
expire_time	Long	订阅过期时间。	是

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
     "failed_list": [
            {
                "account_id": "Accid1",  
                "error_code": 102404,
                "error_msg": "error"
            }
        ]
        "subscribes":
            [{
               "account_id":"fdasfasd54g2fd",
               "event_type":1,
               "expire_time":1681438980000,
               "subscribe_time":1681438980000,
            }
        ]
    }
}

错误码

错误码	错误码描述	错误信息示例
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