配信予約削除API

配信予約削除API

配信予約削除APIとは

配信予約中のデータを削除できるAPIです。
配信予約データを削除する機能と、重複処理を抑止する機能を提供します。

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

基本機能

・配信予約データ削除機能
配信予約データを削除します。配信予約APIと同様に、リクエストIDを指定することで重複処理を抑止できます。

ご注意
本APIで削除可能なのは、配信時刻の約4分前までです。4分前を過ぎた場合は、削除できないことを示すエラーを返します。

・重複処理抑止機能
配信予約APIの「重複処理抑止機能」と同様に、削除処理が重複して実行されないよう制御する機能です。利用する場合は、request_idを指定します。

ご注意
request_idには、システム内で一意となる値を設定してください。既に設定済みの値を送信した場合はエラーを返します。
※共有環境の場合は、他の利用者が設定したIDも含めて一意である必要があります。

接続方法

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

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

リクエスト

ボディパラメーター

XML形式で指定します。

項目 データ型 必須 説明
mail データなし ◯ ルート要素であり、API v1で使用するXMLをまとめる唯一の要素
auth データなし ◯ リクエスト時に認証情報を定義する要素
詳細説明は以下をご参照ください。
auth要素(共通)
site データなし ◯ 利用するサイトIDを指定
service データなし ◯ 利用するサービスIDを指定
name 文字列(CDATA) ◯ ユーザ名を指定
pass 文字列(CDATA) ◯ パスワードを指定
delivery データなし ◯ 配信データに関する要素
詳細説明は以下をご参照ください。
delivery要素(配信予約削除_リクエスト)
action データなし ◯ deleteを指定
deliver_id 文字列 ◯ 配信IDを指定
request_id 文字列 リクエストIDを指定
補足説明
必須欄に「〇」が付いている項目は必須です。

レスポンス

ボディパラメーター

XML形式で設定します。

項目 データ型 必須 説明
mail データなし ◯ ルート要素であり、API v1で使用するXMLをまとめる唯一の要素
delivery データなし ◯ 配信データに関する要素
詳細説明は以下を参照してください。
delivery要素(配信予約削除_レスポンス)
deliver_id 文字列 ◯ 配信IDを設定
request_id 文字列 リクエストIDを指定した場合に設定
sent_cnt データなし ◯ 構成要素がない状態で設定
error_cnt データなし ◯ 構成要素がない状態で設定
result code 数値 ◯ 全体ステータスコードを表示
補足説明
必須欄に「〇」が付いている項目は必須です。

サンプル

リクエスト

<?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>