配信結果リスト取得API

配信結果リスト取得API

実際に配信処理を行ったメールアドレスの配信結果を取得するAPIです。

ご注意
複数の専用サーバーを利用している場合は、配信予約APIのレスポンスに含まれるHOST名に合わせて、本APIの問い合わせ先URLのHOST名を変更してください。

基本機能

配信結果リスト取得機能

配信処理が行われたメールアドレスに対する処理結果リストを取得する機能です。

送信日時  MTAに送信依頼を行った日時です。
宛先のメールアドレス 配信先のメールアドレスです。
エラーフィルタにより配信されなかったメールアドレスや、メールアドレス形式ではないデータは、MTAに送信依頼を行わないため取得できません。
送信元のメールアドレス 配信時にHeader Fromアドレスとして指定したメールアドレスです。
XML内でHeader Fromアドレスを指定した場合は、そのメールアドレスを使用します。未指定の場合は、サービス設定に登録されているHeader Fromアドレスを使用します。
キーフィールド メール配信時に、キーフィールドに設定した情報を取得できます。
ステータス MTAに送信依頼を行った結果の成否です。
※エラーリスト取得APIでは、このステータスが「エラー」であるもののみを抽出します。
メッセージ メールアドレスに対する処理結果の詳細メッセージです。
処理結果コードとメッセージは、以下のマニュアルを確認してください。
配信結果ステータスコード一覧

接続方法

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

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

リクエスト

ボディパラメーター

XML形式で設定します。

項目 データ型 必須 説明
mail データなし ◯ ルート要素であり、API v1で使用するXMLをまとめる唯一の要素
auth データなし ◯ リクエスト時に認証情報を定義する要素
詳細説明は以下を参照してください。
auth要素(共通)
site データなし ◯ 利用するサイトIDを指定
service データなし ◯ 利用するサービスIDを指定
name 文字列(CDATA) ◯ ユーザー名を指定
pass 文字列(CDATA) ◯ パスワードを指定
delivery データなし ◯ 配信データに関する要素
詳細説明は以下を参照してください。
delivery要素(配信結果取得_リクエスト)
action データなし ◯ get_result を指定
deliver_id 文字列 △ 割り当てられた配信 ID(「0-9a-z」6 桁)
※deliver_id または term のどちら一方が必須
term データなし △ 期間を指定（auth で指定した service を対象とする）
※deliver_id または term のどちら一方が必須。（どちらも指定されている場合は deliver_id を優先）
詳細説明は以下を参照してください。
term要素(配信結果取得)
from 文字列 ● 「YYYY/MM/DD HH:MI」配信開始日時が from-to に含まれる配信 ID を対象とする。
※from, to は両方必ず指定する。
to 文字列 ● 「YYYY/MM/DD HH:MI」配信開始日時が from-to に含まれる配信 ID を対象とする。
※from, to は両方必ず指定する。
補足説明

  • 必須欄に「〇」が付いている項目は必須項目です。
  • 「△」が付いている項目は、同じレベルで下に続く項目のうち、いずれか1つが必須です。
  • 「●」は、親要素が選択されている場合に必須です。

レスポンス

ボディパラメーター

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

  • 必須欄に「〇」が付いている項目は必須項目です。
  • 「△」が付いている項目は、同じレベルで下に続く項目のうち、いずれか1つが必須です。
  • 「●」は、親要素が選択されている場合に必須です。

サンプル

リクエスト

<?xml version="1.0" encoding="UTF-8" ?>
<mail>
  <auth>
　省略
  </auth>
　<delivery id="0">
    <action>get_result</action><!-- 配信結果リスト取得 API 呼び出し指定 --> 
    <!-- 配信 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><!-- リクエスト時に設定した配信期間指定（終了日） -->
    <sent_list>
      <data id ="xxxx-xxxxx"><!-- 取得したデータ分繰り返される。 -->
        <sent_date>2021/05/01 16:34</sent_date><!-- 送信日時 -->
        <to_addr><![CDATA[xxx@example.com]]></to_addr><!-- 送信先メールアドレス -->
        <from_addr><![CDATA[xxx@example.com]]></from_addr><!-- 送信元メールアドレス –
        >
        <!-- リクエスト時に設定した文字列 -->
        <key_field><![CDATA[no_data]]></key_field ><!-- リクエスト時に設定した文字
        列 -->
        <status>0</status><!-- 配信結果ステータス 0:成功 1:失敗 -->
        <!-- 配信時に設定された配信結果情報 -->
        <message code="000"><![CDATA[XXXXXXXXXXXXXXX]]></message>
      </data>
    </sent_list >
    <result code="0">処理が正常に終了しました</result>
  </delivery>
</mail>