API連携｜APIソース公開

APIについて

「HTTP(S)」「XML-RPC」の2種類の連携方式に対応

HTTP(S)

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

XML-RPC

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

APIでできること

顧客データの連携

読者データの登録/編集/削除など個別/一括の処理でデータベースの同期処理が可能です。

配信予約の連携

メールセールスに登録されている読者データに対してメール本文や配信時間を指定して自動配信が行えます。

配信結果の連携

配信結果（成功数/失敗数）、エラーアドレス、解除、開封率の結果を取得できます。

ログイン・ログアウト

HTTP(S)
XML-RPC

APIを利用する時の認証処理。ログインでAPI利用に必要な「access Token」を発行し継続して処理が行えるようになります。ログアウト時は、「access Token」を破棄します。

HTTP(S)

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

必須	username	メールセールスID
password	パスワード
api_key	API利用キー
任意	f	レスポンス形式を指定する。「xml」または「json」

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<authenticate>
<access_token>6b02e6b331ba2c06ec9d8bf51a6d1af4</access_token>
</authenticate>

JSONの場合

{"accessToken":"6b02e6b331ba2c06ec9d8bf51a6d1af4"}

ログアウト

URL	/authenticate/logout
HTTP Method(s)	GET

パラメータ

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

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<authenticate>
<message>Log out</message>
</authenticate>

XML-RPC

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

ログアウト

boolean authenticate.logout(string accessToken)

パラメータ

string accessToken

API利用許可トークン

戻り値

boolean	処理結果
	TRUE: 正常に処理が行われた
	FALSE: 処理中にエラーが発生した

メール新規作成（即時配信・予約配信）

HTTP(S)
XML-RPC

登録されているアドレス宛に、配信設定を行います。配信設定を行うと、識別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	本文
任意	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/schedule/create
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
	senderID	送信者
	groupID	宛先
	subject	件名
	textPart	本文
	scheduleDate	配信時刻(ISO 8601:yyyyMMddTHH:mm:ss)
任意	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}

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

下書き

HTTP(S)
XML-RPC

下書きの作成・検索を行います。登録を行うと、識別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@mailsales.jp</sender>
</message>
</messages>

JSONの場合

