PAGE TOP

ゴミ箱

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

HTTP(S)

ゴミ箱の検索


URI /contact/trash/search
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:降順。
offset データ取得開始位置。
limit データ取得数制限。1~100まで。
format, 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@blaynmail.jp</c15> 
    </contact>
</contacts>
    
【JSONの場合】
				  
				  {"contacts":[{"error":"0","status":"削除","contactID":1,"reg_day":"20120213T16:36:59","end_day":"20120312T13:45:29","c15":"sample@blaynmail.jp"}]}
				  
				  
  • contactID
  • error
  • 識別ID
  • エラー回数
  • status
  • reg_day
  • 状態(解除・削除)
  • 登録日時
  • end_day
  • c15
  • 更新日時
  • E-Mailアドレス
サンプルコード
http_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();
}

?> 

ゴミ箱のデータ編集


URI /contact/trash/update
HTTP Method(s) POST
パラメータ
必須 access_token API利用許可トークン
contactIDs 識別ID
任意 format,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"}
サンプルコード
http_contact_trash_update.php
<?php

require_once 'HTTP/Request.php';

$url = 'http://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/update';

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

$request->setMethod(HTTP_REQUEST_METHOD_POST);
$request->addPostData('access_token', $xml->access_token);
$request->addPostData('contactIDs', array(1));

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

?> 

ゴミ箱のCSV取得


URI /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:降順。
format,f レスポンス形式を指定する。「xml」または「json」
レスポンスサンプル
*CSVファイルが返されます
サンプルコード
http_contact_trash_export.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/export?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";

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

$request->setMethod(HTTP_REQUEST_METHOD_GET);

$result = $request->sendRequest();
if (!PEAR::isError($result)) {
    $buf = $request->getResponseBody();
    header('Content-Disposition: attachment; filename="contact_trash_export.csv"');
    header('Content-Type: application/octet-stream');
    header('Content-Transfer-Encoding: binary');
    header('Content-Length: '.strlen($buf));
    print $buf;
}

?> 

ゴミ箱のデータ完全削除


URI /contact/trash/delete
HTTP Method(s) POST
パラメータ
必須 access_token API利用許可トークン
contactIDs 識別ID
任意 format,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"}
サンプルコード
http_contact_trash_delete.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/delete';

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

$request->setMethod(HTTP_REQUEST_METHOD_POST);
$request->addPostData('access_token', $xml->access_token);
$request->addPostData('contactIDs', array(1));

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

?>