エラーフィルター登録情報取得

概要

本APIは、指定したメールアドレス（複数指定可）について、配信エラーとして記録されている情報（エラーカウントなど）を取得するためのAPIです。

エラーフィルターは、配信エラーが一定条件で発生したメールアドレスを以降の配信対象から除外するための機能です。
本APIでは、エラーフィルターの対象となっているメールアドレスに加え、配信エラーが記録されているメールアドレスの情報も取得できます。

利用上の注意事項

• 一度のリクエストで指定可能なメールアドレスは最大10,000件です。
• 指定したメールアドレスに配信エラー情報がない場合、そのメールアドレスはレスポンスに含まれません。この場合でも、レスポンスはエラーになりません。

仕様補足

システムでは、配信エラーの内容に応じてエラーカウント値を累積して記録しています。
このエラーカウントが、配信時に指定される「error_count」の値を超えた場合、対象のメールアドレスは配信対象から自動的に除外されます。

本APIでは、エラーカウントの登録状況から、以下を確認できます。

• 現在、配信対象から自動的に除外されているメールアドレス
• 今後、配信対象から自動的に除外される可能性があるメールアドレス

エラーカウントの加算条件は、SMTP応答コード一覧の「カウント」欄を参照してください。

関連記事SMTP応答コード一覧

メソッドとURL

認証

本APIの呼び出しにはアクセストークンが必要です。
アクセストークンの設定は、以下を参考としてください。

関連記事アクセストークンの設定

リクエスト

ボディパラメーター

JSON形式で設定します。

リクエスト例

{
  "items":[
    { "address":"aaa@example.com" },
    { "address":"bbb@example.com" }
  ]
}

レスポンス

ステータスコード

上記以外のステータスコードについては、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。

関連記事HTTPレスポンスステータスコード一覧

レスポンスボディ

レスポンス例

正常

{
  "items": [
    {
      "address": "aaa@example.com",
      "count": 1,
      "registered_date": "yyyy-mm-ddThh:mm+09:00",
      "update_date": "yyyy-mm-ddThh:mm+09:00"
    }
  ],
  "count": 1
}

対象メールアドレスが0件の場合

{
  "items": [],
  "count": 0
}

エラー

{
 "message": "Too Many Requests"
}

エラー発生時は、messageにエラー内容が設定されます。