エラーリスト取得API

エラーリスト取得API

配信を行った結果、エラーとなったメールアドレスについての情報を取得するAPIです。
標準仕様として恒久的エラーリストを取得できます。オプション指定により管理画面からの配信でエラーと判別したデータをすべて取得することもできます。

ご注意
複数の専用サーバ利用時は、メール配信 API のレスポンス HOST 名にて、本 API 問い合わせ先 URL のホストを変更してください。

基本機能

エラーリスト取得API基本機能

接続方法

接続方法は以下をご参照ください。

接続方法・処理シーケンス

リクエスト

ボディパラメーター

項目 データ型 必須 説明
mail データなし ◯ ルート要素であり、API v1で使用するXMLをまとめる唯一の要素
auth データなし 〇 リクエスト時に認証情報を定義する要素
詳細説明は以下をご参照ください。
auth要素(共通)
site データなし 〇 利用するサイトIDを指定
service データなし 〇 利用するサービスIDを指定
name 文字列(CDATA) 〇 ユーザ名を指定
pass 文字列(CDATA) 〇 パスワードを指定
delivery データなし ◯ 配信データに関する要素
詳細説明は以下をご参照ください。
delivery要素(エラーリスト取得_リクエスト)
action データなし ◯ 動作指定(get_errorを指定)
mode 文字列 △ エラー取得モードを指定
(all：全エラーデータ、未設定：永続的なエラーのみ）
deliver_id 文字列 △ 割り当てられた editor 配信 ID（[a-z0-9]{6}; ex) abcz09）
※deliver_id または term のどちらか一方が必須
term データなし △ 詳細説明は以下をご参照ください。
term要素(エラーリスト取得)

※deliver_id または term のどちらか一方が必須
from 文字列 ● エラーリスト取得対象開始日時
YYYY/MM/DD HH:MI
to 文字列 ● エラーリスト取得対象終了日時
YYYY/MM/DD HH:MI
補足説明

  • 必須欄に「〇」がついている項目は必須項目であり、「△」がついている項目は同じレベルで下に続く項目のうちどれか1つが必須項目となります。
  • 「●」は親要素が選択されているときは必須項目となります。

レスポンス

ボディパラメーター

項目 データ型 必須 説明
mail データなし ◯
result 文字列 △ 全体ステータス（認証エラー時など API 個別処理前にエラーが発生した場合に出力される。）
※result または errors・delivery のどれかが必須
errors データなし △ エラー（認証エラー時など API 個別処理前にエラーが発生した場合に出力される。）
※result または errors・delivery のどれかが必須
error 文字列 ● エラーメッセージ（認証エラー時など API 個別処理前にエラーが発生した場合に出力される。）
delivery データなし △ 配信データ処理結果
※result または errors・delivery のどれかが必須
deliver_id 文字列 △ 割り当てられた editor 配信 ID（[a-z0-9]{6}; ex) abcz09）
（リクエストで deliver_id を指定した場合） ※deliver_id か from/to のどちらかを返却
from 文字列 △ 対象開始日時分（リクエストで term を指定した場合） ※deliver_id か from/to のどちらかを返却
to 文字列 △ 対象終了日時分（リクエストで term を指定した場合） ※deliver_id か from/to のどちらかを返却
error_list データなし ● エラーリスト
data データなし ● エラーリスト
詳細説明は以下をご参照ください。
data要素(エラーリスト取得_レスポンス)
sent_date 文字列 ● 送信日時
to_addr 文字列(CDATA) ● 送信先(宛先)メールアドレス
from_addr 文字列(CDATA) ● 送信元メールアドレス
key_field 文字列(CDATA) ● メール送信リクエストで、アドレス情報に key_field を指定した場合、そのデータを返す。
message 文字列(CDATA) ● メッセージ
result 文字列 ● 全体ステータス
errors データなし ● エラー
error 文字列 ● エラーメッセージ
補足説明

  • 必須欄に「〇」がついている項目は必須項目であり、「△」がついている項目は同じレベルで下に続く項目のうちどれか1つが必須項目となります。
  • 「●」は親要素が選択されているときは必須項目となります。

サンプル

リクエスト

<?xml version="1.0" encoding="UTF-8" ?>
<mail>
    <auth>
    省略
    </auth>
    <delivery id="0">
        <action>get_error</action><!-- エラーリスト取得 API 呼び出し指定 -->
        <mode>all</mode><!-- 全エラーリスト取得オプション -->
        <!-- 配信 ID 指定か期間指定をします。両方指定された場合は、配信 ID で動作します。 -->
        <deliver_id>xxxxxx</deriver_id><!-- 配信 ID 指定 -->
        <term>
            <from>YYYY/MM/DD HH:MI</from><!-- 配信期間指定（開始日） -->
            <to>YYYY/MM/DD HH:MI</to><!-- 配信期間指定（終了日） -->
        </term>
    </delivery>
</mail>

レスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<mail>
    <delivery id="0">
        <!-- リクエスト時の指定により、配信 ID もしくは、from-to が指定されます。 -->
        <deliver_id>xxxxxx</deliver_id><!-- 配信 ID 指定の場合、指定した配信 ID を表示 -->
        <from>YYYY/MM/DD HH:MI</from><!-- リクエスト時に設定した配信期間指定（開始日） -->
        <to>YYYY/MM/DD HH:MI</to><!-- リクエスト時に設定した配信期間指定（終了日） -->
        <error_list>
            <data id ="xxxx-xxxxx"><!-- 取得したデータ分繰り返される。 -->
                <sent_date>2021/05/01 16:34</sent_date><!-- 送信日時 -->
                <to_addr><![CDATA[xxxxxx@xxx.jp]]></to_addr><!-- 送信先メールアドレス -->
                <from_addr><![CDATA[xxxxxx@xxx.jp]]></from_addr><!-- 送信元メールアドレス –>
                <!-- リクエスト時に設定した文字列 -->
                <key_field><![CDATA[no_data]]></key_field ><!-- リクエスト時に設定した文字列 -->
                <!-- 配信時に設定された配信結果情報 -->
                <message code="000"><![CDATA[XXXXXXXXXXXXXXX]]></message>
            </data>
        </error_list >
        <result code="0">処理が正常に終了しました</result>
    </delivery>
</mail＞