全部产品

查询推送列表

更新时间:2018-04-29 10:08:06

ListPushRecords

描述

查询用户app的推送记录。

请求参数

名称 类型 是否必须 描述
Action String 操作接口名称,取值:ListPushRecords
AppKey Long 查询应用的appKey
StartTime String 查询的起始时间, ISO-8601格式, 格式为 YYYY-MM-DDThh:mm:ssZ
EndTime String 查询的结束时间, ISO-8601格式, 格式为 YYYY-MM-DDThh:mm:ssZ
PushType String 查询消息的类型, MESSAGE:表示消息,NOTICE:表示通知
Page Integer 推送记录的当前页数, 默认为1
PageSize Integer 每页的条目,默认值为20, 最大为100

响应参数

名称 类型 描述
MessageInfos 复杂对象 包含消息信息MessageInfo组成的列表
Total Integer 查询到消息的总数
PageSize Integer 每页的条目
Page Integer 当前页

MessageInfo对象

名称 类型 描述
AppKey Long AppKey
AppName String 应用名称
MessageId String 消息id
Type String 推送类型
DeviceType String 设备类型
PushTime String 推送时间
Title String 推送标题
Body String 推送内容

错误码

错误代码 描述 HTTP 状态码 语义
InvalidPeriod.ExceedMonth The period between specified EndTime and StartTime exceeds 31 days. 400 查询的时间段超过了31天

示例

请求示例

  1. http://cloudpush.aliyuncs.com/?Action=ListPushRecords
  2. &AppKey=23267207
  3. &StartTime=2016-07-25T00:00:00Z
  4. &EndTime=2016-07-29T00:00:00Z
  5. &PushType=MESSAGE
  6. &Page=1
  7. &PageSize=20
  8. &<公共请求参数>

返回示例

XML格式

  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <ListPushRecordsResponse>
  3. <RequestId>9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC</RequestId>
  4. <Total>120</Total>
  5. <Page>1</Page>
  6. <PageSize>20</PageSize>
  7. <MessageInfos>
  8. <MessageInfo>
  9. <MessageId>510431</MessageId>
  10. <Type>MESSAGE</Type>
  11. <Title>test</Title>
  12. <Body>test_body</Body>
  13. <Summary>request_summary</Summary>
  14. <AppName>test_app</AppName>
  15. <AppKey>23310806</AppKey>
  16. <DeviceType>ANDROID</DeviceType>
  17. <PushTime>2018-04-24T09:39:31Z</PushTime>
  18. </MessageInfo>
  19. <MessageInfo>
  20. <MessageId>510432</MessageId>
  21. <Type>MESSAGE</Type>
  22. <Title>test</Title>
  23. <Body>test_body</Body>
  24. <Summary>request_summary</Summary>
  25. <AppName>test_app</AppName>
  26. <AppKey>23310806</AppKey>
  27. <DeviceType>ANDROID</DeviceType>
  28. <PushTime>2018-04-24T09:39:38Z</PushTime>
  29. </MessageInfo>
  30. </MessageInfos>
  31. </ListPushRecordsResponse>

JSON格式

  1. {
  2. "RequestId": "9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC",
  3. "Total": 120,
  4. "Page": 1,
  5. "PageSize": 20,
  6. "MessageInfos": [
  7. {
  8. "MessageId": "510431",
  9. "Type": "MESSAGE",
  10. "Title": "test",
  11. "Body": "test_body",
  12. "Summary": "request_summary",
  13. "AppName": "test_app",
  14. "AppKey": 23310806,
  15. "DeviceType": "ANDROID",
  16. "PushTime": "2018-04-24T09:39:31Z"
  17. },
  18. {
  19. "MessageId": "510432",
  20. "Type": "MESSAGE",
  21. "Title": "test",
  22. "Body": "test_body",
  23. "Summary": "request_summary",
  24. "AppName": "test_app",
  25. "AppKey": 23310806,
  26. "DeviceType": "ANDROID",
  27. "PushTime": "2018-04-24T09:39:38Z"
  28. }
  29. ]
  30. }