消息回撤

最后更新时间:2021-08-17 17:07:27

    使用场景

    若 App 已发送的通知内容或跳转链接有误,终端用户查看或点击后会对产品有负面影响,此时需要及时处理。您可以选择终止、撤回该消息或用新消息覆盖旧消息。本文通过 控制台Rest API 两种方式为您介绍如何进行消息终止、撤回与覆盖。

    功能描述

    • 终止:终止该任务离线保存有效期内的所有离线消息。
    • 撤回:终止该消息并使已发送但未被点击或清除的通知在终端设备通知中心消失,实现无感撤回的效果。
    • 覆盖:终止该消息并用一条新通知覆盖掉当前通知。覆盖成功后,终端设备通知中心只展示新通知。

    使用限制

    平台 终止 撤回 覆盖
    安卓 支持 仅 TPNS 通道支持 仅支持 TPNS 通道、小米通道、魅族通道以及华为系统版本 EMUI10 及以上的设备
    iOS 不支持 支持
    说明
  • 当 App 进程被手动结束,则无法撤回消息。
  • “撤回消息指令”通过静默消息类型下发到设备,具有 静默消息 的特性,会唤醒应用进程,因此会导致 App 活跃数突增,建议您优先使用「覆盖」 功能。
  • 支持
    说明:

    消息终止/撤回/覆盖仅支持推送目标为「所有设备」、「批量账号」与「标签」的通知。

    控制台使用

    1. 登录 移动推送 TPNS 控制台
    2. 在左侧的菜单栏中,选择【推送管理】>【推送任务】,进入推送任务页面。
    3. 在需要终止/覆盖/撤回的推送任务处,单击【查看详情】。
    4. 在推送详情页面右上角【推送进展】一栏中,选择对该任务进行终止、覆盖或撤回操作。
      说明:

      当您选择消息覆盖时,对于不支持消息覆盖的 vivo、OPPO 以及华为系统版本 EMUI10 以下的设备,您可选择是否继续进行消息下发:

      • 若选择继续下发,则会覆盖通知,新消息和原消息会同时出现在设备的通知中心。
      • 若选择不下发,则对上述不支持覆盖的设备不下发新通知。
    5. 操作成功后,可返回【推送任务】页面,在状态一栏查看该任务当前状态。

    Rest API 使用

    消息终止

    接口说明

    请求方式:POST
    请求地址:

    服务地址/v3/push/stop_push_msg
    

    接口服务地址与服务接入点一一对应,请选择与您的应用服务接入点对应的 服务地址

    请求参数

    参数名 类型 是否必须 参数说明
    pushId string 推送任务的任务 ID

    请求示例

    {
        "pushid":"43214535"
    }
    

    消息撤回

    接口说明

    请求方式:POST
    请求地址:

    服务地址/v3/push/revoke_push_msg
    

    接口服务地址与服务接入点一一对应,请选择与您的应用服务接入点对应的 服务地址

    说明:

    撤回消息会默认终止该推送任务的离线消息下发。

    请求参数

    参数名 类型 是否必须 参数说明
    pushId string 推送任务的任务 ID

    请求示例

    {
        "pushid":"150032"
    }
    

    消息覆盖

    步骤1:查询推送任务的 collapse_id

    调用 单个任务推送信息查询接口 ,在应答参数中获取 collapse_id,例如0001。

    步骤2:调用推送接口覆盖原推送内容

    在您调用 推送接口 时, 补充上述步骤1中获取的collapse_id,例如0001,并且可通过设置 force_collapse 字段来决定对于不支持消息覆盖的设备,是否进行消息下发。

    说明:

    覆盖消息会默认终止原推送任务的离线消息下发。

    推送示例

    {
       "audience_type": "all",
       "collapse_id": 0001,
      "force_collapse":false,
       "message_type": "notify",
       "message": {
           "title": "覆盖0001条消息",
           "content":"今天天气不错哦"        
       },
       "platform": "android"
    }