针对部分特殊或重要的仪表盘，为了避免数据在并未刷新或有其他数据异常的情况下进行订阅消息的推送，产品支持订阅消息撤回的能力。目前撤回的方式通过提供接口的方式解决，用户可以在需要撤回的时候输入参数进行接口的调用来撤回相关的飞书消息。本能力仅仪表盘管理员、订阅创建者、项目管理员可使用。
注意：在您使用本文所述的接口前，请先了解调用方式，详情可阅读调用方式。

请求说明

请求地址：POST aeolus/api/v3/subscription/withdraw

请求示例

{
  "subscription_id":27593, // 订阅id
  "subscribers": [], // 需要撤回指定用户的推送时，指定用户列表
  "after_push_time": "07:01:01" // 可选，设置从当天几点之后的的消息进行撤回
}

返回示例

// 执行成功时
{
    "code": "aeolus/ok",
    "data": {
        "subscriptionId": 27594,
        "withdrawStatus": [
            {
                "errCode": 0,
                "errMsg": null,
                "messageId": "{messageId}",
                "pushEndTime": "2023-10-13T03:38:38Z",
                "pushInstanceId": ******,
                "status": "success",
                "subscriber": "xiahaitao"
            },
            {
                "errCode": 0,
                "errMsg": null,
                "messageId": "{messageId}",
                "pushEndTime": "2023-10-13T03:38:39Z",
                "pushInstanceId": ******,
                "status": "success",
                "subscriber": "xiangbowen"
            }
        ]
    },
    "msg": "成功"
}
// 请求id无权限时
{
    "code": "aeolus/user/unauthorized",
    "detail": {
        "detail": null,
        "reasons": [
            "用户无权限"
        ],
        "suggestions": []
    },
    "extra_msg": "",
    "msg": "用户无权限",
    "queryHistoryId": 0
}
//请求失败时
{
    "code": "aeolus/subscribe/subscribeWithdrawError",
    "extra_msg": {
        "code": -1,
        "msg": "不支持该类型的订阅推送撤回"
    },
    "msg": "请求订阅服务错误：不支持该类型的订阅推送撤回",
    "queryHistoryId": 0
}