配信予約削除APIとは
配信予約中の配信データを削除することができる API です。
配信予約データ削除機能、重複処理抑止機能があります。
ご注意
複数の専用サーバ利用時は、メール配信 API のレスポンス HOST 名にて、本 API 問い合わせ先 URL のホストを変更してください。
複数の専用サーバ利用時は、メール配信 API のレスポンス HOST 名にて、本 API 問い合わせ先 URL のホストを変更してください。
基本機能
・配信予約データ削除機能
配信予約データを削除します。
メール配信 API と同様に、リクエスト ID を指定することで重複処理を抑止することができます。
ご注意
メール削除 API にて削除が可能なのは、配信時刻の約 4 分前までです。
4 分前を過ぎてしまうと削除不可のエラーを返します。
メール削除 API にて削除が可能なのは、配信時刻の約 4 分前までです。
4 分前を過ぎてしまうと削除不可のエラーを返します。
・重複処理抑止機能
メール配信 API「重複処理抑止機能」と同様に、削除処理を重複処理しないよう制御する機能です。
接続方法
接続方法は以下をご参照ください。
リクエスト
ボディパラメーター
XML形式で設定します。
| 項目 | データ型 | 必須 | 説明 | |||||
| データなし | ◯ | ルート要素であり、API v1で使用するXMLをまとめる唯一の要素 | ||||||
| auth | データなし | ◎ | リクエスト時に認証情報を定義する要素 詳細説明は以下をご参照ください。 |
|||||
| site | データなし | ◎ | 利用するサイトIDを指定 | |||||
| service | データなし | ◎ | 利用するサービスIDを指定 | |||||
| name | 文字列(CDATA) | ◎ | ユーザ名を指定 | |||||
| pass | 文字列(CDATA) | ◎ | パスワードを指定 | |||||
| delivery | データなし | ◯ | 配信データに関する要素 詳細説明は以下をご参照ください。 |
|||||
| action | データなし | ◯ | deleteを指定 | |||||
| deliver_id | 文字列 | △ | 配信IDを指定 ※deliver_idまたはrequest_idのどちらか一方が必須 |
|||||
| request_id | 文字列 | △ | リクエストIDを指定 ※deliver_idまたはrequest_idのどちらか一方が必須 ※使用する場合はお客様側で１リクエスト毎に、システム内で一意となるキーを設定する。 （共用や複数サイト使用する環境では、他のサイトと競合しない、一意のIDとする必要がある） |
|||||
補足説明
必須欄に「〇」がついている項目は必須項目であり、「△」がついている項目は同じレベルで下に続く項目のうちどれか1つが必須項目となります。
レスポンス
ボディパラメーター
XML形式で設定します。
| 項目 | データ型 | 必須 | 説明 | |||||
| データなし | ◯ | ルート要素であり、API v1で使用するXMLをまとめる唯一の要素 | ||||||
| delivery | データなし | ◯ | 配信データに関する要素 詳細説明は以下をご参照ください。 |
|||||
| deliver_id | 文字列 | △ | 配信IDを指定 ※deliver_idまたはrequest_idのどちらか一方が必須 |
|||||
| request_id | 文字列 | △ | リクエストIDを指定 ※deliver_idまたはrequest_idのどちらか一方が必須 ※使用する場合はお客様側で１リクエスト毎に、システム内で一意となるキーを設定する。 （共用や複数サイト使用する環境では、他のサイトと競合しない、一意のIDとする必要がある） |
|||||
| sent_cnt | データなし | 構成要素がない状態で設定 | ||||||
| error_cnt | データなし | 構成要素がない状態で設定 | ||||||
| result code | 全体ステータス | |||||||
補足説明
必須欄に「〇」がついている項目は必須項目であり、「△」がついている項目は同じレベルで下に続く項目のうちどれか1つが必須項目となります。
サンプル
リクエスト
<?xml version="1.0" encoding="UTF-8" ?>
<mail>
<auth>
省略
</auth>
<delivery id="0">
<action>delete</action><!-- メール削除 API 呼び出し指定 -->
<deliver_id>xxxxxx</deliver_id><!-- 配信 ID 指定 -->
<request_id>xxxxxx</request_id><!-- リクエスト ID 指定 -->
</delivery>
</mail>レスポンス
レスポンスは、要素 status、要素 action を持たないこと以外は、ステータス取得 API と同様です。
<?xml version="1.0" encoding="UTF-8" ?>
<mail>
<delivery id="0">
<deliver_id>xxxxxx</deliver_id><!-- 配信 ID -->
<request_id>xxxxxxx</request_id><!-- リクエスト ID を指定の時のみ付与。 -->
<sent_cnt></sent_cnt><!-- 構成要素には何も指定されません。 -->
<error_cnt ></error_cnt><!-- 構成要素には何も指定されません。 -->
<result code="0">処理が正常に終了しました</result>
</delivery>
</mail>