メールコンテンツ一覧取得APIとは

本APIの概要

メールコンテンツ一覧取得APIとは、貴社の基幹システム/アプリケーションとb→dashを繋ぐことでb→dash管理画面上のメールアプリで作成したメールコンテンツの情報を一覧で取得することができるAPIです。

貴社の基幹システム/アプリケーションから直接メールコンテンツの情報を取得したい場合は、本API仕様書をご参照のもと貴社開発環境に実装してください。

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

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

メールコンテンツ一覧取得APIで一覧取得できるメールコンテンツの情報は、以下のb→dash管理画面（「メールコンテンツ一覧画面」、「メールコンテンツ詳細画面」）で確認できる「メールコンテンツ名」「メールのパート保持内容」「ステータス」「最終更新日時」と、各メールコンテンツ詳細画面のURLから確認できる「メールコンテンツID」の5項目になります。

メールコンテンツ一覧画面の例（メールコンテンツ名）

メールコンテンツ一覧画面_パート選択モーダルの例（メールのパート保持内容）

※パート：メールコンテンツ新規作成時に選択したメールコンテンツの形式（「HTML/テキストメール」「HTMLメール」「テキストメール」）

メールコンテンツ詳細画面の例（ステータス）

メールコンテンツ詳細画面_更新履歴モーダルの例（最終更新日時）

各メールコンテンツ詳細画面のURLの例（メールコンテンツID）

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

事前準備

メールコンテンツの作成

メールコンテンツ一覧取得APIを利用する事前準備として、b→dash管理画面上でメールコンテンツを作成する必要があります。

メールアプリ上でメールコンテンツの作成がまだ完了していない場合は以下をご参照の上、メールコンテンツを作成してください。

• テキストメールを作成したい場合：「テキストメールを作成したい」
• GUIでHTMLメールを作成したい場合：「“GUI編集モード” で「HTMLメール」を作成したい」
• HTMLでHTMLメールを作成したい場合：「“HTML編集モード” で「HTMLメール」を作成したい」
• APIでHTML/テキストメールを作成したい場合：「メールコンテンツ新規作成APIを実装したい」

共通仕様

メールコンテンツ一覧取得APIでは、b→dash APIの共通仕様も参照する必要があります。共通仕様の詳細については「b→dash APIの共通仕様を知りたい」をご参照ください。

メールコンテンツ一覧取得APIの仕様

処理フロー図

メールコンテンツ一覧取得APIの処理フロー図は以下になります。

メールコンテンツ一覧取得リクエスト

〇メールコンテンツ一覧取得APIのURI

〇リクエスト形式

GET https://api.smart-bdash.com/api/v1/mail_contents

メールコンテンツ一覧取得レスポンス

リクエストに成功すると、下記のレスポンス形式でメールコンテンツ一覧APIのレスポンスが返されます

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

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

{ 
  "result": { 
    "code": 200, 
    "mail_contents": [ 
      { 
        "id": "10001", 
        "name": "メールＡ", 
        "type": 0, 
        "status": 1, 
        "lastmodified": "2022/06/30 07:00:00" 
      }, 
      { 
        "id": "10002", 
        "name": "メールＢ", 
        "type": 2, 
        "status": 2, 
        "lastmodified": "2021/12/31 23:59:59" 
      } 
    ] 
  } 
}