全部產品
Search
文件中心

Direct Mail:QueryReceiverByParam

更新時間:Jul 13, 2024

查詢收件者清單

描述

QueryReceiverByParam 查詢收件者清單。

請求參數

名稱

類型

是否必須

描述

Action

String

系統規定參數,取值:QueryReceiverByParam

PageSize

Integer

每頁數目,預設:10

PageNo

Integer

當前頁碼

KeyWord

String

關鍵詞,預設所有資訊

Status

Integer

投遞結果。不填,代表所有狀態。

其他請求參數,請參見公用請求參數

返回參數

名稱

類型

描述

data

Array

收件者清單詳細資料

NextStart

String

分頁使用。如果還有更多結果,下次請求將該傳回值設定到請求中的NextStart

PageSize

Integer

每頁顯示的條數。

RequestId

String

請求ID

TotalCount

Integer

總數量

data

名稱

類型

描述

ReceiverId

String

收件者清單ID

ReceiversName

String

收件者清單名稱

Count

String

收件者地址總數

ReceiversAlias

String

收件者清單別名

Desc

String

描述

ReceiversStatus

String

列表狀態(正在上傳0,上傳完成1)

CreateTime

String

建立時間,如:2021-09-28T16:40:35Z

UtcCreateTime

Long

時間戳記,如:1632818435

樣本

請求樣本

http(s)://dm.aliyuncs.com/?Action=QueryReceiverByParam
&KeyWord=''
&Status=''
&PageNo=''
&PageSize=''
&<公用請求參數>

正常返回樣本

JSON 格式

{
  "TotalCount": 9,
  "RequestId": "E6603A47-F1B4-39E2-A773-87A72F3779C4",
  "data": {
    "receiver": [
      {
        "ReceiversStatus": 0,
        "ReceiverId": "079984cfc696ce1b5bed3a43d2e6f97a",
        "Desc": "列表2",
        "UtcCreateTime": 1628816320,
        "ReceiversName": "234235",
        "CreateTime": "2021-08-13T08:58:40Z",
        "ReceiversAlias": "test@example.net",
        "Count": 1
      }
    ]
  }
}