無料お試し

API連携

ホーム
機能一覧
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が返ります。

HTTP(S)

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

即時配信

URL	/message/sendnow/create
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
	senderID	送信者
	groupID	宛先
	subject	件名
	textPart	本文
任意	format	レスポンス形式を指定する。｢xml｣または｢json｣
	htmlPart	HTMLメール用ソースコード(String型)
	public	バックナンバー公開設定(true, false)

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<message>
<messageID>1</messageID>
</message>

【JSONの場合】

{"messageID":1}

予約配信

URL	/message/schedule/create
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
	senderID	送信者
	groupID	宛先
	subject	件名
	textPart	本文
	scheduleDate	配信時刻(ISO 8601:yyyyMMddTHH:mm:ss)
任意	format	レスポンス形式を指定する。｢xml｣または｢json｣
	htmlPart	HTMLメール用ソースコード(String型)
	public	バックナンバー公開設定(true, false)

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<message>
<messageID>1</messageID>
</message>

【JSONの場合】

{"messageID":1}