关于android:MobPush-推送查询API

IP绑定

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

设施信息查问接口

依据RegistrationId查问设施信息

接口地址

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

申请形式

GET

申请头部

申请参数：

申请示例

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'

返回参数阐明

返回示例

• 申请胜利

{    "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

申请头部

申请参数：

申请示例

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'

返回参数阐明

返回示例

• 申请胜利

{    "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

申请头部

申请参数：

申请示例

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条设施相干信息

返回示例

• 申请胜利

{    "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

申请头部

申请参数

申请示例

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": 200,    "res": null,    "error": null}

• 申请失败

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

别名设置

接口地址

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

申请形式

POST

申请头部

申请参数

申请示例

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": 200,    "res": null,    "error": null}

• 申请失败

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

推送工作查问接口

查问推送工作状态

接口地址

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

申请形式

POST

申请头部

申请参数

申请示例

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": 200,    "res": "发送实现",    "error": null}

• 申请失败

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

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

接口地址

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

申请形式

POST

申请头部

申请参数

申请示例

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": 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

申请头部

申请参数

申请示例

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": 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

申请头部

申请参数

申请示例

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": 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

申请头部

申请示例

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"}'

申请参数

返回参数阐明

返回示例

• 申请胜利

{    "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

申请头部

申请参数

申请示例

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": 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

申请头部

申请示例

// 流动工作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"}'

申请参数

返回参数阐明

返回示例

• 申请胜利

{    "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

申请头部

申请参数

申请示例

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": 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

申请头部

申请参数

申请示例

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": 200,    "res": "823987349755592704",    "error": null}

• 申请失败

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