API連携

API機能一覧

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

登録されているアドレス宛に、配信設定を行います。配信設定を行うと、識別IDが返ります。
エラーが発生した場合には内容に応じて以下の値が返ります。

-1: パラメータ不正
-2: 配信予約数制限
-3: 送信者データ不正
-4: 宛先データ不正
-5: 本文文字数制限
-6: HTMLサイズ制限
0: 登録処理に失敗

XML-RPC

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

即時配信

int message.sendNowCreate(string accessToken, struct message)

パラメータ

string accessToken API利用許可トークン
struct message int senderID: 送信者
int groupID: 宛先
string subject: 件名
string textPart: 本文
string htmlPart: HTMLメール用データ
boolean public: バックナンバー(true: 公開する、false: 公開しない)

戻り値

int 識別ID

予約配信

int message.scheduleCreate(string accessToken, struct message, dateTime.iso8601 scheduleDate)

パラメータ

string accessToken API利用許可トークン
struct message int senderID: 送信者
int groupID: 宛先
string subject: 件名
string textPart: 本文
string htmlPart: HTMLメール用データ
boolean public: バックナンバー(true: 公開する、false: 公開しない)
dateTime.iso8601
scheduleDate
配信時刻

戻り値

int 識別ID