MobPush推送查询API
MobPush推送查询API
设备详情接口
接口地址:
接口示例:
请求方式:GET
接口访问频率限制:受限黄瓜视频无次数限制,参照接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignStringMob后台的MobAppSecret md5(由于不需要参数所以直接对Secret进行md5)
请求参数:无
返回参数说明
参数名参数类型参数说明registrationIdStringrid 用户客户端获取的registrationIdtagsString[]设备标签数组aliasString设备别名mobileString手机号码( 用于短信补量等功能)openPushnumber是否开启推送 1:开启黄瓜视频无次数限制,0:关闭statusnumber设备状态 1:正常,3:卸载,0:删除(卸载统计未开通)
根据别名查询设备信息
接口地址:
接口示例:
请求方式:GET
接口访问频率限制:受限黄瓜视频无次数限制,参照接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignStringMob后台的MobAppSecret md5(由于不需要参数所以直接对Secret进行md5)
请求参数:无
返回参数说明
参数名参数类型参数说明registrationIdStringrid 用户客户端获取的registrationIdtagsString[]设备标签数组aliasString设备别名mobileString手机号码( 用于短信补量等功能)openPushnumber是否开启推送 1:开启黄瓜视频无次数限制,0:关闭statusnumber设备状态 1:正常,3:卸载,0:删除(卸载统计未开通)
根据标签查看查询设备信息
接口地址:
请求方式:POST
返回说明:目前只返回1000条设备相关信息
接口访问频率限制:受限黄瓜视频无次数限制,参照接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数:
参数名参数类型是否必要参数参数说明appkeyString否Mob后台的MobAppKeytagsString[]否标签数组黄瓜视频无次数限制,交集查询,需要与rid下的tags全部匹配
返回参数说明
参数名参数类型参数说明registrationIdStringrid 用户客户端获取的registrationIdtagsString[]设备标签数组aliasString设备别名mobileString手机号码( 用于短信补量等功能)openPushnumber是否开启推送 1:开启黄瓜视频无次数限制,0:关闭statusnumber设备状态 1:正常,3:卸载,0:删除(卸载统计未开通)
设备分布接口(用于查询设备的推送是否打开或者卸载的分布情况)
接口地址:
请求方式:GET
接口访问频率限制:受限黄瓜视频无次数限制,参照接口频率限制
请求头部:
参数名参数类型参数说明keyStringMob后台的MobAppKeysignStringMob后台的MobAppSecret md5(由于不需要参数所以直接对Secret进行md5)
请求参数:无
返回参数说明
参数名参数类型参数说明openPushnumber打开推送权限设备数量closePushnumber关闭推送权限设备数量uninstallnumber卸载设备数量(功能未开通)
新增标签 删除标签 清空标签
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数:
参数名参数类型是否必要参数参数说明appkeyString是Mob后台的MobAppKeyregistrationIdString是用户客户端口获取的registrationIdopTypenumber否操作类型:1新增标签;2删除标签;3清空标签tagsString[]否标签数组(opType类型为3时候不用传入)
返回参数:
参数名参数类型参数说明statusnumbersatus=200 成功resobject暂时返回为nullerrorString返回error
设置别名
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数:
参数名参数类型是否必要参数参数说明appkeyString否Mob后台的MobAppKeyregistrationIdString是用户客户端口获取的registrationIdaliasString否需要设置的别名
返回参数:
参数名参数类型参数说明statusnumbersatus=200 成功resobject暂时返回nullerrorString返回error
推送任务状态(根据workId查询 workId为推送任务ID)
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照 接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数
参数名参数类型参数说明appkeyStringMob后台的MobAppKeyworkIdString推送任务的唯一任务id
请求示例
{"appkey":"2e08782eb311b","workId":"4bp4tw9tzd1rwcczr4"}
返回参数说明
参数名参数类型说明statusnumber状态码resstring任务状态:”发送完成“、“取消成功”、“创建中”、“等待发送”、“发送中”、“发送完成”、“发送失败”、“停止发送”、“已取消”、 “取消成功”、“已撤回”、“下发失败”errorstring报错信息(正常情况值为null)
推送详情(根据workId查询 workId为推送任务ID)
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照 接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数
参数名参数类型参数说明appkeyStringMob后台的MobAppKeyworkIdString推送任务的唯一任务id
请求示例
{"workId":"32ugyk7bqlm8we8","appkey":"2ecbc7bc53712"}
返回参数说明
参数名参数类型说明statusInt状态码iosobjectiOS的统计可以参考下面展开参数fetchNumint返回的设备数量deliverNumint实际下发的设备数量deliverFailNumint下发失败的数量reportNumint下发后回执的数量 (iOS回执不准确或者为0仅供参考)reportFailNumint下发后回执失败的数量clickNumint点击通知的数量androidobject安卓的统计可以参考上面iOS展开参数factoryobject通过厂商和APNS下发的统计 参考同上mobpushobject通过MobPush通道下发的统计 参考同上iostcpobject通过MobPush通道下发iOS的统计 参考同上androidtcpobject通过MobPush通道下发Android的统计 参考同上apnsobject通过APNS下发的统计 参考同上huaweiobject通过华为厂商下发的统计 参考同上xiaomiobject通过小米厂商下发的统计 参考同上flymeobject通过魅族厂商下发的统计 参考同上fcmobject通过谷歌厂商下发的统计 参考同上oppoobject通过oppo厂商下发的统计 参考同上vivoobject通过vivo厂商下发的统计 参考同上smsobject短信补量下发统计offlineIosobjectiOS离线统计offlineAndroidobject安卓离线统计
推送详情(根据workId数组查询 workId为推送任务ID)
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照 接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数
参数名参数类型参数说明appkeyStringMob后台的MobAppKeyworkIdsString[]推送任务id的数组
请求示例
{"workIds":["32ugyk7bqlm8we8","32ugykg7590v56o"],"appkey":"2ecbc7bc53712"}
返回参数说明
参数名参数类型说明statusInt状态码iosobjectiOS的统计可以参考下面展开参数fetchNumint返回的设备数量deliverNumint实际下发的设备数量deliverFailNumint下发失败的数量reportNumint下发后回执的数量 (iOS回执不准确或者为0仅供参考)reportFailNumint下发后回执失败的数量clickNumint点击通知的数量androidobject安卓的统计可以参考上面iOS展开参数factoryobject通过厂商和APNS下发的统计 参考同上mobpushobject通过MobPush通道下发的统计 参考同上iostcpobject通过MobPush通道下发iOS的统计 参考同上androidtcpobject通过MobPush通道下发Android的统计 参考同上apnsobject通过APNS下发的统计 参考同上huaweiobject通过华为厂商下发的统计 参考同上xiaomiobject通过小米厂商下发的统计 参考同上flymeobject通过魅族厂商下发的统计 参考同上fcmobject通过谷歌厂商下发的统计 参考同上oppoobject通过oppo厂商下发的统计 参考同上vivoobject通过vivo厂商下发的统计 参考同上smsobject短信补量下发统计offlineIosobjectiOS离线统计offlineAndroidobject安卓离线统计
推送详情(根据workno查询 workno为自定义任务ID黄瓜视频无次数限制,只能查询最近3天的数据)
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照 接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数
参数名参数类型参数说明appkeyStringMob后台的MobAppKeyworknoString用户的推送任务id
返回参数请参考3.1根据任务id查询的返回参数说明
推送详情(按小时查询)
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照 接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数
参数名参数类型参数说明appkeyStringMob后台的MobAppKeyhourString时间精确到小时yyyyMMddHH 例如2020082415 查询2020年08月24日 15点钟的所有推送
请求示例
{"hour":"2020082415","appkey":"2ecbc7bc53712"}
返回参数说明
参数名参数类型参数说明appkeyStringMob后台的MobAppKeyfetchNumnumber总设备数fetchNumAndroidnumber安卓的设备数量fetchNumIosnumberiOS的推送设备数量workNumnumber推送任务数量workNumAndroidnumber推送给安卓的任务数量workNumIosnumber推送给iOS的任务数量deliverNumTcpnumber通过TCP通道(MobTech的通道)下发的数量reportNumTcpnumberTCP回调的数量clickNumTcpnumberTCP通道点击通知的数量deliverNumnumber消息下发总数量deliverNumAndroidnumber安卓消息下发数量deliverNumIosnumberiOS消息下发数量reportNumnumber推送回执数量reportNumAndroidnumber安卓推送回执数量reportNumIosnumberiOS推送回执数量(iOS 下发回执不准确仅供参考也可能为0)clickNumnumber推送点击数量clickNumAndroidnumber安卓推送点击数量clickNumIosnumberiOS推送点击数量apiNumnumberapi调用次数apiNumAndroidnumber安卓api调用次数apiNumIosnumberiOSapi调用次数activeNumnumber设备活跃数量activeNumAndroidnumber安卓设备活跃量activeNumIosnumberiOS设备活跃数量newDeviceNumnumber新增设备数量newDeviceNumAndroidnumber新增安卓设备数量newDeviceNumIosnumber新增iOS设备数量onlineTimeAvgnumber设备平均在线时长onlineTimeAvgAndroidnumber安卓设备平均在线时长onlineTimeAvgIosnumberiOS设备平均在线时长onlineTimeAllnumber设备在线总时长(优化中)onlineTimeAllAndroidnumber安卓设备在线总时长(优化中)onlineTimeAllIosnumberiOS设备在线总时长(优化中)openAppAvgnumberapp平均打开次数(即启动应用次数)openAppAvgIosnumberiOS app平均打开次数openAppAvgAndroidnumber安卓app平均打开次数openAppAllnumber设备打开app总次数openAppAllAndroidnumber安卓app 打开总次数openAppAllIosnumberiOS app打开总次数次数
推送详情(按日期查询)
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照 接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数
参数名参数类型参数说明appkeyStringMob后台的MobAppKeydayString时间精确到小时yyyyMMdd 例如20200824 查询2020年08月24日 24号的所有推送
请求示例
{"day":"20200824","appkey":"2ecbc7bc53712"}
返回参数请参考3.4根据小时查询的返回参数说明
推送详情(查询每次下发的设备信息)
注:该接口暂只支持查精准推送的推送设备详情(例如:别名、rid、别名文件推送和rid文件推送)
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照 接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数
参数名参数类型参数说明appkeyStringMob后台的MobAppKeyworkIdString推送的任务idpageIndexnumber页码pageSizenumber页面条数
请求示例
{"appkey":"2ecbc7bc53712","workId":"32ugyk7bqlm8we8","pageIndex":1,"pageSize":20}
返回参数说明
参数名参数类型说明totalPagesnumber返回总的页数totalnumber返回设备的总数contentobject[]返回的下发设备信息数组ridString设备的绑定id 可以在客户端打印获取workIdString任务idaliasString设备别名tagString标签idString设备idpatchIdString推送批次id(暂时是MobTech内部自己使用的字段)deliverString[]下发类型如["apns"]deliverTimenumber下发次数reportString[]下发回执类型reportTimenumber回执次数clickString[]点击类型clickTimenumber点击次数
根据活动任务id查询活动任务聚合数据
接口地址:
请求方式:POST
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数
参数名参数类型参数说明appkeyStringMob后台的MobAppKeyactivityWorkIdString推送的活动任务id
请求示例
// 活动任务id为用户自行设置黄瓜视频无次数限制,且唯一
{"appkey":"2ecbc7bc53712","activityWorkId ":"09876213123131"}
返回参数说明
参数名参数类型说明statusnumber200resobject[]resappkeystringMob的appkeyactivityWorkIdstring活动任务idfetchNumnumber目标数deliverNumnumber下发数reportNumnumber到达数clickNumnumber点击数errornullerror
其黄瓜视频无次数限制他接口
校验scheme长度是否超过厂商限制
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照 接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数
参数名参数类型参数说明schemeStringscheme地址schemeDataListobject[]scheme参数keyStringvalueString
请求示例
{"scheme":"mlink://com.mob.mobpush.link","schemeDataList":[{"key":"key","value":"value"}]}
返回参数说明
参数名参数类型说明statusInt状态码resobject []返回值channelstring厂商maxLengthstring厂商最大支持长度currentLengthstring当前长度tooLongboolean是否超长errorstring错误信息
FileId上传文件
注:上传的File保存时间一个月黄瓜视频无次数限制,一次最多可上传100万rid/别名
接口地址:
请求方式:POST
接口访问频率限制:受限黄瓜视频无次数限制,参照 接口频率限制
请求头部
参数名参数类型参数说明Content-Typeapplication/json必要参数keyStringMob后台的MobAppKeysignString请求参数+MobAppSecret md5
请求参数
参数名参数类型参数说明appkeyStringAppKeytypenumber1rid;2aliasuploadDatastring []上传的rid或者别名
请求示例
{"appkey":"3159a7cd8d12f","type":1,"uploadData":["65kzjroi4idsi68","65kzmcrgi2kz85c"]}
返回参数说明
参数名参数类型说明statusInt状态码resstringfileIderrorstring错误信息