PAGE TOP

配信履歴の確認

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

HTTP(S)

配信履歴の検索


URI /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":"配信完了"}]}
サンプルコード
http_message_reservation_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/message/history/search?access_token={$xml->access_token}&subjects=" . urlencode('件名') . "&groups=" . urlencode('全登録者') . "&beginDate=" . urlencode('20110101T00:00:00') . "&endDate=" . urlencode('20121231T23:59:59') . "&offset=0&limit=15";

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

$result = $request->sendRequest();
if (!PEAR::isError($result)) {
//    $xml = simplexml_load_string($request->getResponseBody(), 'SimpleXMLElement', LIBXML_NOCDATA);
//    print_r($xml);
    echo $request->getResponseBody();
}

?>

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


URI /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}
サンプルコード
http_message_reservation_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/message/detail/search?access_token={$xml->access_token}&messageID=1";

$request->reset($url);

$request->setMethod(HTTP_REQUEST_METHOD_GET);

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

?>

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


URI /history/list/export
HTTP Method(s) GET
パラメータ
必須 access_token API利用許可トークン
messageID 識別ID
status 状態(0:成功、1:失敗)
レスポンスサンプル
CSVファイルが返されます。
サンプルコード
http_history_list_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/history/list/export?access_token={$xml->access_token}&messageID=1&status=1";

$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="history_list_export.csv"');
    header('Content-Type: application/octet-stream');
    header('Content-Transfer-Encoding: binary');
    header('Content-Length: '.strlen($buf));
    print $buf;
}

?> 

HTMLの開封率取得


URI /mailopenlog/list/export
HTTP Method(s) GET
パラメータ
必須 access_token API利用許可トークン
messageID 識別ID
レスポンスサンプル
CSVファイルが返されます。
サンプルコード
http_mailopenlog_list_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/mailopenlog/list/export?access_token={$xml->access_token}&messageID=1";

$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="mailopenlog_list_export.csv"');
    header('Content-Type: application/octet-stream');
    header('Content-Transfer-Encoding: binary');
    header('Content-Length: '.strlen($buf));
    print $buf;
}

?>>

配信履歴の削除


URI /message/list/delete
HTTP Method(s) POST
パラメータ
必須 access_token API利用許可トークン
messageIDs 識別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"}
サンプルコード
http_message_list_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/message/list/delete";

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

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

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

?>