查询推送消息
本章主要介绍如何调用接口查询应用的推送消息。
请求信息
基本信息
| 名称 | 取值 |
|---|---|
| 请求地址 | https://open.edgeros.com/openapi/v1/mobile-push |
| 请求方法 | GET |
| 参数方式 | Query |
| 请求频率 | 5 次/秒 |
请求头
| 字段名 | 类型 | 是否必填 | 示例值 | 说明 |
|---|---|---|---|---|
| Authorization | String | 是 | Bearer eyJhbGci**** | Bearer 认证 Token 传入方式，格式为“Bearer Token”，如何获取 Token，请参见 获取 Token |
请求参数
| 字段名 | 类型 | 是否必填 | 示例值 | 说明 |
|---|---|---|---|---|
| messageId | String | 否 | 831132e8-f79b-4e5e-acc0-7644d22**** | 自定义的消息 ID |
| startTime | String | 是 | 2023-11-20T18:33:43+08:00 | 查询的起始时间，遵循 rfc3339 标准格式，格式为 YYYY-MM-DDTHH:mm:ss+TIMEZONE，YYYY-MM-DD 表示年月日；T 出现在字符串中，表示 time 元素的开头；HH:mm:ss 表示时分秒；TIMEZONE 表示时区（+08:00 表示东八区时间，领先 UTC 8 小时，即北京时间） |
| endTime | String | 是 | 2023-11-21T18:33:43+08:00 | 查询的结束时间，遵循 rfc3339 标准格式，格式为 YYYY-MM-DDTHH:mm:ss+TIMEZONE，YYYY-MM-DD 表示年月日；T 出现在字符串中，表示 time 元素的开头；HH:mm:ss 表示时分秒；TIMEZONE 表示时区（+08:00 表示东八区时间，领先 UTC 8 小时，即北京时间） |
| pageNum | Integer | 是 | 1 | 推送消息的当前页数，不得小于 1 |
| pageSize | Integer | 是 | 20 | 每页的消息数量，不得小于 1，最大值为 999 |
响应信息
data 参数
| 字段名 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| list | array[message] | - | 查询的消息内容详情，请参见 list 参数说明 |
| total | Int | 80 | 消息总数 |
| pageSize | Int | 1 | 每页的消息数量 |
| pageNum | Int | 1 | 推送消息的当前页数 |
| pages | Int | 80 | 总页数 |
| hasPreviousPage | Boolean | false | 是否存在上一页，取值如下： true：存在上一页 false：首页，不存在上一页 |
| hasNextPage | Boolean | true | 是否存在下一页，取值如下： true：存在下一页 false：最后一页，不存在下一页 |
list 参数
| 字段名 | 类型 | 示例值 | 说明 |
|---|---|---|---|
| pushStatus | String | SENT_NORMALLY | 消息发送的状态，取值如下： SENT_NORMALLY：正常发送。无论爱智 App 是否在线，手机通知栏和爱智通知中心都收到原消息标题和内容 TEMPLATE_MISMATCH：消息内容与模板不匹配，请对比检查消息内容与消息模板。 此状态下，若爱智 App 离线，手机通知栏收到默认内容（标题：消息提醒，内容：你收到了一条来自爱智的消息，请前往查看），爱智通知中心收到原标题和内容；若爱智 App 在线，手机通知栏和爱智通知中心都收到原消息标题和内容 HAS_SENSITIVE_WORD：消息内容触发敏感词。手机通知栏和爱智通知中心都收到替换敏感词后的消息标题和内容 |
| messageId | String | 831132e8-f79b-4e5e-acc0-7644d22**** | 开发者发送消息时自定义的消息 ID，若没有定义，则不返回该参数 |
| pushTime | String | 2023-11-30T18:33:43+08:00 | 消息发送时间 |
| title | String | 空调打开通知 | 发送消息的标题 |
| body | String | 空调已成功打开 | 发送消息的内容 |
| titleReplacedBySensitiveWord | String | **通知 | 触发敏感词，将发送消息标题中的敏感词用 * 替换，若没有触发敏感词，则不返回该字段 |
| bodyReplacedBySensitiveWord | String | 请** | 触发敏感词，将发送消息内容中的敏感词用 * 替换，若没有触发敏感词，则不返回该字段 |
| packageName | String | com.developer.eap | 发送消息的爱智应用包名 |
| extra | String | {\"templateId\":\"00010021\"} | 自定义的额外消息内容 |
响应示例
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": {
"list": [
{
"pushStatus": "SENT_NORMALLY",
"messageId": "831132e8-f79b-4e5e-acc0-7644d22****",
"pushTime": "2023-11-30T18:20:55+08:00",
"title": "空调打开通知",
"body": "空调已成功打开",
"packageName": "com.developer.eap",
"extra": "{\"templateId\":\"00010021\"}"
}
],
"total": 80,
"pageSize": 1,
"pageNum": 1,
"pages": 80,
"hasPreviousPage": false,
"hasNextPage": true
}
}
响应错误码
| 错误码 | 含义 | 解决方案 |
|---|---|---|
| 10002 | 时间格式问题 | 只能查询 30 日内的推送消息 |
| 10003 | 时间格式问题 | 起始时间不能晚于当前时间 |
| 10004 | 时间格式问题 | 起始时间不能晚于结束时间 |
陕公网安备61019002002605号