PAGE TOP

登録推移

登録推移情報を、対象の日付範囲を条件に取得します。
対象データが無い場合には空データが返ります。

HTTP(S)

登録推移情報の取得


URI /statuslog/list/search
HTTP Method(s) GET
パラメータ
必須 access_token API利用許可トークン
beginDate 日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
endDate 日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss
任意 format,f レスポンス形式を指定する。「xml」または「json」
レスポンスサンプル
【XMLの場合】
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<statuslogs>
    <statuslog>
        <date>20120201</date> 
        <total>0</total> 
        <increase>0</increase> 
        <decrease>0</decrease> 
        <statTotal>2</statTotal> 
        <statSend>0</statSend> 
        <statStop>0</statStop> 
        <statDelete>2</statDelete> 
        <statError>0</statError> 
        <statCancel>0</statCancel> 
    </statuslog>
</statuslogs>
    
【JSONの場合】
				  
				  {"statuslog":[{"total":0,"statCancel":0,"statTotal":2,"statSend":0,"statStop":0,"statError":0,"increase":0,"date":"20120201","decrease":0,"statDelete":2}]}
				  
				  
  • date
  • increase
  • decrease
  • total
  • 集計日
  • 増加数
  • 減少数
  • 本日の状況
  • statSend
  • statStop
  • statDelete
  • 配信中
  • 配信停止
  • 削除
  • statError
  • statCancel
  • statTotal
  • エラー停止
  • 解除
  • 登録総数
サンプルコード
http_statuslog_list_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/statuslog/list/search?access_token={$xml->access_token}&beginDate=20120201&endDate=20120201";

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

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

?> 

登録推移情報のCSV取得


URI /message/draft/create
HTTP Method(s) POST
パラメータ
必須 access_token API利用許可トークン
beginDate 日時(開始位置)。ISO 8601:yyyyMMddTHH:mm:ss
endDate 日時(終了位置)。ISO 8601:yyyyMMddTHH:mm:ss
任意 format,f レスポンス形式を指定する。「xml」または「json」
レスポンスサンプル
*CSVファイルが返されます
サンプルコード
http_statuslog_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/statuslog/list/export?access_token={$xml->access_token}&beginDate=20120201&endDate=20120220";

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

?>