API連携

API機能一覧

メール新規作成 (即時配信・予約配信)

登録されているアドレス宛に、配信設定を行います。配信設定を行うと、識別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}