乐趣区

关于android:MobPush-推送查询API

jiezi

IP 绑定

工作台能够绑定服务器 IP 地址，未绑定之前所有 IP 均可进行 REST API 的调用，绑定后进仅绑定的 IP 才有调用权限。

设施信息查问接口

依据 RegistrationId 查问设施信息

接口地址

http://api.push.mob.com/device-v3/getById/{registrationId}

申请形式

GET

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(MobAppSecret)

申请参数：

参数名 参数类型 是否必要参数 参数阐明
registrationId String 是 设施的 registrationId

申请示例 

curl --location --request GET 'http://api.push.mob.com/device-v3/getById/65l0soev0d0b4lc' \ 
--header 'Content-Type: application/x-www-form-urlencoded' \ 
--header 'key: 2e08782eb311b' \ 
--header 'sign: 9f1bb16df0167c733eb83875dfe445db'

返回参数阐明

参数名 参数类型 参数阐明
registrationId String rid 用户客户端获取的 registrationId
tags String[] 设施标签数组
alias String 设施别名
mobile String 手机号码（用于短信补量等性能）
openPush number 是否开启推送 1：开启，0：敞开
status number 设施状态 1: 失常，3：卸载，0：删除（卸载统计未开明）

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": {
        "registrationId": "65l0soev0d0b4lc",
        "tags": [
            "TestTag2",
            "TestTag1"
        ],
        "alias": "TestAlias",
        "mobile": null,
        "openPush": 1,
        "status": 1
    },
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

依据别名查问设施信息

接口地址

http://api.push.mob.com/device-v3/getByAlias/{alias}

申请形式

GET

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(MobAppSecret)

申请参数：

参数名 参数类型 是否必要参数 参数阐明
alias String 是 设施设置的别名

申请示例 

curl --location --request GET 'http://api.push.mob.com/device-v3/getByAlias/TestAlias' \ 
--header 'Content-Type: application/x-www-form-urlencoded' \ 
--header 'key: 2e08782eb311b' \ 
--header 'sign: 9f1bb16df0167c733eb83875dfe445db'

返回参数阐明

参数名 参数类型 参数阐明
registrationId String rid 用户客户端获取的 registrationId
tags String[] 设施标签数组
alias String 设施别名
mobile String 手机号码（用于短信补量等性能）
openPush number 是否开启推送 1：开启，0：敞开
status number 设施状态 1: 失常，3：卸载，0：删除（卸载统计未开明）

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": {
        "registrationId": "65l0soev0d0b4lc",
        "tags": [
            "TestTag2",
            "TestTag1"
        ],
        "alias": "TestAlias",
        "mobile": null,
        "openPush": 1,
        "status": 1
    },
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

依据标签查看查问设施信息

接口地址

http://api.push.mob.com/device-v3/queryByTags

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请参数：

参数名 参数类型 是否必要参数 参数阐明
appkey String 是 Mob 后盾的 MobAppKey
tags String[] 是 标签数组，交加查问，须要与 rid 下的 tags 全副匹配

申请示例 

curl --location --request POST 'http://api.push.mob.com/device-v3/queryByTags' \ 
--header 'key: 2e08782eb311b' \ 
--header 'sign: adf46949ac9ba0732e966d2fb43eebf3' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{"appkey":"2e08782eb311b","tags":["TestTag2"]}'

返回参数阐明

返回阐明：目前只返回 1000 条设施相干信息

参数名 参数类型 参数阐明
registrationId String rid 用户客户端获取的 registrationId
tags String[] 设施标签数组
alias String 设施别名
mobile String 手机号码（用于短信补量等性能）
openPush number 是否开启推送 1：开启，0：敞开
status number 设施状态 1: 失常，3：卸载，0：删除（卸载统计未开明）

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": [
        {
            "registrationId": "65l0soev0d0b4lc",
            "tags": [
                "TestTag2",
                "TestTag1"
            ],
            "alias": "TestAlias",
            "mobile": null,
            "openPush": 1,
            "status": 1
        }
    ],
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

性能接口

标签设置

接口地址

http://api.push.mob.com/device-v3/updateTags

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请参数

