PAGE TOP

読者データの検索

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

XML-RPC

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


パラメータ
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**>をご確認ください。
サンプルコード
xmlrpc_contact_list_search.php
<?php

$params = array('ログインID', 'ログインパスワード', '認証用トークン');
$options = array('encoding' => 'UTF-8', 'escaping'=>'markup');
$request = xmlrpc_encode_request('authenticate.login', $params, $options);
$context = stream_context_create(array('http' => array(
    'method' => "POST",
    'header' => "Content-Type: text/xml",
    'content' => $request
)));
$file = file_get_contents("https://api.bme.jp/xmlrpc/1.0", false, $context);
$accessToken = xmlrpc_decode($file);

$params = array($accessToken, array(1, 1));
$request = xmlrpc_encode_request('contact.listSearchByContactIDs', $params, $options);
$context = stream_context_create(array('http' => array(
    'method' => "POST",
    'header' => "Content-Type: text/xml",
    'content' => $request
)));
$file = file_get_contents("https://api.bme.jp/xmlrpc/1.0", false, $context);
$data = xmlrpc_decode($file);
print_r($data);

?> 

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


パラメータ
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アドレス
サンプルコード
xmlrpc_contact_list_search_bykeyword.php
<?php

$params = array('ログインID', 'ログインパスワード', '認証用トークン');
$options = array('encoding' => 'UTF-8', 'escaping'=>'markup');
$request = xmlrpc_encode_request('authenticate.login', $params, $options);
$context = stream_context_create(array('http' => array(
    'method' => "POST",
    'header' => "Content-Type: text/xml",
    'content' => $request
)));
$file = file_get_contents("https://api.bme.jp/xmlrpc/1.0", false, $context);
$accessToken = xmlrpc_decode($file);


$beginDate = "20110101T00:00:00";
xmlrpc_set_type($beginDate, 'datetime');
$endDate = "20121231T23:59:59";
xmlrpc_set_type($endDate, 'datetime');
$params = array($accessToken, array('キーワード'), '配信中', array(0, 10), array($beginDate, $endDate), 'error', 'ASC', 0, 15);
$request = xmlrpc_encode_request('contact.listSearch', $params, $options);
$context = stream_context_create(array('http' => array(
    'method' => "POST",
    'header' => "Content-Type: text/xml",
    'content' => $request
)));
$file = file_get_contents("https://api.bme.jp/xmlrpc/1.0", false, $context);
$data = xmlrpc_decode($file);
print_r($data);

?> 

読者データの取得


パラメータ
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形式で纏めたデータ
サンプルコード
xmlrpc_contact_list_export.php
<?php

$params = array('ログインID', 'ログインパスワード', '認証用トークン');
$options = array('encoding' => 'UTF-8', 'escaping'=>'markup');
$request = xmlrpc_encode_request('authenticate.login', $params, $options);
$context = stream_context_create(array('http' => array(
    'method' => "POST",
    'header' => "Content-Type: text/xml",
    'content' => $request
)));
$file = file_get_contents("https://api.bme.jp/xmlrpc/1.0", false, $context);
$accessToken = xmlrpc_decode($file);

$beginDate = "20110101T00:00:00";
xmlrpc_set_type($beginDate, 'datetime');
$endDate = "20121231T23:59:59";
xmlrpc_set_type($endDate, 'datetime');
$params = array($accessToken, array('キーワード'), '配信中', array(0, 10), array($beginDate, $endDate), 'error', 'ASC');
$request = xmlrpc_encode_request('contact.listExport', $params, $options);
$context = stream_context_create(array('http' => array(
    'method' => "POST",
    'header' => "Content-Type: text/xml",
    'content' => $request
)));
$file = file_get_contents("https://api.bme.jp/xmlrpc/1.0", false, $context);
$base64Data = xmlrpc_decode($file);
$data = base64_decode($base64Data->scalar);
header('Content-Disposition: attachment; filename="contact_list_export.csv"');
header('Content-Type: application/octet-stream');
header('Content-Transfer-Encoding: binary');
header('Content-Length: '.strlen($data));
print $data;

?> 

読者データの削除


パラメータ
string accessToken API利用許可トークン
array messageIDs 識別IDリスト(int)
戻り値
struct 処理結果
array success: 処理に成功した識別IDリスト
array failure: 処理に失敗した識別IDリスト
サンプルコード
xmlrpc_contact_list_delete.php
<?php

$params = array('ログインID', 'ログインパスワード', '認証用トークン');
$options = array('encoding' => 'UTF-8', 'escaping'=>'markup');
$request = xmlrpc_encode_request('authenticate.login', $params, $options);
$context = stream_context_create(array('http' => array(
    'method' => "POST",
    'header' => "Content-Type: text/xml",
    'content' => $request
)));
$file = file_get_contents("https://api.bme.jp/xmlrpc/1.0", false, $context);
$accessToken = xmlrpc_decode($file);


$params = array($accessToken, array(1));
$request = xmlrpc_encode_request('contact.listDelete', $params, $options);
$context = stream_context_create(array('http' => array(
    'method' => "POST",
    'header' => "Content-Type: text/xml",
    'content' => $request
)));
$file = file_get_contents("https://api.bme.jp/xmlrpc/1.0", false, $context);
$data = xmlrpc_decode($file);
print_r($data);

?>