使用QueryReceiverByParam查詢收件者清單-Direct Mail-阿里雲 - Direct Mail

查詢收件者清單。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dm:QueryReceiverByParam

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNo	integer	否	(廢棄欄位，歷史原因相容保留，可以不傳值) 當前頁碼	1
PageSize	integer	否	每頁數目，預設：100 不填寫時輸出所有結果，但鑒於 PageNo 廢棄，限制 PageSize 作用不大	10
KeyWord	string	否	關鍵詞，預設所有資訊	mesh-notification
Status	integer	否	(廢棄欄位，歷史原因相容保留，可以不傳值) 列表狀態。取值： 0：正在上傳 1：上傳完成	1

返回參數

名稱	類型	描述	樣本值
	object
NextStart	string	分頁使用。如果還有更多結果，下次請求將該傳回值設定到請求中的 NextStart	6aec200853#102#1638894326#test@example.com
PageSize	integer	每頁顯示的條數。	10
RequestId	string	請求 ID	10A1AD70-E48E-476D-98D9-39BD92193837
TotalCount	integer	總數量	15
data	object
receiver	array<object>	收件者清單詳細資料
	object	詳細記錄
ReceiversAlias	string	收件者清單別名	10***@example.com
ReceiversName	string	收件者清單名稱	TKP000442-333
CreateTime	string	建立時間	2019-09-29T13:28Z
ReceiverId	string	收件者清單 ID	0c910a7143044b1e116719eb678907b3
UtcCreateTime	integer	UTC 格式的建立時間	1569734892
ReceiversStatus	string	(廢棄欄位，歷史原因相容保留，可以不傳值) 列表狀態。取值： 0：正在上傳 1：上傳完成	0
Count	string	收件者地址總數	3
Desc	string	描述	通知

樣本

正常返回樣本

JSON格式

{
  "NextStart": "6aec200853#102#1638894326#test@example.com",
  "PageSize": 10,
  "RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
  "TotalCount": 15,
  "data": {
    "receiver": [
      {
        "ReceiversAlias": "10***@example.com",
        "ReceiversName": "TKP000442-333",
        "CreateTime": "2019-09-29T13:28Z",
        "ReceiverId": "0c910a7143044b1e116719eb678907b3",
        "UtcCreateTime": 1569734892,
        "ReceiversStatus": "0",
        "Count": "3",
        "Desc": "通知"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。