参数名 参数类型 是否必要参数 参数阐明
appkey String 是 Mob 后盾的 MobAppKey
registrationId String 是 用户客户端口获取的 registrationId
opType number 否 操作类型：1 新增标签；2 删除标签；3 清空标签
tags String[] 否 标签数组（opType 类型为 3 时候不必传入）

申请示例 

curl --location --request POST 'http://api.push.mob.com/device-v3/updateTags' \ 
--header 'key: 2e08782eb311b' \ 
--header 'sign: 5abb496fcc0da0de1df3c377791fb1f1' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{"appkey":"2e08782eb311b","registrationId":"65l0soev0d0b4lc","opType":"1","tags":["TestTag3","TestTag4"]
}'

返回参数阐明

参数名 参数类型 参数阐明
status number satus=200 胜利
res object 临时返回为 null
error String 返回 error

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": null,
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

别名设置

接口地址

http://api.push.mob.com/device-v3/updateAlias

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请参数

参数名 参数类型 是否必要参数 参数阐明
appkey String 否 Mob 后盾的 MobAppKey
registrationId String 是 用户客户端口获取的 registrationId
alias String 否 须要设置的别名

申请示例 

curl --location --request POST 'http://api.push.mob.com/device-v3/updateAlias' \ 
--header 'key: 2e08782eb311b' \ 
--header 'sign: 5' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{"appkey":"2e08782eb311b","registrationId":"65l0soev0d0b4lc","alias":"gxdaoxinsj"}'

返回参数阐明

参数名 参数类型 参数阐明
status number satus=200 胜利
res object 临时返回 null
error String 返回 error

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": null,
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

推送工作查问接口

查问推送工作状态

接口地址

http://api.push.mob.com/v3/push/getWorkStatus

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请参数

参数名 参数类型 参数阐明
appkey String Mob 后盾的 MobAppKey
workId String 推送工作的惟一工作 id

申请示例 

curl --location --request POST 'http://api.push.mob.com/v3/push/getWorkStatus' \ 
--header 'key: 2e08782eb311b' \ 
--header 'sign: 15863cb512d9bac150cfc089cfac0b74' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{"appkey":"2e08782eb311b","workId":"1609fr73wopsdgcqli4g"}'

返回参数阐明

参数名 参数类型 阐明
status number 状态码
res string 工作状态：”发送实现“、“勾销胜利”、“创立中”、“期待发送”、“发送中”、“发送实现”、“发送失败”、“进行发送”、“已勾销”、“勾销胜利”、“已撤回”、“下发失败”
error string 报错信息 (失常状况值为 null)

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": "发送实现",
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

查问推送详情（依据 workId 查问）

接口地址

http://api.push.mob.com/v3/stats/getByWorkId

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请参数

参数名 参数类型 参数阐明
appkey String Mob 后盾的 MobAppKey
workId String 推送工作的惟一工作 id

申请示例 

curl --location --request POST 'http://api.push.mob.com/v3/stats/getByWorkId' \ 
--header 'key: 2e08782eb311b' \ 
--header 'sign: 15863cb512d9bac150cfc089cfac0b74' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{"appkey":"2e08782eb311b","workId":"1609fr73wopsdgcqli4g"}'

返回参数阐明

参数名 参数类型 阐明
status Int 状态码
res object 返回后果
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 安卓离线统计
error String 错误信息

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": {
        "workno": null,
        "id": "1609fr73wopsdgcqli4g",
        "android": {
            "fetchNum": 1,
            "deliverNum": 1,
            "deliverFailNum": 0,
            "reportNum": 1,
            "reportFailNum": 0,
            "clickNum": 0
        },
        "ios": null,
        "factory": null,
        "mobpush": {
            "fetchNum": 1,
            "deliverNum": 1,
            "deliverFailNum": 0,
            "reportNum": 1,
            "reportFailNum": 0,
            "clickNum": 0
        },
        "iostcp": null,
        "androidtcp": {
            "fetchNum": 1,
            "deliverNum": 1,
            "deliverFailNum": 0,
            "reportNum": 1,
            "reportFailNum": 0,
            "clickNum": 0
        },
        "apns": null,
        "huawei": null,
        "xiaomi": null,
        "flyme": null,
        "fcm": null,
        "oppo": null,
        "vivo": null,
        "offlineIos": null,
        "offlineAndroid": null,
        "sms": null
    },
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

