消息终止、覆盖和撤回

一、需求背景

1.1 背景描述

APP 在进行日常消息推送的过程中，因为种种原因，有时会出现推送“失误”，比如不小心推送内容输入错误，或是测试生产环境切换错误，给线上用户推送了测试消息等等。个推消息推送的消息终止、消息覆盖和消息撤回三大功能可以有效帮助 APP 避免推送“失误”。

1.2 名称解释

1.3 功能支持情况

二、功能实现

• 终止、撤回、覆盖功能实现，客户端不用操作，服务端调用相应的api接口即可
• 终止、撤回、覆盖功能适用于通知消息
• 开发者可通过调用 服务端 RestAPI V2 实现对应的功能。

2.1 消息终止代码示例

curl --location --request DELETE 
'https://restapi.getui.com/v2/appid/task/$taskid' \
--header 'content-type: application/json' \
--header 'token: $taskid' \
--data-raw ''

注意事项

• 只支持批量推和群推任务，单推任务不支持

2.2 消息覆盖代码示例

对于个推在线通道消息，可设置相同的notify_id，示例：
{
    "push_message": {
        "notification": {
            "notify_id": 1234
        }
    }
}


对于离线厂商通道,消息覆盖示例（仅额外新增的覆盖参数，其他基础的标题、内容等参数不变），示例：
{
    "push_channel": {
        "android": {
            "ups": {
                "notification": {
                    //华为、荣耀、小米、OPPO、vivo、魅族。消息覆盖。可设置相同的notify_id
                    "notify_id": 1234
                }
            }
        },
        "ios": {
            //对于IOS离线厂商通道消息，可设置相同的apns-collapse-id
            "apns-collapse-id": "1234"
        },
        "harmony": {
            "notification": {
                //对于鸿蒙离线厂商通道消息，可设置相同的notify_id
                "notify_id": 1234
            }
        }
    }
} 

2.3 消息撤回代码示例

{
   "push_message":{
           //在线通知消息
        "revoke": {
            //需要撤回的taskId
            "old_task_id": "xxx",  
            //在没有找到对应的taskId，是否把对应appId下所有的通知都撤回
            "force": false  
        }
    },
    "push_channel": {
        "android": {
            "ups": {
                //安卓厂商离线通知消息
                "revoke": {
                    //需要撤回的taskId
                    "old_task_id": "xxx"
                }
            }
        },
        "harmony":{
            //鸿蒙厂商离线通知消息
            "revoke": {
                    //需要撤回的taskId
                    "old_task_id": "xxx"
                }
        }
    }

}

注意事项

• SDK要求客户端版本：2.12.5.0以上