接口简介

  • 本接口用于撤销已创建的推送任务
  • 只有任务类消息(type为broadcast、groupcast、filecast、customizedcast且file_id不为空),可以进行撤销操作。千帆采用的广播推送broadcast,分组推送为customizedcast,均支持撤销
  • 撤销操作首先会从服务端尝试撤销(Android消息,排队中/发送中状态可以服务端撤销;iOS消息,排队中状态可以服务端撤销);
  • 其次,针对组建版,Android SDK 4.0及以上和iOS sdk 3.0及以上,会尝试从设备端撤销已展示的消息。

接口请求说明

请求方式

POST https://{hostname}.qianfanapi.com/openapi/pushes/{id}/cancel

请求示例

curl -X POST  'https://{hostname}.qianfanapi.com/openapi/pushes/436/cancel' \
  -H 'Authorization: Bearer 5d39164d1f281' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

接口响应说明

响应示例

{
    "code": 0,
    "text": "",
    "data": [],
    "time": 1545809695
}

响应结果说明

code=0即表示已成功发出撤销请求,具体结果可以再查询推送详情中的推送任务status字段值

文档更新时间: 2019-09-10 16:19   作者:mondoc-chenyuzou