For certain special or important dashboards, to prevent subscription messages from being pushed when data has not been refreshed or there are other data anomalies, the product supports the ability to withdraw subscription push messages. Currently, withdrawal is implemented via an API. Users can enter parameters and call the API to withdraw the relevant Lark messages when needed. This capability is available only to dashboard administrators, subscription creators, and project administrators.

2.1 Request description #

Request URL: POST aeolus/api/v3/subscription/withdraw

2.2 Request parameters #

2.3 Request example #

{
  "subscription_id":27593, // Subscription ID
  "subscribers": [], // Specify the user list when withdrawing push messages for designated users
  "after_push_time": "07:01:01" // Optional, set to withdraw messages sent after the specified time on the current day
}

2.4 Response parameters #

2.5 Response example #

// When execution is successful
{
    "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": "成功"
}
// When the request ID does not have permission
{
    "code": "aeolus/user/unauthorized",
    "detail": {
        "detail": null,
        "reasons": [
            "用户无权限"
        ],
        "suggestions": []
    },
    "extra_msg": "",
    "msg": "用户无权限",
    "queryHistoryId": 0
}
// When the request fails
{
    "code": "aeolus/subscribe/subscribeWithdrawError",
    "extra_msg": {
        "code": -1,
        "msg": "不支持该类型的订阅推送撤回"
    },
    "msg": "请求订阅服务错误：不支持该类型的订阅推送撤回",
    "queryHistoryId": 0
}