イベント詳細ジョブ結果

機能説明

イベント詳細ジョブの結果を取得します。
他のジョブ結果取得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:* -

イベント詳細

要素名
要素数
説明
batch_id 文字列 1 メール送信APIで設定したbatch_id
envelope_from 文字列 1 送信元アドレス
envelope_to 文字列 1
送信先アドレス

暗号化されており、取得時に復号されるが復号に失敗した場合は復号前の文字列になります。
header_from 文字列 1 メール送信APIで指定したヘッダーFROMアドレス
label1 文字列 1 メールAPIで設定したcustom_argslabel1要素の値
label2 文字列 1 メールAPIで設定したcustom_argslabel2要素の値
label3 文字列 1 メールAPIで設定したcustom_argslabel3要素の値
mid 文字列 1 メールID
status 文字列 1
発生したイベントのステータス
Processed 処理を開始した
Delivered 送信に成功した
Bounced 恒久的に送信に失敗した
Dropped 配信停止アドレスに登録された宛先への送信を中止した
SpamReport 送信先からスパムと判定された
Blacklisted ブラックリストに登録された宛先への送信を中止した
Relayed SMTPリレー経由でメールを受け取り、キューイングされた
time 文字列 1 イベントが発生した日時
error 文字列 0:1 何らかの原因により宛先メールアドレスの復号に失敗した場合のエラーメッセージ
 
成功
{
  "code": 200,
  "data": [
    {
      "batch_id": "demo-trc1.testcaseZ1T20181005114853",
      "envelope_from": "demo-trc1.njrimgzl.409676703971422228@bounce-demo.autobahn.email",
      "envelope_to": "test@example.com",
      "header_from": "test@example.com",
      "label1": "",
      "label2": "",
      "label3": "",
      "mid": "409676703971422228",
      "state": "Processed",
      "time": "2018-10-05 11:48:57"
    },
    {
      "batch_id": "demo-trc1.testcaseZ1T20181005114853",
      "envelope_from": "demo-trc1.njrimgzl.409676703971422228@bounce-demo.autobahn.email",
      "envelope_to": "test@example.com",
      "header_from": "test@example.com",
      "label1": "",
      "label2": "",
      "label3": "",
      "mid": "409676703971422228",
      "state": "Delivered",
      "time": "2018-10-05 11:49:06"
    }
  ]
}