API連携

API機能一覧

配信履歴の確認

配信完了一覧データを検索・削除します。検索は、件名等を条件に行い、対象が
無い場合には空データが返ります。削除は、新規作成メールの登録時に返ります。
ユニークな識別IDを条件に行い、削除に成功、あるいは失敗しても識別IDリストが
返ります。

XML-RPC

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

配信履歴の検索

array message.historySearch(string accessToken, array subjects, array groups, array dates, int offset, int limit)

パラメータ

string accessToken API利用許可トークン
array subjects 件名(string)
array groups 宛先(string)
array dates 配信日時(dateTime.iso8601)
int offset 取得開始位置
int limit 取得数上限

戻り値

array int messageID: 識別ID
dateTime.iso8601 date: 登録日時
string subject: 件名
string group: 宛先
int total: 配信数
int success: 成功
int failure: 失敗
string status: 状況(配信完了・配信完了(公開)・配信エラー・配信エラー(公開)

配信履歴の検索(識別ID)

array message.historySearchByMessageIDs(string accessToken, array messageIDs)

パラメータ

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

戻り値

array int messageID: 識別ID
dateTime.iso8601 date: 登録日時
string subject: 件名
string group: 宛先
int total: 配信数
int success: 成功
int failure: 失敗
string status: 状況(配信完了・配信完了(公開)・配信エラー・配信エラー(公開))

配信履歴の検索(メッセージデータ)

struct message.detailSearch(string accessToken, int messageID)

パラメータ

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: 公開しない)

成功アドレスの取得

base64 history.successExport(string accessToken, int messageID)

パラメータ

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

戻り値

base64 配信に成功したアドレスデータ

失敗アドレスの取得

base64 history.failureExport(string accessToken, int messageID)

パラメータ

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

戻り値

base64 配信に失敗したアドレスデータ

HTMLの開封率取得

base64 mailopenlog.listExport(string accessToken, int messageID)

パラメータ

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

戻り値

base64 開封した読者データ

配信履歴の削除

struct message.listDelete(string accessToken, array messageIDs)

パラメータ

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

戻り値

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