getSendBlockList
    • PDF

    getSendBlockList

    • PDF

    記事の要約

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

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

    リクエスト

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

    メソッドURI
    GET/send-block

    リクエストヘッダ

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

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

    パラメータの説明は次の通りです。

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

    リクエスト例

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

    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}'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    contentList<SendBlockHistoryResponse>Optional送信遮断リストの詳細
    registerStatusStringRequiredそのメールが現在送信遮断されているかどうか
    expectedDeleteDateNesDateTimeRequired遮断解除が予定されている日時
    lastBooleanRequired最後のページであるか否か
    totalElementsIntegerRequired総レコード数
    totalPagesIntegerRequired総ページ数
    firstBooleanRequired最初のページなのか否か
    numberOfElementsIntegerRequired現在ページのレコード数
    sizeIntegerRequiredページごとのレコード数
    numberIntegerRequired現在ページのインデックス
    • 0以上
    sortList<Sort>Requiredソート基準

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

    レスポンスステータスコードの説明は次の通りです。

    HTTPステータスコードコード説明
    200-リクエスト成功
    400-認証失敗、無効なリクエスト
    40077101ログイン情報エラー
    40077102リクエストエラー
    40077103リクエストしたリソースが存在しない
    40377201リクエストしたリソースに対する権限がない
    40377202メールサービスの使用を申し込んでいないユーザーが呼び出した場合
    40577001サポートしないメソッドタイプ
    41577002サポートしないメディアタイプ
    500-サーバエラー
    50077301基本プロジェクトが存在しない
    50077302外部システム API連携エラー
    50077303その他の内部サーバエラー

    レスポンス例

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

    {
      "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
        }
      ]
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.