メール配信API

delivery要素 (配信予約_リクエスト)

配信予約リクエストの要素deliveryについて説明します。
実際に処理をおこなう指示やデータを定義する要素です。
リクエスト時には必須設定で、レスポンス時にはエラーの発生契機により任意で設定されます。
この項目は複数定義することができ、その都度違う処理を指定し実施することも可能です。

<delivery id="0">
　　<action>reserve</action>
　　<request_id>xxxxxxxxxxxxxxxxxxxxxxxxxxxx</request_id>
　　<setting>
　　　　省略
　　　　<option>
　　　　  省略
　　　　</option>
　　</setting>
　　<contents>
　　　　省略
　　</contents>
　　<send_list>
　　　　省略
　　</send_list>
</delivery>

構成

以下の要素で構成されます。

  1. action
  2. request_id
  3. setting
  4. contentes
  5. send_list

action

メール配信APIを利用するための要素です。

<action>reserve</action>
構成要素 reserve

request_id

リクエストを一意に判別するための要素です。

<request_id>xxxxxxxxxxxxxxxxxxxxxxxxxxxx</request_id>
構成要素 半角英数64文字以内の文字列

同一のリクエストIDで送信された場合は、重複の指示であると判別し、エラーを返します。このとき既にリクエストによる配信が行われていた場合、該当するリクエストIDの配信件数をレスポンスに設定します。
レスポンス時にはリクエストで設定した値と同じものが設定されます。

ご注意
リクエストIDは、完全にユニークである必要があります。
そのため共有環境や、複数のサイトを設定している専有環境等では、異なるサイト・サービス間においても同一とならないように設定する必要があります。
設定例：site1service12021xxxx0001(サイト１のサービス１で日付と番号を合成して設定)

setting

配信に関する設定を行う要素です。

setting(配信予約)

contentes

配信データを定義する要素です。

contents要素(配信予約)

send_list

配信対象者を定義する要素です。

send_list要素(配信予約)