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	UNIX タイムスタンプ。例: 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": "List 2",
        "UtcCreateTime": 1628816320,
        "ReceiversName": "234235",
        "CreateTime": "2021-08-13T08:58:40Z",
        "ReceiversAlias": "test@example.net",
        "Count": 1
      }
    ]
  }
}