無料お試し

API連携

API機能一覧

APIについて

ログイン・ログアウト

HTTP(S) ログインログアウト

XML-RPC ログインログアウト

メール新規作成

HTTP(S) 即時配信予約配信

XML-RPC 即時配信予約配信

下書き

HTTP(S) 下書きの作成下書きの検索下書きの検索(メッセージデータ) 下書きの削除

XML-RPC 下書きの作成下書きの検索下書きの検索(メッセージデータ) 下書きの削除

予約状況の確認

HTTP(S) 予約状況の検索予約状況の検索(メッセージデータ) 予約の削除

XML-RPC 予約状況の検索予約状況の検索(識別ID) 予約状況の検索(メッセージデータ) 予約の削除

配信履歴の確認

HTTP(S) 配信履歴の検索配信履歴の検索(メッセージデータ) 成功・失敗アドレスの取得 HTMLの開封率取得配信履歴の削除

XML-RPC 配信履歴の検索配信履歴の検索(識別ID) 配信履歴の検索(メッセージデータ) 成功アドレスの取得失敗アドレスの取得 HTMLの開封率取得配信履歴の削除

バックナンバー

HTTP(S) バックナンバー一覧の検索(詳細)

XML-RPC バックナンバー一覧の検索(詳細)

個別登録

HTTP(S) 個別登録個別検索個別編集

XML-RPC 個別登録個別検索(識別ID) 個別検索(E-Mail) 個別編集

一括登録・削除

HTTP(S) 登録・削除用CSVデータ取得一括登録(全登録) 一括登録(新規登録のみ) 一括登録(アップデートのみ) 一括削除一括処理エラー一覧検索一括処理エラーCSV取得一括処理エラー情報削除

XML-RPC 登録用CSVデータ取得削除用CSVデータ取得一括登録(全登録) 一括登録(新規登録のみ) 一括登録(アップデートのみ) 一括削除一括処理エラー一覧検索一括処理エラー一覧検索(日付条件) 一括処理エラーCSV取得一括処理エラー情報削除

読者データの検索

HTTP(S) 読者データの検索読者データの取得読者データの削除

XML-RPC 読者データの検索(識別ID) 読者データの検索(複数条件) 読者データの取得読者データの削除

配信グループの参照

HTTP(S) グループ一覧の取得・検索

XML-RPC グループ一覧の取得グループの検索(識別ID)

送信元アドレスの参照

HTTP(S) 送信元アドレス一覧の取得・検索

XML-RPC 送信元アドレス一覧の取得送信元アドレスの検索(識別ID)

登録推移

HTTP(S) 登録推移情報の取得登録推移情報のCSV取得

XML-RPC 登録推移情報の取得登録推移情報のCSV取得

ゴミ箱

HTTP(S) ゴミ箱の検索ゴミ箱のデータ編集ゴミ箱のCSV取得ゴミ箱のデータ完全削除ゴミ箱の一括削除

XML-RPC ゴミ箱の検索ゴミ箱のデータ編集ゴミ箱のCSV取得ゴミ箱のデータ完全削除

下書き

下書きの作成・検索を行います。登録を行うと、識別IDが返ります。
エラーが発生した場合には内容に応じて以下の値が返ります。

-1:	パラメータ不正
-2:	配信予約数制限
-3:	送信者データ不正
-4:	宛先データ不正
-5:	本文文字数制限
-6:	HTMLサイズ制限
0:	登録処理に失敗

検索の際に、対象の下書きが存在しない場合には空データが返ります。

XML-RPC

https://api.bme.jp/xmlrpc/1.0/

下書きの作成

int message.draftCreate(string accessToken, struct message)

パラメータ

string accessToken	API利用許可トークン
struct message	int senderID: 送信者 int groupID: 宛先 string subject: 件名 string textPart: 本文 string htmlPart: HTMLメール用データ boolean public: バックナンバー(true: 公開する、false: 公開しない)

戻り値

int	識別ID

下書きの検索

array message.draftSearch(string accessToken)

※ 管理画面から作成したhtmlメールは下書き検索の対象になりません。

パラメータ

string accessToken	API利用許可トークン

戻り値

array	int messageID: 識別ID dateTime.iso8601 date: 登録日時 string subject: 件名 string group: 宛先 string sender: 送信者

下書きの検索(メッセージデータ)

struct message.detailSearch(string accessToken, int messageID)

※ 管理画面から作成したhtmlメールは下書き検索の対象になりません。

パラメータ

string accessToken	API利用許可トークン
int messageID	識別ID

戻り値

struct	int messageID: 識別ID int senderID: 送信者 int groupID: 宛先 string subject: 件名 string textPart: 本文 string htmlPart: HTMLメール用データ dateTime.iso8601 scheduleDate: 配信時刻 boolean public: バックナンバー(true: 公開する、false: 公開しない)

下書きの削除

struct message.listDelete(string accessToken, array messageIDs)

パラメータ

string accessToken	API利用許可トークン
array messageIDs	識別IDリスト(int)

戻り値

struct	処理結果 array success: 処理に成功した識別IDリスト array failure: 処理に失敗した識別IDリスト