配信ステータス取得API

配信ステータス取得API

メール配信や削除処理などの結果を取得するAPIです。

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

基本機能

基本機能の詳細は以下のページを参照してください。

配信ステータス取得API基本機能

接続方法

接続方法の詳細は以下のページを参照してください。

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

リクエスト

ボディパラメーター

XML形式で設定します。

項目 データ型 必須 説明
mail データなし ◯ ルート要素であり、API v1で使用するXMLをまとめる唯一の要素
auth データなし ◯ リクエスト時に認証情報を定義する要素。
詳細は以下ページを参照してください。
auth要素(共通)
site データなし ◯ 利用するサイトIDを指定
service データなし ◯ 利用するサービスIDを指定
name 文字列(CDATA) ◯ ユーザー名を指定
pass 文字列(CDATA) ◯ パスワードを指定
delivery データなし ◯ 配信データに関する要素。
詳細は以下ページを参照してください。
delivery要素(配信ステータス取得_リクエスト)
action 文字列 ◯ get_statusを指定
※複数の検索条件が指定された場合、配信 ID > リクエスト ID > 期間指定の優先順位で有効です。
deliver_id 文字列(64) △ 配信IDを指定
request_id 文字列(64) △ リクエストIDを指定
term 数値 △ 配信期間指定を指定
from YMD ● 開始日を指定
to YMD ● 終了日を指定
補足説明

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

レスポンス（配信ID・リクエストID指定時）

ボディパラメーター

項目 データ型 必須 説明
mail データなし ◯
result 文字列 △ 全体ステータス（認証エラー時などAPI個別処理前にエラーが発生した場合に出力）
※result、errors、deliveryのいずれかが必須
errors データなし △ エラー（認証エラー時などAPI個別処理前にエラーが発生した場合に出力）
※result、errors、deliveryのいずれかが必須
error 文字列 ● エラーメッセージ（認証エラー時などAPI個別処理前にエラーが発生した場合に出力）
delivery データなし △ 配信データ処理結果
詳細は以下ページを参照してください。
delivery要素(配信ステータス取得_配信ID・リクエストID指定時レスポンス)
deliver_id 文字列 ● 配信ID
request_id 文字列 ● リクエストID
※リクエスト時にリクエストIDを指定した場合に表示されます。
action 文字列 ● 指定した request_id で実施した actionを取得
status 文字列 ● 配信データのステータス
sent_cnt 文字列 ● 配信成功件数
error_cnt  文字列 ● 配信エラー件数
result 文字列 ● 全体ステータス
errors データなし ● エラー
error 文字列 ● エラーメッセージ
補足説明

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

レスポンス（期間指定)

ボディパラメーター

項目 データ型 必須 説明
mail データなし ◯
result 文字列 △ 全体ステータス（認証エラー時などAPI個別処理前にエラーが発生した場合に出力）
※result、errors、deliveryのいずれかが必須
errors データなし △ エラー（認証エラー時などAPI個別処理前にエラーが発生した場合に出力）
※result、errors、deliveryのいずれかが必須
error 文字列 ● エラーメッセージ（認証エラー時などAPI個別処理前にエラーが発生した場合に出力）
delivery データなし △ 配信データ処理結果
詳細は以下ページを参照してください。
delivery要素(配信ステータス取得_期間指定レスポンス)
sent_list データなし ● 複数の配信毎データをまとめる要素
data データなし ● 一つの配信毎データをまとめる要素
詳細は以下ページを参照してください。
data要素(配信ステータス取得)
deliver_id 文字列 ● 配信ID
status 文字列 ● 配信データのステータス
sent_cnt 文字列 ● 配信成功件数
error_cnt  文字列 ● 配信エラー件数
result 文字列 ● 全体ステータス
errors データなし ● エラー
error 文字列 ● エラーメッセージ
補足説明

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

サンプル

リクエスト

<?xml version="1.0" encoding="UTF-8" ?>
<mail>
    <auth>
        省略
    </auth>
    <delivery id="0">
        <action>get_status</action><!-- ステータス取得 API 呼び出し指定 -->
        <!-- 配信 ID、リクエスト ID、期間指定のいずれかを指定します。-->
        <!-- 複数の検索条件が指定された場合、配信 ID > リクエスト ID > 期間指定 の順に優先して適用されます。 -->
        <deliver_id>xxxxxx</deliver_id><!-- 配信 ID 指定 -->
        <request_id>xxxxxx</request_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">
        <deliver_id>xxxxxx</deliver_id><!-- 配信 ID -->
        <request_id>xxxxxxx</request_id><!-- リクエスト ID。リクエスト ID 指定の時のみ付与。 -->
        <action>xxxxxxx</action><!-- 処理失敗時に、失敗したアクション指定を設定。 -->
        <status code="0">XXXXXXXX</status><!-- 配信データのステータス -->
        <sent_cnt>0</sent_cnt><!-- 送信が成功した件数。 -->
        <error_cnt >0</error_cnt><!-- 送信が失敗した件数。 -->
        <result code="0">処理が正常に終了しました</result>
    </delivery>
</mail>

レスポンス(期間指定)

<?xml version="1.0" encoding="UTF-8" ?>
<mail>
    <delivery><!-- レスポンスデータをまとめる要素 -->
        <sent_list><!-- 複数の配信毎データをまとめる要素 -->
            <data id="1"><!--一つの配信毎データをまとめる要素 -->
                <deliver_id>xxxxxx</deliver_id>
                <status code="0">対象配信のステータス</status>
                <sent_cnt>0</sent_cnt>
                <error_cnt>0</error_cnt>
            </data>
            <data id="2">
                <deliver_id></deliver_id><!-- 配信 ID が採番されていないケース -->
                <status code="0">対象配信のステータス</status>
                <sent_cnt>0</sent_cnt>
                <error_cnt>0</error_cnt>
            </data>
        </sent_list>
        <result code="0">処理が正常に終了しました</result>
    </delivery>
</mail>