PAGE TOP

ゴミ箱

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

XML-RPC

ゴミ箱の検索


パラメータ
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_trash_search.php
<?php

require_once 'HTTP/Request.php';

$url = 'https://api.bme.jp/rest/1.0/authenticate/login';

$request =& new HTTP_Request();
$request->setURL($url);

$request->setMethod(HTTP_REQUEST_METHOD_POST);
$request->addPostData('username', 'ログインID');
$request->addPostData('password', 'ログインパスワード');
$request->addPostData('api_key', '認証用トークン');

$result = $request->sendRequest();
if (!PEAR::isError($result)) {
    $xml = simplexml_load_string($request->getResponseBody());
}

$url = "https://api.bme.jp/rest/1.0/contact/trash/search?access_token={$xml->access_token}"&keywords=" . urlencode('キーワード') . "&beginError=0&endError=10&beginDate=" . urlencode('20120201T00:00:00') . "&endDate=" . urlencode('20121231T23:59:59') . "&orderBy=error&sortOrder=ASC&offset=0&limit=100";

$request =& new HTTP_Request($url, array('useBrackets' => false));

$result = $request->sendRequest();
if (!PEAR::isError($result)) {
    echo $request->getResponseBody();
}

?> 

ゴミ箱のデータ編集


パラメータ
string accessToken API利用許可トークン
array messageIDs 識別IDリスト(int)
戻り値
struct 処理結果
array success: 処理に成功した識別IDリスト
array failure: 処理に失敗した識別IDリスト
サンプルコード
xmlrpc_contact_trash_update.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.trashUpdate', $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);

?> 

ゴミ箱のCSV取得


パラメータ
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_trash_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.trashExport', $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_trash_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_trash_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.trashDelete', $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);

?>