调用验证

详情参见 REST API 概述的 鉴权方式 说明。

频率控制

详情参见推送限制策略的 接口限制 说明。

取消任务

调用地址

• POST api.push.mob.com/push/drop

推送对象

• 以 JSON 格式表达，表示一条推送相关的所有信息

参数	类型	必须	说明
appkey	string	是	Mob后台的MobAppKey
batchId	string	是	任务id

请求示例

curl --location --request POST 'http://api.push.mob.com/push/drop' 
--header 'Content-Type: application/json' 
--header 'key: 2e76e2e95a7ad' 
--header 'sign: fe7ad5d3f73108ac20b660bbf352ece3' 
--data-raw '{"appkey":"2e76e2e95a7ad","batchId":"2jkq3pzasp3l23hyaghs"}'

响应示例

• 请求成功

{
    "status": 200,
    "res": {
       "batchId": null,
       "code": 1,
       "status": 7,
       "errorMsg": null
    },
    "error": null
}

• 请求失败

{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

• 响应参数

参数	类型	说明
status	number	返回码
res	object	消息体
res.batchId	string	任务id
res.code	number	0  失败 1  成功
res.status	number	操作类型： 7  取消 9  撤回 10  替换
res.errorMsg	string	错误信息描述
error	string	返回码描述

撤回任务

调用地址

• POST api.push.mob.com/push/recall

推送对象

• 以 JSON 格式表达，表示一条推送相关的所有信息

参数	类型	必须	说明
appkey	string	是	Mob后台的MobAppKey
batchId	string	是	任务id

请求示例

curl --location --request POST 'http://api.push.mob.com/push/recall' \
--header 'Content-Type: application/json' \
--header 'key: 2e76e2e95a7ad' \
--header 'sign: 83f43fac22fad13a0a32dd81a626f739' \
--data-raw '{"appkey":"2e76e2e95a7ad","batchId":"2jkq3pzasp3fomi0eqyo"}'

响应示例

• 请求成功

{
    "status": 200,
    "res": {
        "batchId": "2jkq09ume37wvkd7n668",
        "code": 1,
        "status": 9,
        "errorMsg": null
    },
    "error": null
}

• 请求失败

{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

• 响应参数

参数	类型	说明
status	number	返回码
res	object	消息体
res.batchId	string	任务id
res.code	number	0  失败 1  成功
res.status	number	操作类型： 7  取消 9  撤回 10  替换
res.errorMsg	string	错误信息描述
error	string	返回码描述