処理結果情報取得機能
メール配信 APIおよび配信予約削除 APIを実施した結果を取得する機能です。
3つの指定方法があります。
①配信 ID(要素 deliver_id)
指定された配信 ID で配信データを検索し情報を取得します。
配信 ID を利用できるケースは、配信 ID が正しく採番できた場合のみとなります。配信予約ができなかった場合は配信 ID を利用することができません。
<取得データ>
配信ID | 指定した配信 ID です。 |
現在のステータス | 配信データの取得時のステータスです。 |
配信成功数 | 配信が成功した件数です。エラーフィルタ等で実際に配信されなかったデータは含まれません。 |
配信失敗数 | 配信を行った結果、エラーとなった件数です。MTA からのエラーおよびバウンスメールによって更新される件数です。 |
②リクエスト ID(要素 request_id)
リクエスト時に指定したリクエストIDで、実施された処理や関連する配信IDのステータスを取得することができます。
但し、本API呼び出し時に配信IDを指定している場合、リクエストIDは検索条件にはなりません。
<取得データ>
配信ID | 指定した配信 ID です。採番されていなかった場合は空白になります。 |
リクエスト ID | 指定したリクエスト ID です。存在しないリクエスト ID の場合はエラーになります。 |
アクション | リクエスト ID を指定して処理をした場合に、実施したアクションです。 |
現在のステータス | 配信データの取得時のステータスです。 |
配信成功数 | 配信が成功した件数です。エラーフィルタ等で実際に配信されなかったデータは含まれません。 |
配信失敗数 | 配信を行った結果、エラーとなった件数です。MTA からのエラーおよびバウンスメールによって更新される件数です。 |
③期間指定(要素 term/from term/to)
指定した日時範囲で、配信予定時刻となっている配信データを検索し、該当する取引の結果を取得します。
認証情報で指定したサイト及びサービスが検索対象となります。
複数のデータが取得可能であるため、レスポンスの形式が、配信 ID・リクエスト ID を利用するケースと異なります。
<取得データ>
配信ID | 指定した配信 ID です。採番されていなかった場合は空白になります。 |
現在のステータス | 配信データの取得時のステータスです。 |
配信成功数 | 配信が成功した件数です。エラーフィルタ等で実際に配信されなかったデータは含まれません。 |
配信失敗数 | 配信を行った結果、エラーとなった件数です。MTAからのエラーおよびバウンスメールによって更新される件数です。 |