API連携

API機能一覧

ゴミ箱

ゴミ箱内の読者データを取得・編集・削除・ダウンロードが行えます。
対象データが無い場合には空データが返ります。

XML-RPC

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

ゴミ箱の検索

array contact.trashSearch(string accessToken, array keywords, string status, array errors, array dates, string orderBy, string sortOrder, int offset, int limit)

パラメータ

string accessToken API利用許可トークン
array keywords 検索キーワードリスト(string)
string status 状態(解除/削除)
array errors エラー回数範囲(int)
array dates 削除日時範囲(dateTime.iso8601)
string orderBy ソート条件
define.listSearchで取得されるdefineIDを指定できます
string sortOrder ソート方向(ASC: 昇順、DESC: 降順)
int offset 取得開始位置
int limit 取得数上限(100以下を指定)

戻り値

array int contactID: 識別ID
int error: エラー回数
string status: 状態(解除/削除)
dateTime.iso8601 reg_day: 登録日時
dateTime.iso8601 end_day: 更新日時
string c15: E-Mailアドレス

ゴミ箱のデータ編集

struct contact.trashUpdate(string accessToken, array contactIDs)

パラメータ

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

戻り値

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

ゴミ箱のCSV取得

base64 contact.trashExport(string accessToken, array keywords, string status, array errors, array dates, string orderBy, string sortOrder)

パラメータ

string accessToken API利用許可トークン
array keywords 検索キーワードリスト(string)
string status 状態(解除/削除)
array errors エラー回数範囲(int)
array dates 削除日時範囲(dateTime.iso8601)
string orderBy ソート条件
define.listSearchで取得されるdefineIDを指定できます
string sortOrder ソート方向(ASC: 昇順、DESC: 降順)

戻り値

base64 ゴミ箱データをCSV形式で纏めたデータ

ゴミ箱のデータ完全削除

struct contact.trashDelete(string accessToken, array contactIDs)

パラメータ

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

戻り値

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