API連携

API機能一覧

下書き

下書きの作成・検索を行います。登録を行うと、識別IDが返ります。検索の際に、対象の下書きが存在しない場合には空データが返ります。

HTTP(S)

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

下書きの作成

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

パラメータ

必須 access_token API利用許可トークン
senderID 送信者
groupID 宛先
subject 件名
textPart 本文
任意 f レスポンス形式を指定する。「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/draft/search
HTTP Method(s) GET

パラメータ

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

レスポンスサンプル

【XMLの場合】

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<messages>
<message>
<messageID>1</messageID>
<date>20120309T11:37:01</date>
<subject>件名</subject>
<group>グループ名</group>
<sender>sample@blastmail.jp</sender>
</message>
</messages>

【JSONの場合】

{"message":[{"sender":"sample@blastmail.jp","messageID":1,"subject":"件名","group":"グループ名","date":"20120309T11:37:01"}]}
messageID 識別ID
date 登録日時
subject 件名
group 宛先
sender 送信者

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

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}
messageID 識別ID
senderID 送信者
groupID 宛先
subject 件名
textPart 本文
htmlPart HTMLメール用データ
scheduleDate 配信時刻
public バックナンバー(true:公開する、false:公開しない)

下書きの削除

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

パラメータ

必須 access_token API利用許可トークン
messageIDs 識別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日間、
無料でお試しください

無料で試してみる