PAGE TOP

下書き

下書きの作成・検索を行います。登録を行うと、識別IDが返ります。
エラーが発生した場合には内容に応じて以下の値が返ります。

  • -1. パラメータ不正
  • -2. 下書き登録数制限
  • -3. 送信者データ不正
  • -4. 宛先データ不正
  • -5. 本文文字数制限
  • -6. HTMLサイズ制限
  •  0. 登録処理に失敗

検索の際に、対象の下書きが存在しない場合には空データが返ります。

HTTP(S)

下書きの作成


URI /message/draft/create
HTTP Method(s) POST
パラメータ
必須 access_token API利用許可トークン
senderID 送信者
groupID 宛先
subject 件名
textPart 本文
任意 format,f レスポンス形式を指定する。「xml」または「json」
htmlPart HTMLメール用
public バックナンバー公開設定(true, false)
レスポンスサンプル
【XMLの場合】
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<message>
    <messageID>1</messageID>
</message>
    
【JSONの場合】
{"messageID":1}
サンプルコード
http_message_draft_create.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/draft/create';

$request->reset($url);

$request->setMethod(HTTP_REQUEST_METHOD_POST);
$request->addPostData('access_token', $xml->access_token);
$request->addPostData('senderID', 1);
$request->addPostData('groupID', 1);
$request->addPostData('subject', '件名');
$request->addPostData('textPart', '本文');

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

?> 

下書きの検索


URI /message/draft/search
HTTP Method(s) GET
パラメータ
必須 access_token API利用許可トークン
任意 format,f レスポンス形式を指定する。「xml」または「json」
messageIDs 識別IDリスト
レスポンスサンプル
【XMLの場合】
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> 
<messages>
    <message>
        <messageID>1</messageID> 
        <date>20120309T11:37:01</date> 
        <subject>件名</subject> 
        <group>グループ名</group> 
        <sender>sample@blaynmail.jp</sender> 
    </message>
</messages>
    
【JSONの場合】
{"message":[{"sender":"sample@blaynmail.jp","messageID":1,"subject":"件名","group":"グループ名","date":"20120309T11:37:01"}]}
  • messageID
  • date
  • 識別ID
  • 登録日時
  • subject
  • group
  • 件名
  • 宛先
  • sender
  • 送信者
サンプルコード
http_message_draft_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/draft/search?access_token={$xml->access_token}";

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

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

?>

下書きの検索(メッセージデータ)


URI /message/detail/search
HTTP Method(s) GET
パラメータ
必須 access_token API利用許可トークン
messageID 識別ID
任意 format,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}
  • messageID
  • senderID
  • groupID
  • subject
  • 識別ID
  • 送信者
  • 宛先
  • 件名
  • textPart
  • htmlPart
  • scheduleDate
  • public
  • 本文
  • HTMLメール用データ
  • 配信時刻
  • バックナンバー(true:公開する、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 /message/list/delete
HTTP Method(s) POST
パラメータ
必須 access_token API利用許可トークン
messageIDs 識別IDリスト
任意 format,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();
}

?>