予約状況の確認
配信待ち一覧データを検索・削除します。対象が無い場合には空データが返ります。
削除は、新規作成メールの登録時に返りますユニークな識別IDを条件に行い、
削除に成功、あるいは失敗しても識別IDリストが返ります。
HTTP(S)
https://api.bme.jp/rest/1.0/
予約状況の検索
| URL |
/message/reservation/search |
| HTTP Method(s) |
GET |
パラメータ
| 必須 |
access_token |
API利用許可トークン |
| 任意 |
f |
レスポンス形式を指定する。｢xml｣または｢json｣ |
|
messageIDs |
識別IDリスト |
レスポンスサンプル
【XMLの場合】
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<messages>
<message>
<messageID>1</messageID>
<date>20120309T19:34:47</date>
<subject>件名</subject>
<group>全登録者</group>
<sender>sample@blastmail.jp</sender>
<reciepients>1</reciepients>
<status>配信待ち</status>
</message>
</messages>
【JSONの場合】
{"message":[{"sender":"sample@blastmail.jp","messageID":1,"status":"配信待ち","reciepients":1,"subject":"件名","group":"全登録者","date":"20120309T19:34:47"}]}
| messageID |
識別ID |
| date |
登録日時 |
| subject |
件名 |
| group |
宛先 |
| sender |
送信者 |
| total |
配信数 |
| status |
状況(編集中・編集中(公開)・配信待ち・配信待ち(公開)・配信中・配信中(公開) |
予約状況の検索(メッセージデータ)
| URL |
/message/detail/search |
| HTTP Method(s) |
GET |
パラメータ
| 必須 |
access_token |
API利用許可トークン |
|
messageID |
識別ID(int) |
| 任意 |
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 |
識別ID |
| senderID |
送信者 |
| groupID |
宛先 |
| subject |
件名 |
| textPart |
本文 |
| htmlPart |
HTMLメール用データ |
| scheduleDate |
配信時刻 |
| public |
バックナンバー(true: 公開する、false: 公開しない) |
予約の削除
| URL |
/message/list/delete |
| HTTP Method(s) |
POST |
パラメータ
| 必須 |
access_token |
API利用許可トークン |
|
messageID |
識別IDリスト |
| 任意 |
format |
レスポンス形式を指定する。｢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"}