XML内に多くのメールアドレスや差し込み情報を設定した場合、XMLリクエストのサイズが大きくなります。
このようなサイズの大きいリクエストを処理するため、「キューイングモード配信」をご利用いただけます。
接続先や認証情報の設定方法など、他APIの仕様と異なる点がありますのでご注意ください。
利用用途
キューイングモード配信は、以下のようなケースの場合に利用することを推奨いたします。
- 大量配信先への一括配信
お客様のシステムで保有している会員アドレス全体に、一斉通知をおこなう場合に有効です。 - 多様なセグメントへの同時配信
お客様システムからのリクエスト受付後、すぐにレスポンスが返却されるため、すぐに次の配信準備に取り掛かることが可能です。
同一コンテンツで差し込みなどを利用し、異なるセグメントに対して連続して配信リクエストを実施可能です。
処理について
結果出力処理
リクエスト受付結果を出力します。
リクエスト受け付け時の認証処理や、リクエストデータの出力処理等に失敗した場合には、レスポンスにて返答されます。
キューイングモード配信では、リクエスト受付時点では配信件数が取得できないため常に0件となります。
構文解析
リクエストしたXML内容の解析は非同期でおこなわれ、エラーとなった場合には、指定されたユーザーIDの所有するメールアドレスに情報が送信されます。
認証情報として利用するユーザーIDには、必ずメールアドレスを登録してご利用ください。
キューイングモード配信固有処理
配信時刻指定
指定方式はダイレクトモード配信と同様ですが、指定値による動作が異なります。
指定値 | 内容 |
Now(即時配信) | 配信予約登録刻を配信時刻として登録し配信をおこないます。 |
配信時刻 (YYYY/MM/DD HH:MI) |
指定した時刻に配信するように配信予約をおこないます。 |
配信状況通知の有効化
配信の完了を確認するため、MTAから配信状況を取得・通知する機能を、標準で有効化します。
標準で1回の配信宛先数が1,000通を超える場合に、MTAから配信状況を取得する処理が動作し、配信した通数をデータベースに反映します。
また、配信状況を取得する処理が動作した場合としない場合では配信完了時間が異なりますのでご注意ください。
- 1回の配信宛先数が1,000通以上の場合
MTAへの配信が完了したタイミングで配信完了のステータスとなります。 - 1回の配信宛先数が1,000通未満の場合
MTAへ配信が完了したタイミングで配信完了のステータスとなります。
本機能は管理画面からの配信でも有効となるため、API v1と併用される場合にはご注意ください。
また、後述する処理エラー通知のHeader Fromアドレスに、配信状況通知機能のHeader Fromアドレスを使用します。配信状況通知機能は無効のままで利用可能です。
処理エラー通知
構文解析が非同期でおこなわれるため、エラーが発生した場合にはメールにて通知をおこないます。
宛先のメールアドレス (toアドレス) |
リクエスト時に指定したユーザーIDが持つメールアドレスを宛先とします。 管理画面の「管理者機能タブ > ユーザアカウント管理」にて登録が可能です。 |
送信元のメールアドレス (Header Fromアドレス) |
通知メールのHeader Fromアドレスです。 特に指定のない場合は、弊社で登録したアドレスが使用されます。 |
メッセージ | 件名は固定文言となります。 メール本文はテキストメールで、エラーレスポンスで返却される情報と同等の内容を記載します。 |
件名(固定) | Notification |
本文(本文例) | deliver_id: {配信ID} result code = -1 result message: エラーが発生しました。 errors error kind:image code:3105 message: 画像ファイルのエンコード処理に失敗しました。 |
キューイングモード配信の利用不可機能
メール配信APIの基本機能(ダイレクトモード配信)のうち、キューイングモード配信では利用できない機能がありますのでご注意ください。
- データベース指定方式
キューイングモード配信では、管理画面のデータベースを利用した配信はおこなうことができません。
その他の注意点
- 管理画面上の表示
キューイングモード配信で処理をおこなう際、配信IDを予約するために仮のデータで配信予約が作成されます。
そのため、配信の登録が完了するまでの表示は、実際のリクエスト内容と異なります。