メールアドレス別バウンス履歴ジョブ結果

機能説明

メールアドレス別バウンス履歴ジョブの結果を取得します。
他のジョブ結果取得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:* -
envelope_to 文字列 1 リクエストで指定したenvelope_to

バウンス

要素名
要素数
説明
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エラーレスポンス
 
成功
{
  "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",
      "response": "550 5.1.1 User Unknown",
      "code": "550",
      "status": "5.1.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"
    }
  ],
  "envelope_to": "test@example.com"
}