ワンクリック登録解除

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

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

機能説明

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

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

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

接続先

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

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

リクエスト

ヘッダ

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

ヘッダ名 値 内容
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> 要素には複数の <address> を指定可能です。

レスポンス

レスポンスは以下となります。

ボディパラメーター

項目 データ型 必須 説明
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>