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

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

指定されたメールアドレスのエラーフィルター登録情報を取得します。

補足説明

  • 指定されたメールアドレスがエラーフィルターに登録されてない場合は、対象のデータは返却されません。
  • エラーカウントアップルールについては以下をご確認ください。
注意事項 一度のリクエストで指定可能なアドレスは最大10,000件までです。
 

メソッドとURL

メソッド URL
POST https://{HOST名}/errorfilter

 

リクエスト

ボディパラメーター

JSON形式で設定します。

項目 必須 説明
items Object Array 取得用データのリスト。
address String エラーカウントを確認するメールアドレス。

レスポンス

ステータスコード

コード メッセージ 説明
200 OK リクエスト受付、正常終了。
400 Bad Request 構文不正。フォーマットやパラメーターの不正。
413
Request Entity Too Large
指定したアドレスの件数が、所定値を超えている。
500 Internal Server Error 想定外のエラー。 しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。

上記以外のステータスコードが返却される場合もあります。 その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。

HTTPレスポンスステータスコード一覧

ボディパラメーター

項目 説明
items Object Array レスポンスのリスト。配列で結果が格納される。
address Object Array 登録されているメールアドレス。
count Number エラーカウント。小数点第1位まで表示。
registered_date String 初回登録日時。
update_date String 最終更新日時。
count Number itemsに設定されたデータの件数。
message String 失敗時に設定される補足メッセージ。

 

サンプル

リクエスト

{
  "items":[
    {
      "address":"xxxxxxxx@xxxx.xx"
    },
    {....}
  ]
}

 

レスポンス

正常

{
  "items": [
    {
      "address": "xxxxxxxx@xxxx.xx",
      "count": 1
      "registered_date": "yyyy-mm-ddThh:mm+09:00",
      "update_date": "yyyy-mm-ddThh:mm+09:00"
    },
    {...}
  ],
  "count": 2
}

フィルターに登録されていないアドレスは返却されません。

エラー

{
 "message": "Too Many Requests"
}

補足情報が返却さます。