MobPush REST API的推送 API之批量推送

调用验证

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

频率控制

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

调用地址

POST http://api.push.mob.com/v3/push/createMulti

推送对象

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

字段	类型	必须	说明
pushWork	object	是	推送任务无需设置 pushTarget
pushWork.source	string	是	枚举值 webapi, upsapi, sdkapi, devplat 选择一个
pushWork.appkey	string	是	Mob-appkey
pushWork.pushNotify	object	是	推送展示细节配置
pushWork.pushNotify.plats	number []	是	1：android 2：ios
pushWork.pushNotify.iosProduction	number	否	plat = 2时生效 0：测试环境 1：生产环境（默认）
pushWork.pushNotify.offlineSeconds	number	否	离线消息保存时间，默认0
pushWork.pushNotify.type	number	是	推送类型： 1通知 2自定义
pushWork.pushNotify.androidNotify	object	否	android通知消息对象
pushWork.pushNotify.androidNotify.content	string []	否	推送内容
pushWork.pushNotify.androidNotify.style	number	是	显示样式标识 0：普通通知（默认） 1：BigTextStyle通知，点击后显示大段文字内容 2：BigPictureStyle，大图模式 3：横幅通知
pushWork.pushNotify.androidNotify.warn	string	否	提醒类型： 1提示音 2震动 3指示灯注：如果多个组合则对应编号组合。如12标识为提示音+震动
pushWork.pushNotify.androidNotify.sound	string	否	自定义声音
pushWork.pushNotify.iosNotify	object	否	ios通知消息对象
pushWork.pushNotify.iosNotify.badge	number	否	角标
pushWork.pushNotify.iosNotify.badgeType	number	否	badge类型 1：绝对值，需>=0 2：增减（正数为增加，负数为减少，减到0以下会自动设为0）
pushWork.pushNotify.iosNotify.category	string	否	apns的category字段，只有IOS8及以上系统才支持此参数推送
pushWork.pushNotify.iosNotify.sound	string	否	APNs通知，通过这个字段指定声音。默认为default，即系统默认声音。如果设置为空值，则为静音。如果设置为特殊的名称，则需要你的App里配置了该声音才可以正常。
pushWork.pushNotify.iosNotify.subtitle	string	否	副标题
pushWork.pushNotify.iosNotify.slientPush	number	否	如果只携带content-available: 1,不携带任何badge，sound 和消息内容等参数，则可以不打扰用户的情况下进行内容更新等操作即为"Silent Remote Notifications"
pushWork.pushNotify.iosNotify.contentAvailable	number	否	将该键设为 1 则表示有新的可用内容。带上这个键值，意味着你的 App 在后台启动了或恢复运行了，application:didReceiveRemoteNotification:fetchCompletionHandler:被调用了
pushWork.pushNotify.iosNotify.mutableContent	number	否	需要在附加字段中配置相应参数
pushWork.pushNotify.iosNotify.attachmentType	number	否	ios富文本 0：无 1：图片 2：视频 3：音频
pushWork.pushNotify.iosNotify.attachment	string	否	ios富文本内容
pushWork.pushNotify.taskCron	number	否	是否是定时任务： 0：否（默认） 1：是
pushWork.pushNotify.taskTime	number	否	定时消息发送时间， taskCron=1时必填
pushWork.pushNotify.speed	number	否	每秒推送速度
pushWork.pushNotify.skipOnline	number	否	跳过在线设备, 不对在线设备做推送 1: 开启 0：不开启（默认）
pushWork.pushNotify.customNotify	object	否	自定义内容
pushWork.pushNotify.customNotify.customType	string	否	自定义消息类型
pushWork.pushNotify.customNotify.customTitle	string	否	自定义类型标题
pushWork.pushNotify.extrasMapList	object []	否	JSON格式例：{"key1":"value1","key2":"value2",...}
pushWork.pushFactoryExtra	object	否	厂商特殊配置
pushWork.pushFactoryExtra.xiaomiExtra	object	否	小米厂商特殊配置
pushWork.pushFactoryExtra.xiaomiExtra.channelId	string	否	小米渠道Id 适配定制化渠道
pushWork.pushFactoryExtra.vivoExtra	object	否	vivo厂商特殊配置
pushWork.pushFactoryExtra.vivoExtra.classification	string	否	VIVO消息类型 0：运营类型消息 1：系统类型消息
pushWork.pushForward	object	否	link 相关打开配置
pushWork.pushForward.url	string	否	1 link跳转 moblink功能的的uri
pushWork.pushForward.scheme	string	是	2 scheme moblink功能的的scheme
pushWork.pushForward.schemeDataList	object []	否	schema参数例：{"key1":"value1","key2":"value2",...}
pushWork.pushForward.nextType	number	否	0 打开首页 1 link跳转 2 scheme 跳转
pushWork.pushCallback	object	否	推送回调配置
pushWork.pushCallback.url	string	否	回调地址
pushWork.pushCallback.params	object	否	JSON对象自定义参数例：{"key1":"value1","key2":"value2",...}
pushWork.repate	boolean	否	是否重复推送
pushWork.parentId	string	否	repate 重复记录原始ID
pushWork.isLocal	boolean	否	isLocal:是否本地消息
pushWork.groupId	string	否	groupId: AB分组测试ID
items	object []	是	配置用于生成PushTarget的属性
items.itemId	string	是	item id（用户自自定义生成且唯一、不能重复）
items.workNo	string	否	推送任务的 workNo
items.appPackages	string []	否	包名列表
items.alias	string []	否	别名列表
items.rids	tring []	否	rid列表
items.title	string	否	推送标题,，不传则默认为应用名
items.content	string	是	推送内容

请求示例

curl --location 'http://api.push.mob.com/v3/push/createMulti' \
--header 'key: 2e08782eb311b' \
--header 'sign: ac72ae5ddc0878fc8dd2310777e24880' \
--header 'Content-Type: application/json' \
--data ' {"pushWork":{"appkey": "2e08782eb311b","pushNotify": { "iosProduction":0,"plats": [1,2],"type": 1,"extrasMapList": {"a": "avtftfytfyt","b": "v"},"offlineSeconds": 0},"pushForward": {"nextType": 2,"scheme": "mlink://com.mobpush.demo2","schemeDataList": [{"key": "aaa","value": "vvvvv"}]}},"items": [{"rids": ["65kyvwsebowmk8w"],"title": "华为7P","content": "华为内容"},{"rids": ["65kyvwsebowmk8w"],"title": "小米","content": "小米内容tp"}]}'

响应示例

请求成功

{
"status": 200,
"res": {
"batchIds": {
"1609dxtbu2n5faysfim9": "",
"1609dxtbu2n5faysfim8": ""
},
"errors": {},
"result": null
},
"error": null
}
请求失败

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

参数	类型	说明
status	number	返回码
res	object	消息体
res.batchId	string	本次推送的任务ID
error	string	返回码描述