设备详情接口
接口地址：http://api.push.mob.com/device-v3/getById/+registrationId
接口示例：http://api.push.mob.com/device-v3/getById/65ou4rojokauxog
请求方式：GET
接口访问频率限制：受限，参照接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | Mob后台的MobAppSecret md5(由于不需要参数所以直接对Secret进行md5) |
请求参数：无
返回参数说明
参数名 | 参数类型 | 参数说明 |
registrationId | String | rid 用户客户端获取的registrationId |
tags | String[] | 设备标签数组 |
alias | String | 设备别名 |
mobile | String | 手机号码（ 用于短信补量等功能） |
openPush | number | 是否开启推送 1：开启，0：关闭 |
status | number | 设备状态 1:正常，3：卸载，0：删除（卸载统计未开通） |
根据别名查询设备信息
接口地址：http://api.push.mob.com/device-v3/getByAlias/+alias
接口示例：http://api.push.mob.com/device-v3/getByAlias/554804
请求方式：GET
接口访问频率限制：受限，参照接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | Mob后台的MobAppSecret md5(由于不需要参数所以直接对Secret进行md5) |
请求参数：无
返回参数说明
参数名 | 参数类型 | 参数说明 |
registrationId | String | rid 用户客户端获取的registrationId |
tags | String[] | 设备标签数组 |
alias | String | 设备别名 |
mobile | String | 手机号码（ 用于短信补量等功能） |
openPush | number | 是否开启推送 1：开启，0：关闭 |
status | number | 设备状态 1:正常，3：卸载，0：删除（卸载统计未开通） |
根据标签查看查询设备信息
接口地址：http://api.push.mob.com/device-v3/queryByTags
请求方式：POST
返回说明：目前只返回1000条设备相关信息
接口访问频率限制：受限，参照接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数：
参数名 | 参数类型 | 是否必要参数 | 参数说明 |
appkey | String | 否 | Mob后台的MobAppKey |
tags | String[] | 否 | 标签数组，交集查询，需要与rid下的tags全部匹配 |
返回参数说明
参数名 | 参数类型 | 参数说明 |
registrationId | String | rid 用户客户端获取的registrationId |
tags | String[] | 设备标签数组 |
alias | String | 设备别名 |
mobile | String | 手机号码（ 用于短信补量等功能） |
openPush | number | 是否开启推送 1：开启，0：关闭 |
status | number | 设备状态 1:正常，3：卸载，0：删除（卸载统计未开通） |
设备分布接口(用于查询设备的推送是否打开或者卸载的分布情况)
接口地址：http://api.push.mob.com/device-v3/distribution
请求方式：GET
接口访问频率限制：受限，参照接口频率限制
请求头部：
参数名 | 参数类型 | 参数说明 |
key | String | Mob后台的MobAppKey |
sign | String | Mob后台的MobAppSecret md5(由于不需要参数所以直接对Secret进行md5) |
请求参数：无
返回参数说明
参数名 | 参数类型 | 参数说明 |
openPush | number | 打开推送权限设备数量 |
closePush | number | 关闭推送权限设备数量 |
uninstall | number | 卸载设备数量（功能未开通） |
新增标签 删除标签 清空标签
接口地址： http://api.push.mob.com/device-v3/updateTags
请求方式：POST
接口访问频率限制：受限，参照接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数：
参数名 | 参数类型 | 是否必要参数 | 参数说明 |
appkey | String | 是 | Mob后台的MobAppKey |
registrationId | String | 是 | 用户客户端口获取的registrationId |
opType | number | 否 | 操作类型：1新增标签；2删除标签；3清空标签 |
tags | String[] | 否 | 标签数组（opType类型为3时候不用传入） |
返回参数：
参数名 | 参数类型 | 参数说明 |
status | number | satus=200 成功 |
res | object | 暂时返回为null |
error | String | 返回error |
设置别名
接口地址：http://api.push.mob.com/device-v3/updateAlias
请求方式：POST
接口访问频率限制：受限，参照接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数：
参数名 | 参数类型 | 是否必要参数 | 参数说明 |
appkey | String | 否 | Mob后台的MobAppKey |
registrationId | String | 是 | 用户客户端口获取的registrationId |
alias | String | 否 | 需要设置的别名 |
返回参数：
参数名 | 参数类型 | 参数说明 |
status | number | satus=200 成功 |
res | object | 暂时返回null |
error | String | 返回error |
推送任务状态（根据workId查询 workId为推送任务ID）
接口地址：http://api.push.mob.com/v3/push/getWorkStatus
请求方式：POST
接口访问频率限制：受限，参照 接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数
参数名 | 参数类型 | 参数说明 |
appkey | String | Mob后台的MobAppKey |
workId | String | 推送任务的唯一任务id |
请求示例
{"appkey":"2e08782eb311b","workId":"4bp4tw9tzd1rwcczr4"}返回参数说明
参数名 | 参数类型 | 说明 |
status | number | 状态码 |
res | string | 任务状态：”发送完成“、“取消成功”、“创建中”、“等待发送”、“发送中”、“发送完成”、“发送失败”、“停止发送”、“已取消”、 “取消成功”、“已撤回”、“下发失败” |
error | string | 报错信息(正常情况值为null) |
推送详情（根据workId查询 workId为推送任务ID）
接口地址：http://api.push.mob.com/v3/stats/getByWorkId
请求方式：POST
接口访问频率限制：受限，参照 接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数
参数名 | 参数类型 | 参数说明 |
appkey | String | Mob后台的MobAppKey |
workId | String | 推送任务的唯一任务id |
请求示例
{"workId":"32ugyk7bqlm8we8","appkey":"2ecbc7bc53712"}返回参数说明
参数名 | 参数类型 | 说明 | |
status | Int | 状态码 | |
ios | object | iOS的统计可以参考下面展开参数 | |
fetchNum | int | 返回的设备数量 | |
deliverNum | int | 实际下发的设备数量 | |
deliverFailNum | int | 下发失败的数量 | |
reportNum | int | 下发后回执的数量 （iOS回执不准确或者为0仅供参考） | |
reportFailNum | int | 下发后回执失败的数量 | |
clickNum | int | 点击通知的数量 | |
android | object | 安卓的统计可以参考上面iOS展开参数 | |
factory | object | 通过厂商和APNS下发的统计 参考同上 | |
mobpush | object | 通过MobPush通道下发的统计 参考同上 | |
iostcp | object | 通过MobPush通道下发iOS的统计 参考同上 | |
androidtcp | object | 通过MobPush通道下发Android的统计 参考同上 | |
apns | object | 通过APNS下发的统计 参考同上 | |
huawei | object | 通过华为厂商下发的统计 参考同上 | |
xiaomi | object | 通过小米厂商下发的统计 参考同上 | |
flyme | object | 通过魅族厂商下发的统计 参考同上 | |
fcm | object | 通过谷歌厂商下发的统计 参考同上 | |
oppo | object | 通过oppo厂商下发的统计 参考同上 | |
vivo | object | 通过vivo厂商下发的统计 参考同上 | |
sms | object | 短信补量下发统计 | |
offlineIos | object | iOS离线统计 | |
offlineAndroid | object | 安卓离线统计 |
推送详情（根据workId数组查询 workId为推送任务ID）
接口地址：http://api.push.mob.com/v3/stats/getByWorkIds
请求方式：POST
接口访问频率限制：受限，参照 接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数
参数名 | 参数类型 | 参数说明 |
appkey | String | Mob后台的MobAppKey |
workIds | String[] | 推送任务id的数组 |
请求示例
{"workIds":["32ugyk7bqlm8we8","32ugykg7590v56o"],"appkey":"2ecbc7bc53712"}返回参数说明
参数名 | 参数类型 | 说明 | |
status | Int | 状态码 | |
ios | object | iOS的统计可以参考下面展开参数 | |
fetchNum | int | 返回的设备数量 | |
deliverNum | int | 实际下发的设备数量 | |
deliverFailNum | int | 下发失败的数量 | |
reportNum | int | 下发后回执的数量 （iOS回执不准确或者为0仅供参考） | |
reportFailNum | int | 下发后回执失败的数量 | |
clickNum | int | 点击通知的数量 | |
android | object | 安卓的统计可以参考上面iOS展开参数 | |
factory | object | 通过厂商和APNS下发的统计 参考同上 | |
mobpush | object | 通过MobPush通道下发的统计 参考同上 | |
iostcp | object | 通过MobPush通道下发iOS的统计 参考同上 | |
androidtcp | object | 通过MobPush通道下发Android的统计 参考同上 | |
apns | object | 通过APNS下发的统计 参考同上 | |
huawei | object | 通过华为厂商下发的统计 参考同上 | |
xiaomi | object | 通过小米厂商下发的统计 参考同上 | |
flyme | object | 通过魅族厂商下发的统计 参考同上 | |
fcm | object | 通过谷歌厂商下发的统计 参考同上 | |
oppo | object | 通过oppo厂商下发的统计 参考同上 | |
vivo | object | 通过vivo厂商下发的统计 参考同上 | |
sms | object | 短信补量下发统计 | |
offlineIos | object | iOS离线统计 | |
offlineAndroid | object | 安卓离线统计 |
推送详情（根据workno查询 workno为自定义任务ID，只能查询最近3天的数据）
接口地址： http://api.push.mob.com/v3/stats/getByWorkno
请求方式：POST
接口访问频率限制：受限，参照 接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数
参数名 | 参数类型 | 参数说明 |
appkey | String | Mob后台的MobAppKey |
workno | String | 用户的推送任务id |
返回参数请参考3.1根据任务id查询的返回参数说明
推送详情（按小时查询）
接口地址： http://api.push.mob.com/v3/stats/getByHour
请求方式：POST
接口访问频率限制：受限，参照 接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数
参数名 | 参数类型 | 参数说明 |
appkey | String | Mob后台的MobAppKey |
hour | String | 时间精确到小时yyyyMMddHH 例如2020082415 查询2020年08月24日 15点钟的所有推送 |
请求示例
{"hour":"2020082415","appkey":"2ecbc7bc53712"}返回参数说明
参数名 | 参数类型 | 参数说明 |
appkey | String | Mob后台的MobAppKey |
fetchNum | number | 总设备数 |
fetchNumAndroid | number | 安卓的设备数量 |
fetchNumIos | number | iOS的推送设备数量 |
workNum | number | 推送任务数量 |
workNumAndroid | number | 推送给安卓的任务数量 |
workNumIos | number | 推送给iOS的任务数量 |
deliverNumTcp | number | 通过TCP通道（MobTech的通道）下发的数量 |
reportNumTcp | number | TCP回调的数量 |
clickNumTcp | number | TCP通道点击通知的数量 |
deliverNum | number | 消息下发总数量 |
deliverNumAndroid | number | 安卓消息下发数量 |
deliverNumIos | number | iOS消息下发数量 |
reportNum | number | 推送回执数量 |
reportNumAndroid | number | 安卓推送回执数量 |
reportNumIos | number | iOS推送回执数量（iOS 下发回执不准确仅供参考也可能为0） |
clickNum | number | 推送点击数量 |
clickNumAndroid | number | 安卓推送点击数量 |
clickNumIos | number | iOS推送点击数量 |
apiNum | number | api调用次数 |
apiNumAndroid | number | 安卓api调用次数 |
apiNumIos | number | iOSapi调用次数 |
activeNum | number | 设备活跃数量 |
activeNumAndroid | number | 安卓设备活跃量 |
activeNumIos | number | iOS设备活跃数量 |
newDeviceNum | number | 新增设备数量 |
newDeviceNumAndroid | number | 新增安卓设备数量 |
newDeviceNumIos | number | 新增iOS设备数量 |
onlineTimeAvg | number | 设备平均在线时长 |
onlineTimeAvgAndroid | number | 安卓设备平均在线时长 |
onlineTimeAvgIos | number | iOS设备平均在线时长 |
onlineTimeAll | number | 设备在线总时长（优化中） |
onlineTimeAllAndroid | number | 安卓设备在线总时长（优化中） |
onlineTimeAllIos | number | iOS设备在线总时长（优化中） |
openAppAvg | number | app平均打开次数（即启动应用次数） |
openAppAvgIos | number | iOS app平均打开次数 |
openAppAvgAndroid | number | 安卓app平均打开次数 |
openAppAll | number | 设备打开app总次数 |
openAppAllAndroid | number | 安卓app 打开总次数 |
openAppAllIos | number | iOS app打开总次数次数 |
推送详情（按日期查询）
接口地址： http://api.push.mob.com/v3/stats/getByDay
请求方式：POST
接口访问频率限制：受限，参照 接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数
参数名 | 参数类型 | 参数说明 |
appkey | String | Mob后台的MobAppKey |
day | String | 时间精确到小时yyyyMMdd 例如20200824 查询2020年08月24日 24号的所有推送 |
请求示例
{"day":"20200824","appkey":"2ecbc7bc53712"}返回参数请参考3.4根据小时查询的返回参数说明
推送详情（查询每次下发的设备信息）
注：该接口暂只支持查精准推送的推送设备详情（例如：别名、rid、别名文件推送和rid文件推送）
接口地址： http://api.push.mob.com/v3/stats/getByDevice
请求方式：POST
接口访问频率限制：受限，参照 接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数
参数名 | 参数类型 | 参数说明 |
appkey | String | Mob后台的MobAppKey |
workId | String | 推送的任务id |
pageIndex | number | 页码 |
pageSize | number | 页面条数 |
请求示例
{"appkey":"2ecbc7bc53712","workId":"32ugyk7bqlm8we8","pageIndex":1,"pageSize":20}返回参数说明
参数名 | 参数类型 | 说明 | |
totalPages | number | 返回总的页数 | |
total | number | 返回设备的总数 | |
content | object[] | 返回的下发设备信息数组 | |
rid | String | 设备的绑定id 可以在客户端打印获取 | |
workId | String | 任务id | |
alias | String | 设备别名 | |
tag | String | 标签 | |
id | String | 设备id | |
patchId | String | 推送批次id（暂时是MobTech内部自己使用的字段） | |
deliver | String[] | 下发类型如["apns"] | |
deliverTime | number | 下发次数 | |
report | String[] | 下发回执类型 | |
reportTime | number | 回执次数 | |
click | String[] | 点击类型 | |
clickTime | number | 点击次数 |
根据活动任务id查询活动任务聚合数据
接口地址:http://api.push.mob.com/v3/stats/getActivity
请求方式：POST
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数
参数名 | 参数类型 | 参数说明 |
appkey | String | Mob后台的MobAppKey |
activityWorkId | String | 推送的活动任务id |
请求示例
// 活动任务id为用户自行设置，且唯一
{"appkey":"2ecbc7bc53712","activityWorkId ":"09876213123131"}返回参数说明
参数名 | 参数类型 | 说明 | |
status | number | 200 | |
res | object[] | res | |
appkey | string | Mob的appkey | |
activityWorkId | string | 活动任务id | |
fetchNum | number | 目标数 | |
deliverNum | number | 下发数 | |
reportNum | number | 到达数 | |
clickNum | number | 点击数 | |
error | null | error |
其他接口
校验scheme长度是否超过厂商限制
接口地址：http://api.push.mob.com/push/valid/schemeLength
请求方式：POST
接口访问频率限制：受限，参照 接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数
参数名 | 参数类型 | 参数说明 |
scheme | String | scheme地址 |
schemeDataList | object[] | scheme参数 |
key | String | |
value | String |
请求示例
{"scheme":"mlink://com.mob.mobpush.link","schemeDataList":[{"key":"key","value":"value"}]}返回参数说明
参数名 | 参数类型 | 说明 | |
status | Int | 状态码 | |
res | object [] | 返回值 | |
channel | string | 厂商 | |
maxLength | string | 厂商最大支持长度 | |
currentLength | string | 当前长度 | |
tooLong | boolean | 是否超长 | |
error | string | 错误信息 |
FileId上传文件
注：上传的File保存时间一个月，一次最多可上传100万rid/别名
接口地址：http://api.push.mob.com/v3/push/uploadData
请求方式：POST
接口访问频率限制：受限，参照 接口频率限制
请求头部
参数名 | 参数类型 | 参数说明 |
Content-Type | application/json | 必要参数 |
key | String | Mob后台的MobAppKey |
sign | String | 请求参数+MobAppSecret md5 |
请求参数
参数名 | 参数类型 | 参数说明 |
appkey | String | AppKey |
type | number | 1rid；2alias |
uploadData | string [] | 上传的rid或者别名 |
请求示例
{"appkey":"3159a7cd8d12f","type":1,"uploadData":["65kzjroi4idsi68","65kzmcrgi2kz85c"]}返回参数说明
参数名 | 参数类型 | 说明 | |
status | Int | 状态码 | |
res | string | fileId | |
error | string | 错误信息 |