イベントサマリ一覧ジョブの結果を取得する。
他のジョブ結果取得APIと共通のエンドポイントを使用する。
ジョブ結果の取得期限はジョブをリクエストしてから24時間。
リクエスト
エンドポイント
/v2/jobs/[ジョブID]
HTTPメソッド
GET
リクエストボディ
なし
レスポンス
ステータスコード
状態
|
コード
|
---|---|
成功 | 200 |
ジョブIDが不正 | 400 |
認証失敗 | 401 |
存在しないエンドポイント | 404 |
存在しないジョブID | 404 |
許可されていないHTTPメソッド | 405 |
システムエラーが発生した | 500 |
システムが一時的にサービスを提供できない状態になっている | 503 |
システムのタイムアウト | 504 |
レスポンスボディ
要素名
|
型
|
要素数
|
説明
|
---|---|---|---|
code | 数値 | 1 | ステータスコード |
status | 文字列 | 1 |
ジョブの状態 |
data | イベントサマリー型の配列 | 0:1000 | |
start_at | 文字列 | 1 | リクエストで指定した起点日時 |
batch_id | 文字列 | 0:1 | リクエストで指定した batch_id |
label1 | 文字列 | 0:1 | リクエストで指定した label1 |
label2 | 文字列 | 0:1 | リクエストで指定した label2 |
label3 | 文字列 | 0:1 | リクエストで指定した label3 |
min | 数値 | 1 | データに含まれる最小の行番号 |
max | 数値 | 1 | データに含まれる最大の行番号 |
イベントサマリー
要素名
|
型
|
要素数
|
説明
|
---|---|---|---|
batch_id | 文字列 | 1 | メール送信APIで設定した batch_id |
envelope_from | 文字列 | 1 | 送信元アドレス |
envelope_to | 文字列 | 1 |
送信先アドレス |
header_from | 文字列 | 1 | メール送信APIで指定したヘッダーFROMアドレス |
mid | 文字列 | 1 | メールID |
row | 数値 | 1 | 行番号 |
status | 文字列 | 1 |
発生したイベントのステータス |
time | 文字列 | 1 | イベントが発生した日時 |
error | 文字列 | 0:1 | 何らかの原因により宛先メールアドレスの復号に失敗した場合 |