调用QueryPushRecords接口，分页查询推送历史记录。仅支持查看最近14天的推送历史数据。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryPushRecords

系统规定参数。取值：QueryPushRecords。
AppKey Long 是 333526247

AppKey信息。
StartTime String 是 2021-09-15T02:05:24Z

查询的起始时间，UTC时间，ISO-8601格式，格式为YYYY-MM-DDThh:mm:ssZ。
EndTime String 是 2021-09-29T06:24:58Z

查询的结束时间，UTC时间，ISO-8601格式，格式为YYYY-MM-DDThh:mm:ssZ。
PushType String 否 NOTICE

推送类型。取值：

  • MESSAGE：表示消息。
  • NOTICE：表示通知。
Target String 否 DEVICE

推送目标：

  • DEVICE：根据设备推送。
  • ACCOUNT：根据账号推送。
  • ALIAS：根据别名推送。
  • TAG：根据标签推送。
  • ALL：推送给全部设备。
  • TBD：初始化持续推送，推送目标由后续的ContinuouslyPush接口指定。
Source String 否 API

推送来源。可取值：

  • API：OpenAPI发起的推送，含OpenAPI平台控制台发起的推送。
  • CONSOLE：通过移动推送控制台推送。
Keyword String 否 统计数据测试通知805

关键字，系统对推送的title和body进行了中文分词，使用分词进行查询，非子字符串匹配查询。
NextToken String 否 FFPpkmhCPm*****************xjk=

废弃参数，不再使用。
PageSize Integer 否 10

每页的条目数量，默认值为20, 最大为100。
Page Integer 否 8

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

返回数据

名称 类型 示例值 描述
NextToken String i91D***********kXIh/dVBEQ==

废弃参数，不再使用。
PageSize Integer 20

每页的条目数量。
RequestId String 9B24B396-249D-55E4-8CA1-66C9B50BB734

请求id。
Total Integer 193

记录总条数。
Page Integer 11

推送记录的当前页数。
PushInfos Array of PushInfo

具体通知/消息的详情。
PushInfo
Status String SENT

消息状态。可取值：

  • WAITING：等待中。
  • SENT：已推送。
  • CANCELED：已取消。
MessageId String 510431

消息ID。
AppKey Long 333526247

AppKey信息。
DeviceType String ANDROID

设备类型。取值：

  • ALL：所有类型。
  • IOS：iOS设备。
  • ANDROID：Android设备。
PushType String NOTICE

推送类型。取值：

  • MESSAGE：消息。
  • NOTICE：通知。
Body String abcd

推送的body字段。
Title String sssss

推送的title字段。
Source String DEVICE

推送源类型。可取值：

  • API：OpenAPI发起的推送，含OpenAPI平台控制台发起的推送。
  • CONSOLE：通过移动推送控制台推送。
PushTime String 2021-09-15T02:05:24Z

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

推送目标：

  • ACCOUNT：根据账号推送。
  • ALIAS：根据别名推送。
  • DEVICE：根据设备推送。
  • TAG：根据标签推送。
  • ALL：推送给全部设备。
  • TBD：初始化持续推送，推送目标由后续的ContinuouslyPush接口指定。

示例

请求示例

http(s)://[Endpoint]/?Action=QueryPushRecords
&AppKey=23419851
&StartTime=2022-12-31T16:00:00Z
&EndTime=2023-01-01T16:00:00Z
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryPushRecordsResponse>
    <Page>1</Page>
    <PageSize>20</PageSize>
    <PushInfos>
        <PushInfo>
            <AppKey>23419851</AppKey>
            <Body>云智能测试推送内容</Body>
            <DeviceType>ANDROID</DeviceType>
            <MessageId>60**************</MessageId>
            <PushTime>2023-01-01T08:12:34Z</PushTime>
            <PushType>NOTICE</PushType>
            <Source>API</Source>
            <Status>SENT</Status>
            <Target>DEVICE</Target>
            <Title>通知标题</Title>
        </PushInfo>
    </PushInfos>
    <RequestId>DCA3F8E3-8D6A-5492-B059-48F56B022D8E</RequestId>
    <Total>1</Total>
</QueryPushRecordsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Page" : 1,
  "PageSize" : 20,
  "PushInfos" : {
    "PushInfo" : [ {
      "AppKey" : 23419851,
      "Body" : "云智能测试推送内容",
      "DeviceType" : "ANDROID",
      "MessageId" : "60**************",
      "PushTime" : "2023-01-01T08:12:34Z",
      "PushType" : "NOTICE",
      "Source" : "API",
      "Status" : "SENT",
      "Target" : "DEVICE",
      "Title" : "通知标题"
    } ]
  },
  "RequestId" : "DCA3F8E3-8D6A-5492-B059-48F56B022D8E",
  "Total" : 1
}

错误码

HttpCode 错误码 错误信息 描述
400 AccountDisabled Your account is not enabled. 功能未启用。
500 InternalError The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket. 服务端错误，建议重试，仍然失败则提工单

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