API連携

API機能一覧

下書き

下書きの作成・検索を行います。登録を行うと、識別IDが返ります。
エラーが発生した場合には内容に応じて以下の値が返ります。

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

検索の際に、対象の下書きが存在しない場合には空データが返ります。

XML-RPC

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

下書きの作成

int message.draftCreate(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

下書きの検索

array message.draftSearch(string accessToken)

パラメータ

string accessToken API利用許可トークン

戻り値

array int messageID: 識別ID
dateTime.iso8601 date: 登録日時
string subject: 件名
string group: 宛先
string sender: 送信者

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

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

下書きの削除

struct message.listDelete(string accessToken, array messageIDs)

パラメータ

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

戻り値

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

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

無料で試してみる