機能説明
イベントサマリ一覧ジョブの結果を取得します。
他のジョブ結果取得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: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 |
発生したイベントのステータス
Processed 処理を開始した Delivered 送信に成功した Bounced 恒久的に送信に失敗した Dropped 配信停止アドレスに登録された宛先への送信を中止した SpamReport 送信先からスパムと判定された Blacklisted ブラックリストに登録された宛先への送信を中止した Relayed SMTPリレー経由でメールを受け取り、キューイングされた |
| time | 文字列 | 1 | イベントが発生した日時 |
| error | 文字列 | 0:1 | 何らかの原因により、宛先メールアドレスの復号に失敗した場合のエラーメッセージ |
成功
{
"data": [
{
"batch_id": "demo-trc1.testcaseZ1T20181105170818",
"envelope_from": "demo-trc1.njrimgzl.420991132721754355@bounce-demo.autobahn.email",
"envelope_to": "test@example.com",
"header_from": "dkim@dkim.autobahn.email",
"mid": "420991132721754355",
"row": 1,
"state": "Delivered",
"time": "2018-11-05 17:08:34"
},
{
"batch_id": "demo-trc1.testcaseZ1T20181105165719",
"envelope_from": "demo-trc1.njrimgzl.420988365173174514@bounce-demo.autobahn.email",
"envelope_to": "test@example.com",
"header_from": "dkim@dkim.autobahn.email",
"mid": "420988365173174514",
"row": 2,
"state": "Delivered",
"time": "2018-11-05 16:57:35"
},
{
"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",
"mid": "409676703971422228",
"row": 3,
"state": "Delivered",
"time": "2018-10-05 11:49:06"
},
{
"batch_id": "demo-trc1.testcaseZ1T20181005114827",
"envelope_from": "demo-trc1.njrimgzl.409676620009844755@bounce-demo.autobahn.email",
"envelope_to": "test@example.com",
"header_from": "test@example.com",
"mid": "409676620009844755",
"row": 4,
"state": "Delivered",
"time": "2018-10-05 11:48:43"
},
{
"batch_id": "demo-trc1.testcaseZ1T20181005114741",
"envelope_from": "demo-trc1.njrimgzl.409676418423205906@bounce-demo.autobahn.email",
"envelope_to": "test@example.com",
"header_from": "test@example.com",
"mid": "409676418423205906",
"row": 5,
"state": "Delivered",
"time": "2018-10-05 11:47:55"
},
{
"batch_id": "demo-trc1.testcaseZ1T20181003140630",
"envelope_from": "demo-trc1.njrimgzl.408986562520952853@bounce-demo.autobahn.email",
"envelope_to": "test@example.com",
"header_from": "test@example.com",
"mid": "408986562520952853",
"row": 6,
"state": "Delivered",
"time": "2018-10-03 14:06:40"
},
{
"batch_id": "demo-trc1.testcaseZ1T20181003135655",
"envelope_from": "demo-trc1.njrimgzl.408984171834781716@bounce-demo.autobahn.email",
"envelope_to": "test@example.com",
"header_from": "test@example.com",
"mid": "408984171834781716",
"row": 7,
"state": "Delivered",
"time": "2018-10-03 13:57:13"
},
{
"batch_id": "demo-trc1.testcaseZ1T20181002111557",
"envelope_from": "demo-trc1.njrimgzl.408581267193868307@bounce-demo.autobahn.email",
"envelope_to": "test@example.com",
"header_from": "test@example.com",
"mid": "408581267193868307",
"row": 8,
"state": "Delivered",
"time": "2018-10-02 116:14"
},
{
"batch_id": "demo-trc1.testcaseZ1T20181002111529",
"envelope_from": "demo-trc1.njrimgzl.408581148046274578@bounce-demo.autobahn.email",
"envelope_to": "test@example.com",
"header_from": "test@example.com",
"mid": "408581148046274578",
"row": 9,
"state": "Delivered",
"time": "2018-10-02 115:45"
},
{
"batch_id": "demo-trc1.testcaseZ1T20181002105044",
"envelope_from": "demo-trc1.njrimgzl.408574900110372888@bounce-demo.autobahn.email",
"envelope_to": "test@example.com",
"header_from": "test@example.com",
"mid": "408574900110372888",
"row": 10,
"state": "Delivered",
"time": "2018-10-02 10:56:12"
}
],
"max": 10,
"min": 1
}