ワンクリック登録解除

ワンクリック登録解除者除外API

Header Fromアドレスおよび配信先メールアドレスを指定して、配信を再開できる状態にします。
該当の配信先メールアドレスは、配信予約時にワンクリック登録解除システムによって自動的に除外されなくなります。

機能説明

ワンクリック登録解除者リストに登録された配信先メールアドレスは、登録解除リクエスト受理後90日間、メール配信対象から除外されます。この期間中に、特定のメールアドレスを再度配信可能な状態にするためのAPIがワンクリック登録解除者除外APIです。

配信を再開したいHeader Fromアドレスと配信先メールアドレスを指定し、その組み合わせを配信対象として設定します。
設定結果を確認するには、ワンクリック登録解除者リスト取得APIを使用して解除者リストを取得します。

ワンクリック登録解除者リスト取得API
対象のHeader Fromアドレスと配信先メールアドレスの組み合わせが存在しない場合でもエラーにはなりません。設定内容は、上記の方法で確認してください。

接続先

本APIの接続先は以下の通りです。

https://(ドメイン名)/tm/resubscribers.php

リクエスト

ヘッダ

HTTPプロトコルで送受信を行う場合は、HTTPヘッダが必要です。
リクエスト時には、以下の項目を設定してください。

ヘッダ名 値 内容
Content-Type application/octet-stream リクエストのコンテンツタイプを指定します。
他の値でもテキストとして認識される設定であれば動作する場合がありますが、弊社サポート対象外です。

ボディパラメーター

XML形式で設定します。

項目 データ型 必須 説明
request データなし ◯ ルート要素であり、API v1で使用するXMLをまとめる唯一の要素
auth データなし ◯ リクエスト時に認証情報を定義する要素
詳細は以下ページを参照してください
auth要素(共通)
site データなし ◯ 利用するサイトIDを指定
service データなし ◯ 利用するサービスIDを指定
name 文字列(CDATA) ◯ ユーザ名を指定
pass 文字列(CDATA) ◯ パスワードを指定
resubscribe データなし ◯ ワンクリック登録解除の除外に関する情報を指定する要素
header_from 文字列 ◯ 要素addressに指定したメールアドレス宛に、配信を許可するHeader Fromアドレスを指定
addresses データなし ◯ 除外対象の配信先メールアドレスに関する要素
address 文字列 ◯ 再配信を行うアドレスを指定
補足説明
<addresses> 要素には複数指定できます。

レスポンス

レスポンスは以下の通りです。

ボディパラメーター

項目 データ型 必須 説明
response データなし ◯ ルート要素であり、本APIで使用するXMLをまとめる唯一の要素です。現在この要素に設定されるデータはありませんが、今後拡張される可能性があります。

サンプル

リクエスト

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <auth>
        <site id="0"/>
        <service id="1"/>
        <name><![CDATA[user]]></name>
        <pass><![CDATA[password]]></pass>
    </auth>
    <resubscribe>
        <header_from>sender@example.com</header_from>
        <addresses>
            <address>subscriber@receiver.example.com</address> <!-- 除外対象アドレス -->
        </addresses>
    </resubscribe>
</request>

レスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<response>
</response>