{"message":[{"sender":"sample@mailsales.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利用許可トークン
必須	messageID	識別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"}

下書きの作成・検索を行います。登録を行うと、識別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)

パラメータ

access_token

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リスト

予約状況の確認

HTTP(S)
XML-RPC

配信待ち一覧データを検索・削除します。対象が無い場合には空データが返ります。削除は、新規作成メールの登録時に返りますユニークな識別IDを条件に行い、削除に成功、あるいは失敗しても識別IDリストが返ります。

HTTP(S)

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

予約状況の検索

URL	/message/reservation/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>20120309T19:34:47</date>
<subject>件名</subject>
<group>全登録者</group>
<sender>sample@mailsales.jp</sender>
<reciepients>1</reciepients>
<status>配信待ち</status>
</message>
</messages>

JSONの場合

{"message":[{"sender":"sample@mailsales.jp","messageID":1,"status":"配信待ち","reciepients":1,"subject":"件名","group":"全登録者","date":"20120309T19:34:47"}]}

messageID	識別ID
date	登録日時
subject	件名
group	宛先
sender	送信者
total	配信数
status	状況(編集中・編集中(公開)・配信待ち・配信待ち(公開)・配信中・配信中(公開)

予約状況の検索(メッセージデータ)

URL	/message/detail/search
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
必須	messageID	識別ID(int)
任意	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利用許可トークン
必須	messageID	識別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"}

XML-RPC

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

予約状況の検索

array message.reservationSearch(string accessToken)

パラメータ

string accessToken

API利用許可トークン

戻り値

array	int messageID: 識別ID
	dateTime.iso8601 date: 登録日時
	string subject: 件名
	string group: 宛先
	string sender: 送信者
	int total: 配信数
	string status: 状況(編集中・編集中(公開)・配信待ち・配信待ち(公開)・配信中・配信中(公開)

予約状況の検索(識別ID)

array message.reservationSearchByMessageIDs(string accessToken, array messageIDs)

パラメータ

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

戻り値

array	int messageID: 識別ID
	dateTime.iso8601 date: 登録日時
	string subject: 件名
	string group: 宛先
	string sender: 送信者
	int total: 配信数
	string status: 状況(編集中・編集中(公開)・配信待ち・配信待ち(公開)・配信中・配信中(公開))

予約状況の検索(メッセージデータ)

struct message.detailSearch(string accessToken, int messageID)

パラメータ

string accessToken	API利用許可トークン
int messageID	識別ID(int)

戻り値

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リスト

戻り値

struct	array success: 処理成功(int)
	array failure: 処理失敗(int)

配信履歴の確認

HTTP(S)
XML-RPC

配信完了一覧データを検索・削除します。検索は、件名等を条件に行い、対象が無い場合には空データが返ります。削除は、新規作成メールの登録時に返ります。ユニークな識別IDを条件に行い、削除に成功、あるいは失敗しても識別IDリストが返ります。

HTTP(S)

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

配信履歴の検索

URL	/message/history/search
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣
	offset	データ取得開始位置。(指定なしの場合デフォルト:0)
	limit	データ取得数制限。(指定なしの場合デフォルト:25)
	messageIDs	識別IDリスト※[messageIDs] が指定されていなかった場合には以下のパラメータを任意項目として設定できる
	subjects	件名リスト
	groups	宛先リスト
	beginDate	配信日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
	endDate	配信日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<messages>
<message>
<messageID>1</messageID>
<date>20120309T19:34:47</date>
<subject>件名</subject>
<group>全登録者</group>
<total>2</total>
<success>1</success>
<failure>1</failure>
<status>配信完了</status>
</message>
</messages>

JSONの場合

{"message":[{"messageID":1,"date":"20120309T19:34:47","subject":"件名","group":"全登録者","total":200,"success":100,"failure":100,"status":"配信完了"}]}

配信履歴の検索(メッセージデータ)

URL	/message/detail/search
HTTP Method(s)	GET

パラメータ

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

レスポンスサンプル

XMLの場合

JSONの場合

{"groupID":1,"messageID":1,"subject":"件名","scheduleDate":"20120401T07:00:00","senderID":1,"htmlPart":"","textPart":"本文","public":false}

成功・失敗アドレスの取得

URL	/history/list/export
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
	messageID	識別ID
	status	状態(0:成功、1:失敗)

レスポンスサンプル

CSVファイルが返されます。

HTMLの開封率取得

URL	/mailopenlog/list/export
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
必須	messageID	識別ID

レスポンスサンプル

CSVファイルが返されます。

配信履歴の削除

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

パラメータ

必須	access_token	API利用許可トークン
必須	messageID	識別IDリスト
任意	ｆ	レスポンス形式を指定する。｢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"}

XML-RPC

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

配信履歴の検索

array message.historySearch(string accessToken, array subjects, array groups, array dates, int offset, int limit)

パラメータ

string accessToken	API利用許可トークン
array subjects	件名(string)
array groups	宛先(string)
array dates	配信日時(dateTime.iso8601)
int offset	取得開始位置
int limit	取得数上限

戻り値

array	int messageID: 識別ID
	dateTime.iso8601 date: 登録日時
	string subject: 件名
	string group: 宛先
	int total: 配信数
	int success: 成功
	int failure: 失敗
	string status: 状況(配信完了・配信完了(公開)・配信エラー・配信エラー(公開)

配信履歴の検索(識別ID)

array message.historySearchByMessageIDs(string accessToken, array messageIDs)

パラメータ

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

戻り値

array	int messageID: 識別ID
	dateTime.iso8601 date: 登録日時
	string subject: 件名
	string group: 宛先
	int total: 配信数
	int success: 成功
	int failure: 失敗
	string status: 状況(配信完了・配信完了(公開)・配信エラー・配信エラー(公開))

配信履歴の検索(メッセージデータ)

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

成功アドレスの取得

base64 history.successExport(string accessToken, int messageID)

パラメータ

string accessToken	API利用許可トークン
array messageID	識別ID

戻り値

base64

配信に成功したアドレスデータ

失敗アドレスの取得

base64 mailopenlog.listExport(string accessToken, int messageID)

パラメータ

string accessToken	API利用許可トークン
int messageID	識別ID

戻り値

base64

配信に失敗したアドレスデータ

HTMLの開封率取得

base64 mailopenlog.listExport(string accessToken, int messageID)

パラメータ

string accessToken	API利用許可トークン
int messageID	識別ID

戻り値

base64

開封した読者データ

配信履歴の削除

struct message.listDelete(string accessToken, array messageIDs)

パラメータ

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

戻り値

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

バックナンバー

HTTP(S)
XML-RPC

バックナンバー一覧情報を検索します。対象が無い場合には空データが返ります。

HTTP(S)

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

バックナンバー一覧の検索(詳細)

URL	/message/backnumber/detail/search
HTTP Method(s)	GET

パラメータ

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

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages>
<message>
<messageID>1</messageID>
<subject>件名</subject>
<textPart><![CDATA[本文]]></textPart>
<htmlPart><![CDATA[]]></htmlPart>
<date>20120313T17:41:19</date>
</message>
</messages>

JSONの場合

{"message":[{"messageID":1,"subject":"件名","htmlPart":"","textPart":"本文","date":"20120313T17:41:19"}]}

messageID	識別ID
subject	件名
htmlPart	HTMLデータ
date	配信日時
textPart	本文

バックナンバー一覧情報を検索します。対象が無い場合には空データが返ります。

XML-RPC

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

バックナンバー一覧の検索(詳細)

array message.backnumberDetailSearch(string accessToken)

パラメータ

string accessToken

API利用許可トークン

戻り値

array	int messageID: 識別ID
	string subject: 件名
	string textPart: 本文
	string htmlPart: HTMLデータ
	dateTime.iso8601 date: 配信日時

個別登録

HTTP(S)
XML-RPC

読者データの個別登録・検索・編集を行います。登録を行うと、識別IDが返ります。

HTTP(S)

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

個別登録

URL	/contact/detail/create
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
必須	※	項目設計において利用・必須としている項目を設定しますなお各項目名については、管理画面の新規作成にある“差込み”から<c**>をご確認ください以下のパラメータの設定も行えます status: 状態(配信中・配信停止・解除・削除・エラー停止) error: エラー回数
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣
任意	※	項目設計において利用・必須としている項目を設定しますなお各項目名については、管理画面の新規作成にある“差込み”から<c**>をご確認ください以下のパラメータの設定も行えます status: 状態(配信中・配信停止・解除・削除・エラー停止) error: エラー回数

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contact>
<contactID>1</contactID>
</contact>>

JSONの場合

{"contactID":1}

個別検索

URL	/contact/detail/search
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
必須	contactID or email	識別ID又はE-Mail
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contact>
<contactID>1</contactID>
<error>0</error>
<status>配信中</status>
<c15>sample@mailsales.jp</c15>
</contact>

JSONの場合

{"error":"0","status":"配信中","contactID":49,"c15":"sample@mailsales.jp"}

contactID	識別ID
error	エラー回数
status	状態(配信中・配信停止・解除・削除・エラー停止)

個別編集

URL	/contact/detail/update
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
必須	contactID	識別ID
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣
任意	※	項目設計において利用・必須としている項目を設定しますなお各項目名については、管理画面の新規作成にある“差込み”から<c**>をご確認ください以下のパラメータの設定も行えます status: 状態(配信中・配信停止・解除・削除・エラー停止) error: エラー回数

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contact>
<contactID>1</contactID>
</contact>

JSONの場合

{"contactID":1}

読者データの個別登録・検索・編集を行います。登録を行うと、識別IDが返ります。エラーが発生した場合には内容に応じて以下の値が返ります。

-1: パラメータ不正
-2: 登録上限
-3: アドレス重複
0: 登録処理に失敗

XML-RPC

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

個別登録

int contact.detailCreate(string accessToken, struct contact)

パラメータ

string accessToken	API利用許可トークン
struct contact	項目設計において利用・必須としている項目を設定しますなお各項目名については、管理画面の新規作成にある“差込み”から<c**>をご確認ください以下のパラメータの設定も行えます string status: 状態(配信中・配信停止・解除・削除・エラー停止) int error: エラー回数

戻り値

int

識別ID

個別検索(識別ID)

struct contact.detailSearchByContactID(string accessToken, int contactID)

パラメータ

string accessToken	API利用許可トークン
int contactID	識別ID

戻り値

struct

項目設計において利用・必須としている項目と以下の情報を含んでいます

int contactID: 識別ID
int error: エラー回数
string status: 状態(配信中・配信停止・解除・削除・エラー停止)

個別検索(E-Mail)

struct contact.detailSearchByEmail(string accessToken, string email)

パラメータ

string accessToken	API利用許可トークン
string email	E-Mailアドレス

戻り値

struct

個別編集

int contact.detailUpdate(string accessToken, int contactID, struct contact)

パラメータ

string accessToken	API利用許可トークン
int contactID	識別ID
struct contact	項目設計において利用・必須としている項目を設定します以下のパラメータの設定も行えます string status: 状態(配信中・配信停止・解除・削除・エラー停止) int error: エラー回数

戻り値

int

識別ID

一括登録・削除

HTTP(S)
XML-RPC

指定フォーマットのCSV形式データから読者データの一括登録・削除処理を行います。
登録方法は全登録・新規登録のみ・アップデートのみ、の3種類で行い
成功数・失敗数・失敗詳細情報がそれぞれ返ります。

削除方法はデータ削除、のみから行われ、成功数・失敗数・失敗詳細情報が返ります。
尚、登録削除でも指定フォーマットのCSVのダウンロードが必要です。

CSVで日付型をご利用いただく場合は、半角数字を続けてご入力ください。
例)2013年1月1日 → 20130101

HTTP(S)

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

登録・削除用CSVデータ取得

URL	/contact/import/usage
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
必須	type	CSV形式(1:登録用, 2:削除用)

レスポンスサンプル

※CSVファイルが返されます

一括登録(全登録)

URL	/contact/import/all
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>1</success>
<failure>1</failure>
<details>
<detail>
<lineNumber>2</lineNumber>
<content>"配信中","0","sample@mailsales.jp"</content>
<message>[エラー内容]</message>
</detail>
</details>
</contact>

JSONの場合

{"success":"1","failure":"1","details":{"detail":[{"content":"\"エラー停止\",\"3\",\"sample@mailsales.jp\"","message":"[エラー内容]","lineNumber":2}]}}

一括登録(新規登録のみ)

URL	/contact/import/create
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣

レスポンスサンプル

XMLの場合

JSONの場合

{"success":"1","failure":"1","details":{"detail":[{"content":"\"エラー停止\",\"3\",\"sample@mailsales.jp\"","message":"[エラー内容]","lineNumber":2}]}}

一括登録(アップデートのみ)

URL	/contact/import/update
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣

レスポンスサンプル

XMLの場合

JSONの場合

{"success":"1","failure":"1","details":{"detail":[{"content":"\"エラー停止\",\"3\",\"sample@mailsales.jp\"","message":"[エラー内容]","lineNumber":2}]}}

一括削除

URL	/contact/import/delete
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>1</success>
<failure>1</failure>
<details>
<detail>
<lineNumber>2</lineNumber>
<content>"sample@mailsales.jp"</content>
<message>[エラー内容]</message>
</detail>
</details>
</contact>

JSONの場合

{"success":"1","failure":"1","details":{"detail":[{"content":"\"sample@mailsales.jp\"","message":"[エラー内容]","lineNumber":3}]}}

一括処理エラー一覧検索

URL	/contact/import/error/search
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣
	createErrors	登録エラー。日時(ISO 8601:yyyyMMddTHH:mm:ss)を指定
	deleteErrors	削除エラー。日時(ISO 8601:yyyyMMddTHH:mm:ss)を指定

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contacts>
<contact>
<type>登録エラー</type>
<date>20120312T22:28:54</date>
<count>1</count>
</contact>
</contacts>

JSONの場合

{"contact":[{"count":1,"date":"20120312T22:28:54","type":"登録エラー"}]}

一括処理エラーCSV取得

URL	/contact/import/error/export
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
	type	｢登録エラー｣または｢削除エラー｣
	date	日時(ISO 8601:yyyyMMddTHH:mm:ss)を指定

レスポンスサンプル

※CSVファイルが返されます

一括処理エラー情報削除

URL	/contact/import/error/delete
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣
	createErrors	登録エラー。日時(ISO 8601:yyyyMMddTHH:mm:ss)を指定
	deleteErrors	削除エラー。日時(ISO 8601:yyyyMMddTHH:mm:ss)を指定

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>20120312T22:28:54</success>
<failure />
</contact>

JSONの場合

{"failure": "","success": "20180509T15:01:31"}

XML-RPC

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

登録用CSVデータ取得

base64 contact.importUsageCreate(string accessToken)

パラメータ

string accessToken

API利用許可トークン

戻り値

base64

登録用CSV形式データ

削除用CSVデータ取得

base64 contact.importUsageDelete(string accessToken)

パラメータ

string accessToken

API利用許可トークン

戻り値

base64

削除用CSV形式データ

一括登録(全登録)

struct contact.importAll(string accessToken, base64 base64Data)

パラメータ

string accessToken	API利用許可トークン
base64 base64Data	登録用CSV形式データ

戻り値

struct	int success: 成功数
	int failure: 失敗数
	array details: エラー内容の詳細情報
	int lineNumber: 行番号
	string message: エラー内容
	string content: 行内容

一括登録(新規登録のみ)

struct contact.importCreate(string accessToken, base64 base64Data)

パラメータ

string accessToken	API利用許可トークン
base64 base64Data	登録用CSV形式データ

戻り値

struct	int success: 成功数
	int failure: 失敗数
	array details: エラー内容の詳細情報
	int lineNumber: 行番号
	string message: エラー内容
	string content: 行内容

一括登録(アップデートのみ)

struct contact.importCreate(string accessToken, base64 base64Data)

パラメータ

string accessToken	API利用許可トークン
base64 base64Data	登録用CSV形式データ

戻り値

struct	int success: 成功数
	int failure: 失敗数
	array details: エラー内容の詳細情報
	int lineNumber: 行番号
	string message: エラー内容
	string content: 行内容

一括削除

struct contact.importDelete(string accessToken, base64 base64Data)

パラメータ

string accessToken	API利用許可トークン
base64 base64Data	削除用CSV形式データ

戻り値

struct	int success: 成功数
	int failure: 失敗数
	array details: エラー内容の詳細情報
	int lineNumber: 行番号
	string message: エラー内容
	string content: 行内容

一括処理エラー一覧検索

array contact.importErrorSearch(string accessToken)

パラメータ

string accessToken

API利用許可トークン

戻り値

array	string type: エラータイプ(登録エラー・削除エラー)
	dateTime.iso8601 date: 処理日時
	int count: 件数

一括処理エラー一覧検索(日付条件)

array contact.importErrorSearchByDates(string accessToken, array createErrors, array deleteErrors)

パラメータ

string accessToken	API利用許可トークン
array createErrors	登録エラーリスト(dateTime.iso8601)
array deleteErrors	削除エラーリスト(dateTime.iso8601)

戻り値

array	string type: エラータイプ(登録エラー・削除エラー)
	dateTime.iso8601 date: 処理日時
	int count: 件数

一括処理エラーCSV取得

base64 contact.importErrorExport(string accessToken, string type, dateTime.iso8601 date)

パラメータ

string accessToken	API利用許可トークン
string type	エラータイプ(登録エラー・削除エラー)
dateTime.iso8601 date	処理日時

戻り値

base64

エラー情報のCSV形式データ

一括処理エラー情報削除

struct contact.importErrorDelete(string accessToken, array createErrors, array deleteErrors)

パラメータ

string accessToken	API利用許可トークン
array createErrors	登録エラーリスト(dateTime.iso8601)
array deleteErrors	削除エラーリスト(dateTime.iso8601)

戻り値

struct	array success: 処理成功(dateTime.iso8601)
	array failure: 処理失敗(dateTime.iso8601)

読者データの検索

HTTP(S)
XML-RPC

登録されている読者データを検索・削除・ダウンロードが行えます。
登録時に返される識別IDやキーワードを条件として検索を行います。
対象データが無い場合には空データが返ります。

HTTP(S)

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

読者データの検索

URL	/contact/list/search
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣
	contactIDs	識別IDリスト※[contactIDs] が指定されていなかった場合には以下のパラメータを任意項目として設定できる
	keywords	キーワードリスト
	status	状態(配信中/配信停止/解除/削除/エラー停止)
	beginError	配信エラー数(開始位置)
	endError	配信エラー数(終了位置)
	beginDate	新規登録日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
	endDate	新規登録日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss
	orderBy	並べ替え対象フィールド
	sortOrder	順序。ASC：昇順、DESC：降順
	offset	データ取得開始位置。
	limit	データ取得数制限。1～100まで。

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contacts>
<contact>
<contactID>1</contactID>
<error>0</error>
<status>配信中</status>
<reg_day>20120101T00:00:00</reg_day>
<end_day>20120101T00:00:00</end_day>
<c15>sample@mailsales.jp</c15>
</contact>
<contacts>

JSONの場合

{"contacts":[{"error":"0","status":"配信中","contactID":1,"reg_day":"20120101T00:00:00","end_day":"20120101T00:00:00","c15":"sample@mailsales.jp"}]}

contactID	識別ID
error	エラー回数
status	状態(配信中・配信停止・エラー停止)
reg_day	登録日時
end_day	更新日時
c15	E-Mailアドレス

読者データの取得

URL	/contact/list/export
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
任意	keywords	キーワード。｢,｣区切りで複数指定。
	status	状態(配信中/配信停止/エラー停止)。
	beginError	配信エラー数(開始位置)
	endError	配信エラー数(終了位置)
	beginDate	新規登録日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
	endDate	新規登録日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss
	orderBy	並べ替え対象フィールド
	sortOrder	順序。ASC：昇順、DESC：降順。

レスポンスサンプル

※CSVファイルが返されます

読者データの削除

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

パラメータ

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

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contact>
<success>1,2</success>
<failure>3</failure>
</contact>

XML-RPC

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

読者データの検索(識別ID)

array contact.listSearchByContactIDs(string accessToken, array contactIDs)

パラメータ

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

戻り値

array	int contactID: 識別ID
	int error: エラー回数
	string status: 状態(配信中・配信停止・エラー停止)
	dateTime.iso8601 reg_day: 登録日時
	dateTime.iso8601 end_day: 更新日時
	string c15: E-Mailアドレス
	※その他の項目名については、管理画面の新規作成にある “差込み”から<c**>をご確認ください。

読者データの検索(複数条件)

array contact.listSearch(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アドレス

読者データの取得

base64 contact.listExport(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.listDelete(string accessToken, array contactIDs)

パラメータ

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

戻り値

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

配信グループの参照

HTTP(S)
XML-RPC

登録されている配信グループの一覧情報を取得できます。
データが無い場合には空データが返ります。

HTTP(S)

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

グループ一覧の取得・検索

URL	/group/list/search
HTTP Method(s)	GET

パラメータ

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

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<groups>
<group>
<groupID>1</groupID>
<name>全登録者</name>
</group>
</groups>

JSONの場合

{"group":[{"groupID":1,"name":"全登録者"}]}

groupID	識別ID
name	グループ名

登録されている配信グループの一覧情報を取得できます。
データが無い場合には空データが返ります。

XML-RPC

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

グループ一覧の取得

array group.listSearch(string accessToken)

パラメータ

string accessToken

API利用許可トークン

戻り値

array	int groupID: 識別ID
	string name: グループ名

グループの検索(識別ID)

array group.listSearchByGroupIDs(string accessToken, array groupIDs)

パラメータ

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

戻り値

struct	int groupID: 識別ID
	string name: グループ名

送信元アドレスの参照

HTTP(S)
XML-RPC

登録されている送信元アドレスの一覧情報を取得できます。
データが無い場合には空データが返ります。

HTTP(S)

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

送信元アドレス一覧の取得・検索

URL	/sender/list/search
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
任意	format,f	レスポンス形式を指定する。｢xml｣または｢json｣
	senderIDs	識別ID
	keywords	キーワード。｢,｣区切りで複数指定。

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<senders>
<sender>
<senderID>1</senderID>
<personal>セールスディビジョン</personal>
<address>support@mailsales.jp</address>
</sender>
</senders>

JSONの場合

{"sender":[{"personal":"セールスディビジョン","address":"support@mailsales.jp","senderID":1}]}

senderID	識別ID
personal	表示名
address	送信元アドレス

登録されている送信元アドレスの一覧情報を取得できます。
データが無い場合には空データが返ります。

XML-RPC

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

送信元アドレス一覧の取得

array sender.listSearch(string accessToken)

パラメータ

string accessToken

API利用許可トークン

戻り値

array	int senderID: 識別ID
	string personal: 表示名
	string address: 送信元アドレス

送信元アドレスの検索(識別ID)

array sender.listSearchBySenderIDs(string accessToken, array senderIDs)

パラメータ

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

戻り値

struct	int senderID: 識別ID
	string personal: 表示名
	string address: 送信元アドレス

登録推移

HTTP(S)
XML-RPC

登録推移情報を、対象の日付範囲を条件に取得します。
対象データが無い場合には空データが返ります。

HTTP(S)

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

登録推移情報の取得

URL	/statuslog/list/search
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
	beginDate	日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
	endDate	日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<statuslogs>
<statuslog>
<date>20120201</date>
<total>0</total>
<increase>0</increase>
<decrease>0</decrease>
<statTotal>2</statTotal>
<statSend>0</statSend>
<statStop>0</statStop>
<statDelete>2</statDelete>
<statError>0</statError>
<statCancel>0</statCancel>
</statuslog>
</statuslogs>

JSONの場合

{"statuslog":[{"total":0,"statCancel":0,"statTotal":2,"statSend":0,"statStop":0,"statError":0,"increase":0,"date":"20120201","decrease":0,"statDelete":2}]}

date	集計日
increase	増加数
decrease	減少数
total	本日の状況
statSend	配信中
statStop	配信停止
statDelete	削除
statError	エラー停止
statCancel	解除
statTotal	登録総数

登録推移情報のCSV取得

URL	/statuslog/list/export
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
	beginDate	日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
	endDate	日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss

レスポンスサンプル

※CSVファイルが返されます

登録推移情報を、対象の日付範囲を条件に取得します。
対象データが無い場合には空データが返ります。

XML-RPC

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

登録推移情報の取得

array statuslog.listSearch(string accessToken, string beginDate, string endDate)

パラメータ

string accessToken	API利用許可トークン
string beginDate	取得範囲(開始)
string endDate	取得範囲(終了)

戻り値

array	string date: 集計日
	int increase: 増加数
	int decrease: 減少数
	int total: 本日の状況
	int statSend: 配信中
	int statStop: 配信停止
	int statDelete: 削除
	int statError: エラー停止
	int statCancel: 解除
	int statTotal: 登録総数

登録推移情報のCSV取得

base64 statuslog.listExport(string accessToken, string beginDate, string endDate)

パラメータ

string accessToken	API利用許可トークン
string beginDate	取得範囲(終了)
string endDate	取得範囲(終了)

戻り値

base64

登録推移データ

ゴミ箱

HTTP(S)
XML-RPC

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

HTTP(S)

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

ゴミ箱の検索

URL	/contact/trash/search
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
任意	contactIDs	識別IDリスト ※contactIDsの指定がなかった場合には、以下のパラメータの指定が可能
	keywords	キーワード。｢,｣区切りで複数指定。
	status	状態(削除/解除)。
	beginError	配信エラー数(開始位置)
	endError	配信エラー数(終了位置)
	beginDate	登録解除日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
	endDate	登録解除日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss
	orderBy	並べ替え対象フィールド
	sortOrder	順序。ASC：昇順、DESC：降順。
	offset	データ取得開始位置。
	limit	データ取得数制限。1～100まで。
	f	レスポンス形式を指定する。｢xml｣または｢json｣

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<contacts>
<contact>
<contactID>1</contactID>
<error>0</error>
<status>削除</status>
<reg_day>20120213T16:36:59</reg_day>
<end_day>20120312T13:45:29</end_day>
<c15>sample@mailsales.jp</c15>
</contact>
</contacts>

JSONの場合

{"contacts":[{"error":"0","status":"削除","contactID":1,"reg_day":"20120213T16:36:59","end_day":"20120312T13:45:29","c15":"sample@mailsales.jp"}]}

contactID	識別ID
error	エラー回数
status	状態(解除・削除)
reg_day	登録日時
end_day	更新日時
c15	E-Mailアドレス

ゴミ箱のデータ編集

URL	/contact/trash/update
HTTP Method(s)	POST

パラメータ

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

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>1,2</success>
<failure>3,4</failure>
</contact>

JSONの場合

{"failure":"3,4","success":"1,2"}

ゴミ箱のCSV取得

URL	/contact/trash/export
HTTP Method(s)	GET

パラメータ

必須	access_token	API利用許可トークン
任意	keywords	キーワード。｢,｣区切りで複数指定。
	status	状態(削除/解除)。
	beginError	配信エラー数(開始位置)
	endError	配信エラー数(終了位置)
	beginDate	登録解除日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
	endDate	登録解除日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss
	orderBy	並べ替え対象フィールド
	sortOrder	順序。ASC：昇順、DESC：降順。

レスポンスサンプル

※CSVファイルが返されます

ゴミ箱のデータ完全削除

URL	/contact/trash/delete
HTTP Method(s)	POST

パラメータ

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

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>1,2</success>
<failure>3,4</failure>
</contact>

JSONの場合

{"failure":"3,4","success":"1,2"}

ゴミ箱の一括削除

URL	/contact/trash/truncate
HTTP Method(s)	POST

パラメータ

必須	access_token	API利用許可トークン
必須	status	状態(DELETE/CANCEL)。DELETEは「ゴミ箱」、CANCELは「解除」が対象
任意	f	レスポンス形式を指定する。｢xml｣または｢json｣

レスポンスサンプル

XMLの場合

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<contact>
<success>1,2</success>
<failure>3,4</failure>
</contact>

JSONの場合

{"failure":"3,4","success":"1,2"}

登録推移情報を、対象の日付範囲を条件に取得します。
対象データが無い場合には空データが返ります。

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リスト

string username	メールセールスID
string password	パスワード
string apikey	API利用キー