数据查询
查询用户状态
功能说明
查询设备在线状态
接口说明
请求地址：https://push.safe.baidu.com/push/api/open/v1/device/status
请求方法：POST
请求
请求示例
curl -X POST \
'http://push.safe.baidu.com/push/api/open/v1/device/status?appkey=10001&sign=a4196376da5f792394a0510431cb6dd5×tamp=1543314608' \
-H 'Content-Type: application/json' \
-d '{
"push_ids":["push_id1","push_id2"]
}'响应
响应示例
{
"request_id": 1148935963,
"code": 0,
"result": {
"push_id1": {
"status": "offline",
"last_online_time": 1543893955,
},
"push_id2": {
"status": "invalid"
}
}
}参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| request_id | int64 | 用于异常排查 |
| code | int | 错误码 |
| message | string | 错误说明 |
| result | json object | 设备状态信息，key为设备id |
| result内包含以下字段 | ||
| status | string | 设备状态，可枚举值如下：“invalid”:设备无效，该id可能未注册。“online”:在线。“offline”:离线 |
| last_online_time | int | 秒级别时间戳，最后在线时间 |
错误码请参考全局错误码
查询送达状态
功能说明
查询特定推送消息是否已送达到一组设备
接口说明
请求地址：https://push.safe.baidu.com/push/api/open/v1/message/status
请求方法：POST
请求
请求示例
curl -X POST \
'http:// push.safe.baidu.com/push/api/open/v1/message/status?appkey=10001&sign=a4196376da5f792394a0510431cb6dd5×tamp=1543314608' \
-H 'Content-Type: application/json' \
-d '{
"push_ids":["push_id1","push_id2","push_id3"],
"msg_id":"1003"
}'参数说明
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| msg_id | 是 | string | 消息id |
| push_ids | 是 | string array | 设备id列表 |
响应
响应示例
{
"request_id": 730433995,
"code": 0,
"result": {
"push_id1": {
"status": 0
},
"push_id2": {
"status": 1
},
"push_id3": {
"status": 2
}
}
}参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| request_id | int64 | 用于异常排查 |
| code | int | 错误码 |
| message | string | 错误说明 |
| result | json object | 消息到达状态，key为设备id |
| result内包含以下字段 | ||
| status | int | 消息送达状态，可枚举值如下：0:已接收；1:未接收；2:设备id无效 |
错误码请参考全局错误码
获取具体消息推送数据
功能说明
查询消息有效可下发总数，用户点击数等结果
接口说明
请求地址：https://push.safe.baidu.com/push/api/open/v1/message/result
请求方法：POST
请求
请求示例
curl -X POST \ 'http:// push.safe.baidu.com/push/api/open/v1/message/result?appkey=1&sign=a4196376da5f792394a0510431cb6dd5×tamp=1543314608' \
-H 'Content-Type: application/json' \
-d '{
"msg_ids":["1"]
}'参数说明
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| msg_ids | 是 | string array | 消息id列表 |
响应
响应示例
{
"request_id": 1511178925,
"code": 0,
"result": [
{
"msg_id": "1",
"publish": 92967,
"arrive": 85436,
"display": 45279,
"click": 9165,
"push": {
"publish": 63276,
"arrive": 62449,
"display": 23108,
"click": 8985
}
}
]
}参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| request_id | int64 | 用于异常排查 |
| code | int | 错误码 |
| message | string | 错误说明 |
| result | json object | 统计信息 |
| result 内包含以下字段 | ||
| msg_id | string | 消息id |
| publish | int | 总下发数 |
| arrive | int | 总到达数 |
| display | int | 总展示数 |
| click | int | 总点击数 |
| push | json object | 使用慧推长连接下发的消息统计信息 |
错误码请参考全局错误码
获取单日推送数据接口
功能说明
获取应用具体某天的推送数据
接口说明
请求地址：https://push.safe.baidu.com/push/api/open/v1/app/daily/result
请求方法：POST
请求
请求示例
curl -X POST \
'http://push.safe.baidu.com/push/api/open/v1/app/daily/result?appkey=1&sign=a4196376da5f792394a0510431cb6dd5×tamp=1543314608' \
-H 'Content-Type: application/json' \
-d '{
"date":"2018-11-03"
}'参数说明
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| date | 是 | int64 | 日期格式 YYYY-MM-DD |
响应
响应示例
{
"request_id": 1320584980,
"code": 0,
"result": {
"publish": 25580,
"arrive": 25176,
"display": 8247,
"click": 3550
}
}参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| request_id | int64 | 用于异常排查 |
| code | int | 错误码 |
| message | string | 错误说明 |
| result | json object | 统计信息 |
| result 内包含以下字段 | ||
| publish | int | 总下发数 |
| arrive | int | 总到达数 |
| display | int | 总展示数 |
| click | int | 总点击数 |
错误码请参考全局错误码
定时任务查询接口
功能说明
查询定时任务的广播消息的发送状态
接口说明
请求地址：https://push.safe.baidu.com/push/api/open/v1/message/schedule
请求方法：POST
请求
请求示例
curl -X POST \
'http://127.0.0.1:8760/push/api/open/v1/message/schedule?appkey=700000126' \
-H 'Content-Type: application/json' \
-d '{
"msg_id":"1013"
}'参数说明
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
| msg_id | 是 | string | 消息id |
响应
响应示例
{
"request_id": 1216697925,
"code": 0,
"result": {
"status": 0,
"msg_id": "1013",
"create_time": 1544689046,
"push_time": 1544716800
}
}参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| request_id | int64 | 用于异常排查 |
| code | int | 错误码 |
| message | string | 错误说明 |
| result | json object | 定时任务消息状态 |
| result 内包含以下字段 | ||
| status | int | 消息下发状态，可枚举值如下：0 ：消息已保存，等待下发；1：已经下发 |
| msg_id | int | 消息id |
| create_time | int | 消息创建时间 |
| push_time | int | 定时推送时间 |
错误码请参考全局错误码
查询厂商通道配额
功能说明
厂商对推送量有限制，具体见 https://cloud.baidu.com/doc/SPP/s/0ld2v6hw5
部分厂商支持查询配额，慧推透传厂商通道配额，方便业务方灵活控制发送量
小米: https://dev.mi.com/console/doc/detail?pId=2086
oppo: https://open.oppomobile.com/new/developmentDoc/info?id=11279
vivo: https://dev.vivo.com.cn/documentCenter/doc/362#w2-98722033
接口说明
请求地址：https://push.safe.baidu.com/push/api/open/v1/app/info/platform/quota
请求方法：GET
请求
请求示例
curl -X GET \
'https://push.safe.baidu.com/push/api/open/v1/app/info/platform/quota?appkey=123456&sign=ab170e185b3a330c43fd79c4a63185c3×tamp=1681869727' 参数说明
| 参数 | 必须 | 类型 | 说明 |
|---|---|---|---|
响应
响应示例
{
"request_id":620221355,
"code":0,
"result":{
"oppo":{
"push_count":0,
"remain_count":851044,
"total_count":851044
},
"vivo":{
"groupMsgBodyCount":26356,
"marketMsgCount":527136,
"remainMarketMsgCount":527136,
"remainSysMsgCount":790704,
"sdkSubCount":674018,
"speed":3000,
"sysMsgCount":790704
},
"xiaomi":{
"day_acked":0,
"day_quota":134326
}
}}
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| request_id | int64 | 用于异常排查 |
| code | int | 错误码 |
| message | string | 错误说明 |
| result | json object | 厂商配额 |
| result 内包含以下字段 | ||
| oppo | json object | oppo 厂商配额 |
| vivo | json object | oppo 厂商配额 |
| xiaomi | json object | oppo 厂商配额 |
错误码请参考全局错误码