PAGE TOP

配信履歴の確認

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

XML-RPC

配信履歴の検索


パラメータ
string accessToken API利用許可トークン
array subjects 件名(string)
array groups 宛先(string)
array dates 配信日時(dateTime.iso8601)
int offset 取得開始位置
int limit 取得数上限
戻り値
array int messageID: 識別ID
dateTime.iso8601 date: 登録日時
string subject: 件名
string group: 宛先
int total: 配信数
int success: 成功
int failure: 失敗
string status: 状況(配信完了・配信完了(公開)・
配信エラー・配信エラー(公開)
サンプルコード
xmlrpc_message_history_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);


$beginDate = "20110310T15:20:37";
xmlrpc_set_type($beginDate, 'datetime');
$endDate = "20120310T15:20:37";
xmlrpc_set_type($endDate, 'datetime');
$params = array($accessToken, array('件名'), array('宛先'), array($beginDate, $endDate), 0, 15);
$request = xmlrpc_encode_request('message.historySearch', $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);

?> 

配信履歴の検索(識別ID)


パラメータ
string accessToken API利用許可トークン
array messageIDs 識別IDリスト(int)
戻り値
array int messageID: 識別ID
dateTime.iso8601 date: 登録日時
string subject: 件名
string group: 宛先
int total: 配信数
int success: 成功
int failure: 失敗
string status: 状況(配信完了・配信完了(公開)・
配信エラー・配信エラー(公開))
サンプルコード
xmlrpc_message_history_search_byid.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('message.historySearchByMessageIDs', $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 messageIDs 識別IDリスト(int)
戻り値
struct int messageID: 識別ID
int senderID: 送信者
int groupID: 宛先
string subject: 件名
string textPart: 本文
string htmlPart: HTMLメール用データ
dateTime.iso8601 scheduleDate: 配信時刻
boolean public: バックナンバー(true: 公開する、false: 公開しない)
サンプルコード
xmlrpc_message_recent_detail_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, 1);
$request = xmlrpc_encode_request('message.detailSearch', $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利用許可トークン
int messageID 識別ID
戻り値
base64 配信に成功したアドレスデータ
サンプルコード
xmlrpc_history_list_success_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);

$params = array($accessToken, 1);
$request = xmlrpc_encode_request('history.successExport', $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="history_list_success_export.csv"');
header('Content-Type: application/octet-stream');
header('Content-Transfer-Encoding: binary');
header('Content-Length: '.strlen($data));
print $data;

?>

失敗アドレスの取得


パラメータ
string accessToken API利用許可トークン
int messageID 識別ID
戻り値
base64 配信に失敗したアドレスデータ
サンプルコード
xmlrpc_history_list_failure_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);

$params = array($accessToken, 1);
$request = xmlrpc_encode_request('history.failureExport', $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="history_list_failure_export.csv"');
header('Content-Type: application/octet-stream');
header('Content-Transfer-Encoding: binary');
header('Content-Length: '.strlen($data));
print $data;

?> 

HTMLの開封率取得


パラメータ
string accessToken API利用許可トークン
int messageID 識別ID
戻り値
base64 開封した読者データ
サンプルコード
xmlrpc_mailopenlog_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);

$params = array($accessToken, 1);
$request = xmlrpc_encode_request('mailopenlog.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="clicklog_detail_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: 処理成功(int)
array failure: 処理失敗(int)
サンプルコード
xmlrpc_message_recent_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('message.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);

?>