QueryPushRecords - 查询推送记录

更新时间: 2024-07-17 10:42:19

分页查询推送记录,并提供一些简单的筛选能力。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppKeylong

AppKey 信息。

333526247
StartTimestring

查询的起始时间,UTC 时间,ISO-8601 格式,格式为 YYYY-MM-DDThh:mm:ssZ。

2021-09-15T02:05:24Z
EndTimestring

查询的结束时间,UTC 时间,ISO-8601 格式,格式为 YYYY-MM-DDThh:mm:ssZ。

2021-09-29T06:24:58Z
PushTypestring

推送类型。取值:

  • MESSAGE:表示消息。

  • NOTICE:表示通知。

NOTICE
Targetstring

推送目标:

  • DEVICE:根据设备推送。

  • ACCOUNT:根据账号推送。

  • ALIAS:根据别名推送。

  • TAG:根据标签推送。

  • ALL:推送给全部设备。

  • TBD:初始化持续推送,推送目标由后续的 ContinuouslyPush 接口指定。

DEVICE
Sourcestring

推送来源。可取值:

  • API:OpenAPI 发起的推送,含 OpenAPI 平台控制台发起的推送。
  • CONSOLE:通过移动推送控制台推送。
  • OpenAPIExplorer:通过阿里云 OpenAPI Explorer 平台推送。
API
Keywordstring

查询关键字,根据 MessageId、Title、Body 字段进行查询。系统对推送的 title 和 body 进行了中文分词,使用分词进行查询,非子字符串匹配查询。

统计数据测试通知805
NextTokenstring

废弃参数,不再使用。

FFPpkmhCPm*****************xjk=
PageSizeinteger

每页的条目数量,默认值为 20, 最大为 100。

10
Pageinteger

推送记录的当前页数, 默认为 1,最大 10000。

8

返回参数

名称类型描述示例值
object
NextTokenstring

废弃参数,不再使用。

i91D***********kXIh/dVBEQ==
PageSizeinteger

每页的条目数量。

20
RequestIdstring

请求 ID。

9B24B396-249D-55E4-8CA1-66C9B50BB734
Totalinteger

记录总条数。

193
Pageinteger

推送记录的当前页数。

11
PushInfosarray<object>

具体通知/消息的详情。

object
Statusstring

消息状态。可取值:

  • WAITING:等待中。

  • SENT:已推送。

  • CANCELED:已取消。

SENT
MessageIdstring

消息 ID。

510431
AppKeylong

AppKey 信息。

333526247
DeviceTypestring

设备类型。取值:

  • ALL:所有类型。

  • IOS:iOS 设备。

  • ANDROID:Android 设备。

ANDROID
PushTypestring

推送类型。取值:

  • MESSAGE:消息。

  • NOTICE:通知。

NOTICE
Bodystring

推送的 body 字段。

abcd
Titlestring

推送的 title 字段。

sssss
Sourcestring

推送源类型。可取值:

  • API:OpenAPI 发起的推送,含 OpenAPI 平台控制台发起的推送。

  • CONSOLE:通过移动推送控制台推送。

DEVICE
PushTimestring

推送时间,UTC 时间,ISO-8601 格式, 格式为 YYYY-MM-DDThh:mm:ssZ。

2021-09-15T02:05:24Z
Targetstring

推送目标:

  • ACCOUNT:根据账号推送。

  • ALIAS:根据别名推送。

  • DEVICE:根据设备推送。

  • TAG:根据标签推送。

  • ALL:推送给全部设备。

  • TBD:初始化持续推送,推送目标由后续的 ContinuouslyPush 接口指定。

DEVICE

示例

正常返回示例

JSON格式

{
  "NextToken": "i91D***********kXIh/dVBEQ==",
  "PageSize": 20,
  "RequestId": "9B24B396-249D-55E4-8CA1-66C9B50BB734",
  "Total": 193,
  "Page": 11,
  "PushInfos": {
    "PushInfo": [
      {
        "Status": "SENT",
        "MessageId": "510431",
        "AppKey": 333526247,
        "DeviceType": "ANDROID",
        "PushType": "NOTICE",
        "Body": "abcd",
        "Title": "sssss",
        "Source": "DEVICE",
        "PushTime": "2021-09-15T02:05:24Z",
        "Target": "DEVICE"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400AccountDisabledYour account is not enabled.功能未启用。
500InternalErrorThe request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.服务端错误,建议重试,仍然失败则提工单
500TimeoutThe request processing is timeout.请求处理超时。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-13OpenAPI 错误码发生变更查看变更详情
2024-01-25OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更查看变更详情
上一篇: CheckCertificate - 查询证书状态 下一篇: QueryDeviceStat - 设备新增与留存
阿里云首页 移动研发平台 相关技术圈