PAGE TOP

メール新規作成 (即時配信・予約配信)

登録されているアドレス宛に、配信設定を行います。配信設定を行うと、識別IDが返ります。
エラーが発生した場合には内容に応じて以下の値が返ります。

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

HTTP(S)

即時配信


URI /message/sendnow/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_sendnow_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/sendnow/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/schedule/create
HTTP Method(s) POST
パラメータ
必須 access_token API利用許可トークン
senderID 送信者
groupID 宛先
subject 件名
textPart

本文

scheduleDate 配信時刻(ISO 8601:yyyyMMddTHH:mm:ss)
任意 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_schedule_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/schedule/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', '本文');
$request->addPostData('scheduleDate', '20120310T07:00:00');

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

?>