API連携
読者データの検索
登録されている読者データを検索・削除・ダウンロードが行えます。
登録時に返される識別IDやキーワードを条件として検索を行います。
対象データが無い場合には空データが返ります。
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リスト |
|---|