PAGE TOP

下書き

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

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

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

XML-RPC

下書きの作成


パラメータ
string accessToken API利用許可トークン
struct message int senderID: 送信者
int groupID: 宛先
string subject: 件名
string textPart: 本文
string htmlPart: HTMLメール用データ
boolean public: バックナンバー(true: 公開する、false: 公開しない)
戻り値
int 識別ID
サンプルコード
xmlrpc_message_draft_create.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('senderID' => 1, 'groupID' => 1, 'subject' => '件名', 'textPart' => '本文'));
$request = xmlrpc_encode_request('message.draftCreate', $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 int messageID: 識別ID
dateTime.iso8601 date: 登録日時
string subject: 件名
string group: 宛先
string sender: 送信者
サンプルコード
xmlrpc_message_draft_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);
//$request = xmlrpc_encode_request('message.draftSearch', $params, $options);
$params = array($accessToken, array(1));
$request = xmlrpc_encode_request('message.draftSearchByMessageIDs', $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_draft_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);
$request = xmlrpc_encode_request('message.reservationSearch', $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 array success: 処理成功(int)
array failure: 処理失敗(int)
サンプルコード
xmlrpc_message_draft_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);

?>