查问推送详情（依据 workId 数组查问）

接口地址

http://api.push.mob.com/v3/stats/getByWorkIds

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请参数

参数名 参数类型 参数阐明
appkey String Mob 后盾的 MobAppKey
workIds String[] 推送工作 id 的数组

申请示例 

curl --location --request POST 'http://api.push.mob.com/v3/stats/getByWorkIds' \ 
--header 'key: 2e08782eb311b' \ 
--header 'sign: f5a56c1cd0c1613efe38659548aa930d' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{"appkey":"2e08782eb311b","workIds":["1609fr73wopsdgcqli4g","1609hk2tuchfl5i3l1j4"]}'

返回参数阐明

参数名 参数类型 阐明
status Int 状态码
res String[] 返回后果
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 安卓离线统计
error String 错误信息

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": [
        {
            "workno": null,
            "id": "1609fr73wopsdgcqli4g",
            "android": {
                "fetchNum": 1,
                "deliverNum": 1,
                "deliverFailNum": 0,
                "reportNum": 1,
                "reportFailNum": 0,
                "clickNum": 0
            },
            "ios": null,
            "factory": null,
            "mobpush": {
                "fetchNum": 1,
                "deliverNum": 1,
                "deliverFailNum": 0,
                "reportNum": 1,
                "reportFailNum": 0,
                "clickNum": 0
            },
            "iostcp": null,
            "androidtcp": {
                "fetchNum": 1,
                "deliverNum": 1,
                "deliverFailNum": 0,
                "reportNum": 1,
                "reportFailNum": 0,
                "clickNum": 0
            },
            "apns": null,
            "huawei": null,
            "xiaomi": null,
            "flyme": null,
            "fcm": null,
            "oppo": null,
            "vivo": null,
            "offlineIos": null,
            "offlineAndroid": null,
            "sms": null
        },
        {
            "workno": null,
            "id": "1609hk2tuchfl5i3l1j4",
            "android": {
                "fetchNum": 2,
                "deliverNum": 2,
                "deliverFailNum": 0,
                "reportNum": 1,
                "reportFailNum": 0,
                "clickNum": 0
            },
            "ios": null,
            "factory": {
                "fetchNum": 1,
                "deliverNum": 1,
                "deliverFailNum": 0,
                "reportNum": 0,
                "reportFailNum": 0,
                "clickNum": 0
            },
            "mobpush": {
                "fetchNum": 1,
                "deliverNum": 1,
                "deliverFailNum": 0,
                "reportNum": 1,
                "reportFailNum": 0,
                "clickNum": 0
            },
            "iostcp": null,
            "androidtcp": {
                "fetchNum": 1,
                "deliverNum": 1,
                "deliverFailNum": 0,
                "reportNum": 1,
                "reportFailNum": 0,
                "clickNum": 0
            },
            "apns": null,
            "huawei": {
                "fetchNum": 1,
                "deliverNum": 1,
                "deliverFailNum": 0,
                "reportNum": 0,
                "reportFailNum": 0,
                "clickNum": 0
            },
            "xiaomi": null,
            "flyme": null,
            "fcm": null,
            "oppo": null,
            "vivo": null,
            "offlineIos": null,
            "offlineAndroid": null,
            "sms": null
        }
    ],
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

查问推送详情（依据 workno 查问）

workno 为自定义工作 ID，只能查问最近 3 天的数据

接口地址

http://api.push.mob.com/v3/stats/getByWorkno

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请参数

参数名 参数类型 参数阐明
appkey String Mob 后盾的 MobAppKey
workno String 用户的推送工作 id

申请示例 

curl --location --request POST 'http://api.push.mob.com/v3/stats/getByWorkno' \ 
--header 'key: 2e08782eb311b' \ 
--header 'sign: 8ecb4cf84760efe64578a83583b324b5' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{"appkey":"2e08782eb311b","workno":"gxd123456789"}'

