注意

このドキュメントはAPIバージョン1のAPI仕様です。

最新バージョンのAPI仕様はAPIリファレンスを参照ください。

Blocks はアカウントが存在しないなどの理由により送信エラーが発生したため、配信停止状態にあるメールアドレスを検索・参照する、ダウンロードする、配信停止状態を解除する等の操作を提供します。

このAPIは管理コンソールが提供します。接続先ホストについては共通仕様を参照ください。

list

Blocks/list は、配信停止状態にあるメールアドレスを検索・参照する操作を提供します。

リクエスト

/transaction/v1/blocks/list.[json|xml]

アクセス制御

パラメータ

レスポンス

JSON

{
"blocks": [
    {
    "created": "2015-12-14 08:46:00",
    "email": "to1@example.com",
    "id": "cp0ihzuyl3445",
    "occurred": "1",
    "status": "2"
    },
    {
    "created": "2015-12-14 12:19:00",
    "email": "to2@example.com",
    "id": "cp0ihzuyl3479",
    "occurred": "1",
    "status": "2"
    }
    ...
]
}

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<blocks>
<block>
    <id>cp0ihzuyl3445</id>
    <email>to1@example.com</email>
    <status>2</status>
    <occurred>1</occurred>
    <created>2015-12-14 08:46:00</created>
</block>
<block>
    <id>cp0ihzuyl3479</id>
    <email>to2@example.com</email>
    <status>2</status>
    <occurred>1</occurred>
    <created>2015-12-14 12:19:00</created>
</block>
</blocks>

エラーメッセージ

リクエスト例

curl -X POST -d 'api_user=testuser' -d 'api_key=password' -d 'server_composition=testcomp' https://api.smtps.jp/transaction/v1/blocks/list.json

download

Blocks/download は、配信停止状態にあるメールアドレスを検索し、CSVファイル形式でダウンロードする操作を提供します。

リクエスト

/transaction/v1/blocks/download.[json|xml]

アクセス制御

パラメータ

レスポンス

リクエストが成功した場合、Content-Type に application/octet-stream を指定し、以下フォーマットのCSVファイルをZIP圧縮してダウンロードします。データ暗号化を設定している場合、パスワード付き暗号化ZIPファイルをダウンロードします。

ファイル名

blocks-yyyyMMdd_HHmmss.zip　(例: blocks-20151207_175202.zip)

ファイルフォーマット

"id","email","status","occurred","created"
"cp0ihzuyl3445","from1@example.com","2","1","2015-12-14 08:46:00"
"cp0ihzuyl3445","from2@example.com","2","1","2015-12-14 12:19:00"

エラーメッセージ

リクエスト例

curl -X POST -d 'api_user=testuser' -d 'api_key=password' -d 'server_composition=testcomp' https://api.smtps.jp/transaction/v1/blocks/download.json > data.zip

delete

Blocks/delete は、配信停止状態にあるメールアドレスを恒久的に送信可能にする操作を提供します。

リクエスト

/transaction/v1/blocks/delete.[json|xml]

アクセス制御

パラメータ

レスポンス

処理が成功した場合、以下の応答メッセージになります。

JSON

{
    "message" : "success"
}

XML

<success>
    <message>success</message>
</success>

エラーメッセージ

リクエスト例

curl -X POST -d 'api_user=testuser' -d 'api_key=password' -d 'server_composition=testcomp' -d 'email=test@example.com' https://api.smtps.jp/transaction/v2/blocks/delete.json

レスポンス

処理が成功した場合、以下の応答メッセージになります。

JSON

{
    "message" : "success"
}

XML

<success>
    <message>success</message>
</success>

エラーメッセージ

リクエスト例

curl -X POST -d 'api_user=testuser' -d 'api_key=password' -d 'server_composition=te