バウンス履歴ジョブ結果

バウンス履歴ジョブの結果を取得する。

他のジョブ結果取得APIと共通のエンドポイントを使用する。

ジョブ結果の取得期限はジョブをリクエストしてから24時間。

リクエスト

エンドポイント

/v2/jobs/[ジョブID]

HTTPメソッド

GET

リクエストボディ

なし

レスポンス

ステータスコード
状態
コード
成功 200
ジョブIDが不正 400
認証失敗 401
存在しないエンドポイント 404
存在しないジョブID 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504
レスポンスボディ
要素名
要素数
説明
code 数値 1 ステータスコード
status 文字列 1

ジョブの状態
success 実行完了
running 実行中

data バウンス型の配列 0:*  
start_at 文字列 1 リクエストで指定した起点日時
batch_id 文字列 0:1 リクエストで指定した batch_id
label1 文字列 0:1 リクエストで指定した label1
label2 文字列 0:1 リクエストで指定した label2
label3 文字列 0:1 リクエストで指定した label3
min 数値 0:1 データに含まれる最小の行番号。data の要素数が0の場合はレスポンスに含まれない
max 数値 0:1 データに含まれる最大の行番号。data の要素数が0の場合はレスポンスに含まれない
バウンス
要素名
要素数
説明
time 文字列 1 バウンスが発生した日時
mid 文字列 1 メールID
batch_id 文字列 1 バウンスが発生したメールのバッチID
envelope_to 文字列 1

宛先メールアドレス
暗号化されており取得時に復号されるが、複合に失敗した場合は復号前の文字列になる

reason 文字列 1

バウンス理由
※ バウンス理由を参照

code 文字列 0:1 バウンス発生時のSMTPステータスコード
status 文字列 0:1 バウンス発生時のSMTP拡張ステータスコード
response 文字列 0:1

バウンス発生時のSMTPエラーレスポンス
暗号化されており取得時に復号されるが、複合に失敗した場合は復号前の文字列になる

row 数値 1 行番号
error 文字列 0:1 何らかの原因により宛先メールアドレスもしくはレスポンスの復号に失敗した場合
成功

{
  "code": 200,
  "data": [
    {
      "batch_id":"example.00002",
      "time": "2018-11-26 08:00:57.496",
      "mid": "428825858165899721",
      "envelope_to": "test@example.com",
      "header_from": "from2@example.org",
      "reason": "USER_UNKNOWN",
      "code": "550",
      "response": "550 5.1.1 User Unknown",
      "status": "5.1.1",
      "row": 1
    },
    {
      "batch_id":"example.00001",
      "time": "2018-11-27 08:00:42.704",
      "mid": "428825787584219655",
      "envelope_to": "test@example.com",
      "header_from": "from1@example.org",
      "reason": "USER_UNKNOWN",
      "response": "550-5.1.1 The email account that you tried to reach does not exist. Please try 550-5.1.1 double-checking the recipient's email address for typos or 550-5.1.1 unnecessary spaces. Learn more at 550 5.1.1 https://support.google.com/mail/?p=NoSuchUser 1-v6si2165862ywy.371 - gsmtp",
      "code": "550",
      "status": "5.1.1",
      "row": 2
    },
  ],
  "start_at": "2018-11-27 08:00:00",
  "batch_id": "batch0123",
  "label1": "female",
  "label2": "tokyo",
  "label3": "10dai",
  "envelope_to": "test@example.com",
  "min": 1,
  "max": 2
}

バウンス理由

理由
BLOCKED

宛先メールサーバに接続した際に、発信元メールサーバのIPアドレスやホスト名、
またはEHLO/HELOコマンドの値によって接続が拒否された場合のエラー

CONTENT_ERROR 送信したメールの形式が宛先メールサーバで変換できない、もしくは処理できない形式だった場合のエラー
EXCEED_LIMIT 宛先メールサーバのメール受信量が限界値を超えた場合のエラー
EXPIRED 送信したメールが宛先メールサーバに接続できないなどの理由で配送時間切れになった場合のエラー
FILTERED ユーザがメールの受信を拒否している場合のエラー
HAS_MOVED メールボックスが別のメールボックスに移動したが、自動でメールが転送されない場合のエラー
HOST_UNKNOWN 宛先メールアドレスのドメインが無効なドメインだった場合のエラー
MAILBOX_FULL 宛先のメールボックスが一杯で受信できなかった場合のエラー
MAILER_ERROR 宛先メールサーバ上でプログラムが正常終了しなかった場合のエラー
MESSAGE_TOO_BIG 送信したメールの文面サイズが宛先メールサーバの許容量を超えた場合のエラー
NETWORK_ERROR DNSによる名前解決失敗を原因としてSMTP接続できなかった場合のエラー
NO_RELAYING 宛先メールサーバからSMTPリレーを拒否された場合のエラー
NOT_ACCEPT 宛先メールサーバが先方都合によりメールを受信できなかった場合のエラー
REJECTED 発信者メールアドレスによって拒否された場合のエラー
SECURITY_ERROR 宛先メールサーバがセキュリティ上の理由やポリシー違反で受信拒否した場合のエラー
SPAM_DETECTED 送信したメールがスパムとして検出された、あるいはDNSBLによってスパム送信ホストとして認識された場合のエラー
SUSPENDED 宛先メールアドレスのユーザアカウントが無効な場合のエラー
SYNTAX_ERROR 宛先メールサーバがSMTPコマンドを認識できなかった場合のエラー
SYSTEM_ERROR 宛先メールサーバ内でLDAPサーバへの接続失敗などのシステムエラーが発生した場合のエラー
SYSTEM_FULL 宛先メールサーバのディスクが一杯になった場合のエラー
TOO_MANY_CONNECTION 先メールサーバの同時接続数を超過した場合のエラー
TOO_MANY_RECIPIENT SMTP接続内で、宛先メールサーバの送信対象アドレスの上限数を超えた場合のエラー
USER_UNKNOWN 宛先メールアドレスのローカルパートに該当するユーザが存在しない場合のエラー