返回参数阐明

参数名 参数类型 阐明
status Int 状态码
res object 返回后果
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 安卓离线统计
error String 错误信息

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": {
        "workno": "gxd123456789",
        "id": "1609hg9ho7l4a1hw8pog",
        "android": {
            "fetchNum": 2,
            "deliverNum": 0,
            "deliverFailNum": 0,
            "reportNum": 0,
            "reportFailNum": 0,
            "clickNum": 0
        },
        "ios": null,
        "factory": null,
        "mobpush": null,
        "iostcp": null,
        "androidtcp": null,
        "apns": null,
        "huawei": null,
        "xiaomi": null,
        "flyme": null,
        "fcm": null,
        "oppo": null,
        "vivo": null,
        "offlineIos": null,
        "offlineAndroid": null,
        "sms": null
    },
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

查问推送详情（按日期查问）

接口地址

http://api.push.mob.com/v3/stats/getByDay

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请示例 

curl --location --request POST 'http://api.push.mob.com/v3/stats/getByDay' \ 
--header 'key: 2e08782eb311b' \ 
--header 'sign: b223342835bbb272132e8a2732c75442' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{"appkey":"2e08782eb311b","day":"20230518"}'

申请参数

参数名 参数类型 参数阐明
appkey String Mob 后盾的 MobAppKey
day String 工夫准确到小时 yyyyMMdd 例如 20200824 查问 2020 年 08 月 24 日 24 号的所有推送

返回参数阐明

参数名 参数类型 参数阐明
status Int 状态码
res object 返回后果
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 关上总次数次数
error String 谬误形容

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": {
        "appkey": "2e08782eb311b",
        "day": "20230518",
        "fetchNum": 5,
        "fetchNumAndroid": 5,
        "fetchNumIos": 0,
        "workNum": 5,
        "workNumAndroid": 5,
        "workNumIos": 0,
        "deliverNumTcp": 2,
        "reportNumTcp": 2,
        "clickNumTcp": 0,
        "deliverNum": 3,
        "deliverNumAndroid": 3,
        "deliverNumIos": 0,
        "reportNum": 2,
        "reportNumAndroid": 2,
        "reportNumIos": 0,
        "clickNum": 0,
        "clickNumAndroid": 0,
        "clickNumIos": 0,
        "apiNum": 0,
        "apiNumAndroid": 0,
        "apiNumIos": 0,
        "activeNum": 2,
        "activeNumAndroid": 2,
        "activeNumIos": 0,
        "newDeviceNum": 1,
        "newDeviceNumAndroid": 1,
        "newDeviceNumIos": 0,
        "onlineTimeAvg": 0,
        "onlineTimeAvgAndroid": 0,
        "onlineTimeAvgIos": 0,
        "onlineTimeAll": 0,
        "onlineTimeAllAndroid": 0,
        "onlineTimeAllIos": 0,
        "openAppAvg": 7,
        "openAppAvgAndroid": 7,
        "openAppAvgIos": 0,
        "openAppAll": 14,
        "openAppAllAndroid": 14,
        "openAppAllIos": 0
    },
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

查问推送详情（查问每次下发的设施信息）

注：该接口暂只反对查精准推送的推送设施详情（例如：别名、rid、别名文件推送和 rid 文件推送）

接口地址

http://api.push.mob.com/v3/stats/getByDevice

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请参数

参数名 参数类型 参数阐明
appkey String Mob 后盾的 MobAppKey
workId String 推送的工作 id
pageIndex number 页码
pageSize number 页面条数

申请示例 

curl --location --request POST 'http://api.push.mob.com/v3/stats/getByDevice' \
--header 'key: 2e08782eb311b' \
--header 'sign: f4050aef0ee25440d74119817aea42bf' \
--header 'Content-Type: application/json' \
--data-raw '{"appkey":"2e08782eb311b","workId":"1609fr73woqnm4lzptkw","pageIndex":1,"pageSize":20}'

返回参数阐明

