API連携

API機能一覧

配信履歴の確認

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

HTTP(S)

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

配信履歴の検索

URL /message/history/search
HTTP Method(s) GET

パラメータ

必須 access_token API利用許可トークン
任意 f レスポンス形式を指定する。「xml」または「json」
offset データ取得開始位置。(指定なしの場合デフォルト:0)
limit データ取得数制限。(指定なしの場合デフォルト:25)
messageIDs 識別IDリスト※[messageIDs] が指定されていなかった場合には以下のパラメータを任意項目として設定できる
subjects 件名リスト
groups 宛先リスト
beginDate 配信日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
endDate 配信日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<messages>
<message>
<messageID>1</messageID>
<date>20120309T19:34:47</date>
<subject>件名</subject>
<group>全登録者</group>
<total>2</total>
<success>1</success>
<failure>1</failure>
<status>配信完了</status>
</message>
</messages>

【JSONの場合】

{"message":[{"messageID":1,"date":"20120309T19:34:47","subject":"件名","group":"全登録者","total":200,"success":100,"failure":100,"status":"配信完了"}]}

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

URL /message/detail/search
HTTP Method(s) GET

パラメータ

必須 access_token API利用許可トークン
messageID 識別ID
任意 f レスポンス形式を指定する。「xml」または「json」

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<message>
<messageID>1</messageID>
<senderID>1</senderID>>
<groupID>1</groupID>
<subject>件名</subject>
<textPart><![CDATA[ 本文
</textPart>
<htmlPart><![CDATA[
</htmlPart>
<scheduleDate>20120401T07:00:00</scheduleDate>
<public>false</public>
</message>

【JSONの場合】

{"groupID":1,"messageID":1,"subject":"件名","scheduleDate":"20120401T07:00:00","senderID":1,"htmlPart":"","textPart":"本文","public":false}

成功・失敗アドレスの取得

URL /history/list/export
HTTP Method(s) GET

パラメータ

必須 access_token API利用許可トークン
messageID 識別ID
status 状態(0:成功、1:失敗)

レスポンスサンプル

CSVファイルが返されます。

HTMLの開封率取得

URL /mailopenlog/list/export
HTTP Method(s) GET

パラメータ

必須 access_token API利用許可トークン
messageID 識別ID

レスポンスサンプル

CSVファイルが返されます。

配信履歴の削除

URL /message/list/delete
HTTP Method(s) POST

パラメータ

必須 access_token API利用許可トークン
messageID 識別IDリスト
任意 f レスポンス形式を指定する。「xml」または「json」

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<message>
<success>1,2</success>
<failure>3,4</failure>
</message>

【JSONの場合】

{"failure":"3,4","success":"1,2"}

まずは7日間、
無料でお試しください

無料で試してみる