getSendBlockList

Classic/VPC環境で利用できます。

特定の受信者に対して、システムで自動的に送信を遮断する基本時間を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/send-block

リクエストヘッダ

Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`size`	Integer	Optional	ページごとのレコード数 10 (デフォルト)
`page`	Integer	Optional	照会対象のページインデックス 0以上
`sort`	String	Optional	ソート基準 `createUtc` (デフォルト) `createUtc`: 作成日時 property(,asc\|desc)形式 `asc` (デフォルト) 複数のソート基準を設定可能
`targetAddress`	String	Required	送信遮断内訳を確認する受信者のメールアドレス

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/send-block?targetAddress=test01%40ncp-mail.com' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`content`	List	-	送信遮断リストの詳細 SendBlockHistoryResponseを参照
`registerStatus`	String	-	そのメールが現在送信遮断されているかどうか
`expectedDeleteDate`	Object	-	遮断解除が予定されている日時 NesDateTimeを参照
`last`	Boolean	-	最後のページであるか否か
`totalElements`	Integer	-	総レコード数
`totalPages`	Integer	-	総ページ数
`first`	Boolean	-	最初のページなのか否か
`numberOfElements`	Integer	-	現在ページのレコード数
`size`	Integer	-	ページごとのレコード数
`number`	Integer	-	現在ページのインデックス 0以上
`sort`	List	-	ソート基準 Sortを参照

レスポンスステータスコード

Cloud Outbound Mailer APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Outbound Mailerのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "content": [
    {
      "targetAddress": "test01@ncp-mail.com",
      "actionType": {
        "label": "Delete",
        "code": "D"
      },
      "actionRequesterType": {
        "label": "System",
        "code": "SYSTEM"
      },
      "requestDate": {
        "utc": 1593076560930,
        "formattedDate": "2020-06-25",
        "formattedDateTime": "2020-06-25 18:16:00 930"
      },
      "historySid": 62633,
      "sendResultCode": null,
      "sendResultMessage": null
    },
    {
      "targetAddress": "test01@ncp-mail.com",
      "actionType": {
        "label": "Create",
        "code": "C"
      },
      "actionRequesterType": {
        "label": "Other customer",
        "code": "OTHER_CUSTOMER"
      },
      "requestDate": {
        "utc": 1592471705229,
        "formattedDate": "2020-06-18",
        "formattedDateTime": "2020-06-18 18:15:05 229"
      },
      "historySid": 62632,
      "sendResultCode": "RECIPIENT_ADDRESS_ERROR",
      "sendResultMessage": "550 5.1.1 <test01@ncp-mail.com>: Recipient address rejected: User unknown in local recipient table\n"
    }
  ],
  "registerStatus": "Not blocked",
  "expectedDeleteDate": null,
  "last": true,
  "totalElements": 8,
  "totalPages": 1,
  "first": true,
  "numberOfElements": 8,
  "size": 10,
  "number": 0,
  "sort": [
    {
      "direction": "DESC",
      "property": "createUtc",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ]
}