メール配信運用開始APIを実装したい

メール配信運用開始APIとは

本APIの概要

メール配信運用開始APIとは、貴社の基幹システム/アプリケーションとb→dashを繋ぐことでb→dash管理画面を介さずにメール配信設定の運用の切り替えを行うことができるAPIです。

貴社の基幹システム/アプリケーションに連携した配信を行いたい場合は、本API仕様書をご参照のもと貴社開発環境に実装してください。

本APIで取得できるb→dash管理画面上のデータ

b→dash管理画面と同等の操作

メール配信運用開始APIでは、b→dash管理画面にある「メール配信詳細画面（以下キャプチャ）」における操作と同様に、メール配信設定の運用の切り替えを行うことができます。

メール配信詳細画面でメール配信設定の運用を開始する例

b→dash管理画面上の更新結果確認方法

メール配信運用開始APIを利用した結果は以下のb→dash管理画面（「メール配信設定一覧画面」「メール配信設定詳細画面」）で確認することができます。

メール配信設定一覧画面（カード形式）の例

メール配信設定一覧画面（表形式）の例

メール配信設定詳細画面の例

本API利用にあたっての前提事項

事前準備

メール配信運用開始APIを利用する事前準備として「❶ メール配信設定の作成」「❷ メール配信設定の配信期間/配信タスクの確認」の2つの手順を踏む必要があります。

❶ メール配信設定の作成

メール配信設定の運用切り替えの対象であるメール配信設定を事前に作成する必要があります。配信したいメールコンテンツのメール配信設定がまだ作成されていない方は以下を参照に作成を完了させてください。

• b→dash管理画面上でメール配信設定を作成する場合：「単発のメールを本番配信したい」
• APIでメール配信設定を作成する場合：「メール配信設定新規作成APIを実装したい」

❷ メール配信設定の配信期間/配信タスクの確認

メール配信設定は配信期間内かつ配信タスクがある状態でなければ運用を開始することができません。メール配信設定の運用を切り替えるにあたり、事前にメール配信設定の配信期間の確認と配信タスクの確認、また必要に応じてメール配信期間を延長する必要があります。

●　【メール配信設定の配信期間の確認】 ●
配信設定詳細画面の「配信期間」（以下キャプチャ①）の間に、配信切り替えを行う日時が含まれていない場合は、「配信期間」の設定変更（以下キャプチャ②）をまず行う必要があります。
例えば、配信期間が「2021/11/24~11/25」で、11/26に配信を運用開始に切り替えたい場合は、配信期間の設定を「2021/11/24~11/27」に変更を行う必要があります。

●　【メール配信設定の配信タスクの確認】 ●
配信詳細画面の「繰り返し条件」（以下キャプチャ①）が「単発配信のみ」で、配信切り替えを行う日時においては、全ての配信が終了している場合は、「配信タイミング」の設定変更（以下キャプチャ③）をまず行う必要があります。
例えば、繰り返し条件が「単発 2021/11/24 16:00」で、11/26に配信を運用開始に切り替えたい場合は、配信タイミングの設定を「単発 2021/11/27 16:00」あるいは繰り返しで「毎日 16:00」に変更を行う必要があります。

メール配信設定詳細画面の例（キャプチャ①）

メール配信設定編集画面_配信期間の設定モーダル（キャプチャ②）

配信詳細画面_配信タイミングの設定モーダル（キャプチャ③）

共通仕様

メール配信運用開始APIでは、b→dash APIの共通仕様も参照する必要があります。共通仕様の詳細については「b→dash APIの共通仕様を知りたい」をご参照ください。

メール配信運用開始APIの仕様

処理フロー図

メール配信運用開始APIの処理フロー図は以下になります。

メール配信設定運用開始リクエスト

メール配信運用開始APIのURIにURIパラメータを指定してメール配信設定の運用開始のリクエストをするリクエストURIを準備します

〇メール配信運用開始APIのURI

〇URIパラメータ

【リクエストURIサンプル】

https://api.smart-bdash.com/api/v1/mail_deliveries/1001/start

〇リクエスト形式

POST https://api.smart-bdash.com/api/v1/mail_deliveries/1001/start

メール配信設定運用開始レスポンス

リクエストの送信に成功すると、下記のレスポンス形式でメール配信設定の運用開始のレスポンスが返されます

〇レスポンスボディパラメータ

○リクエストエラー発生時のエラーメッセージ詳細

【レスポンスボディサンプル】

{
  "result": {
    "code": 200
  }
}