参数名 参数类型 阐明
status Int 状态码
res object 返回后果
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 点击次数
error String 错误信息

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": {
        "totalPages": 1,
        "total": 1,
        "content": [
            {
                "id": "1609fr73woqnm4lzptkw65l0soev0d0b4lc",
                "rid": "65l0soev0d0b4lc",
                "alias": null,
                "guardId": "4ac763ec-522f-4969-9789-9b7c076116a5",
                "tag": null,
                "workId": "1609fr73woqnm4lzptkw",
                "patchId": "1609fr73woqnm4lzptkw_0_XIAOMI",
                "offline": null,
                "deliver": ["mobpush"],
                "deliverTime": [1684736743029],
                "report": ["mobpush"],
                "reportTime": [1684736743321],
                "click": null,
                "clickTime": null
            }
        ]
    },
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

依据流动工作 id 查问流动工作聚合数据

接口地址

http://api.push.mob.com/v3/stats/getActivity

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)
申请示例 
// 流动工作 id 为用户自行设置，且惟一
curl --location --request POST 'http://api.push.mob.com/v3/stats/getActivity' \
--header 'key: 2e08782eb311b' \
--header 'sign: 03ee692eb1319994970167619cb6f721' \
--header 'Content-Type: application/json' \
--data-raw '{"appkey":"2e08782eb311b","activityWorkId":"1775565980385"}'

申请参数

参数名 参数类型 参数阐明
appkey String Mob 后盾的 MobAppKey
activityWorkId String 推送的流动工作 id

返回参数阐明

参数名 参数类型 阐明
status number 200
res object[] res
appkey string Mob 的 appkey
activityWorkId string 流动工作 id
fetchNum number 指标数
deliverNum number 下发数
reportNum number 达到数
clickNum number 点击数
error String 错误信息

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": {
        "appkey": "2e08782eb311b",
        "activityWorkId": "1775565980385",
        "fetchNum": 2,
        "deliverNum": 0,
        "reportNum": 0,
        "clickNum": 0
    },
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

其余接口

校验 scheme 长度是否超过厂商限度

接口地址

http://api.push.mob.com/push/valid/schemeLength

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请参数

参数名 参数类型 参数阐明
scheme String scheme 地址
schemeDataList object[] scheme 参数
key String
value String

申请示例 

curl --location --request POST 'http://api.push.mob.com/push/valid/schemeLength' \
--header 'key: 2e08782eb311b' \
--header 'sign: 99729876f0c694a3229a965427100dec' \
--header 'Content-Type: application/json' \
--data-raw '{"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 错误信息

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": [
        {
            "channel": "xiaomi",
            "maxLength": 1024,
            "currentLength": 137,
            "tooLong": false
        },
        {
            "channel": "oppo",
            "maxLength": 2000,
            "currentLength": 104,
            "tooLong": false
        },
        {
            "channel": "vivo",
            "maxLength": 1024,
            "currentLength": 135,
            "tooLong": false
        }
    ],
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}

FileId 上传文件

注：上传的 File 保留工夫一个月，一次最多可上传 100 万 rid/ 别名

接口地址

http://api.push.mob.com/v3/push/uploadData

申请形式

POST

申请头部

参数名 参数类型 参数阐明
Content-Type application/json 必要参数
key String Mob 后盾的 MobAppKey
sign String 加密参数，加密规定为：md5(申请参数 +MobAppSecret)

申请参数

参数名 参数类型 参数阐明
appkey String AppKey
type number 1rid；2alias
uploadData string [] 上传的 rid 或者别名

申请示例 

curl --location --request POST 'http://api.push.mob.com/v3/push/uploadData' \
--header 'key: 2e08782eb311b' \
--header 'sign: 18d6c37624b203b62263d0eb5be064ce' \
--header 'Content-Type: application/json' \
--data-raw '{"appkey":"2e08782eb311b","type":1,"uploadData":["65kzjroi4idsi68","65kzmcrgi2kz85c"]}'

返回参数阐明

参数名 参数类型 阐明
status Int 状态码
res string fileId
error string 错误信息

返回示例

  • 申请胜利 
{
    "status": 200,
    "res": "823987349755592704",
    "error": null
}
  • 申请失败 
{
    "status": 5801,
    "res": null,
    "error": "数据校验失败"
}
退出移动版