该接口用于取消订阅指定用户的在线状态事件。

调用频率

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

请求

URL

DELETE 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	取消订阅失败的错误信息。	否

响应体示例

json{
    "code":200,
    "msg":"ok",
    "data": {
        "failed_list": [
            {
                "account_id": "Accid1",  
                "error_code": 102404,
                "error_msg": "error"
            }
        ]    
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
500	服务端内部错误	internal server error
503	服务器繁忙	server busy