ワンクリック登録解除

ワンクリック登録解除設定API

ワンクリック登録解除システムに、ワンクリック登録解除の対象となるHeader Fromアドレスを登録するAPIです。
登録したHeader Fromアドレスに対して、ワンクリック登録解除機能が適用されます。

機能説明

ワンクリック登録解除システムに、ワンクリック登録解除機能を利用するHeader Fromアドレスを設定します。設定したHeader Fromアドレスで配信を行うと、List-Unsubscribeヘッダが付与されます。

1回のリクエストで1つのHeader Fromアドレスを設定します。

Header Fromアドレスはサービスごとに設定され、auth要素の認証情報で指定されたサービスに登録されます。同じHeader Fromアドレスであっても、異なるサービスに設定したものは別のものとして扱われます。

配信予約時に、直接解除用URLを指定する（<unsubscribe_url>要素にhttpsリクエストURLを指定する）場合は、ワンクリック登録解除設定APIの実行は不要です。

<send_list>
    <data id="1">
        <address device="0">subscriber@receiver.example.com</address>
        <unsubscribe_url>https://example.com/somepath</unsubscribe_url>
    </data>
</send_list>
data要素(配信予約)
注意
一度設定したHeader Fromアドレスは解除できません。
登録済みのHeader Fromアドレスで過去にメール配信が行われている場合、メール受信者からワンクリック登録解除リクエストを受理する可能性があるためです。
ワンクリック登録解除機能を利用するHeader Fromアドレスの登録内容を誤らないようご注意ください。
補足説明
誤ってHeader Fromアドレスを登録してしまった場合に、List-Unsubscribeヘッダが付与されないようにするには、以下のいずれかの方法が考えられます。

  • 管理画面にて、対象サービスの「ワンクリック登録解除」設定を「使用しない」にして配信する。
    ※ただし、対象サービスからの配信については、すべてのメールでヘッダ付与が行われなくまります。
  • サービスを追加登録し、そのサービスから配信する。
  • 誤って登録してしまったHeader Fromアドレスは利用せず、未登録の別のHeader Fromアドレスで配信する。

接続先

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

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

リクエスト

ヘッダ

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

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

ボディパラメーター

XML形式で設定します。

項目 データ型 必須 説明
request データなし ◯ ルート要素であり、本APIで使用するXMLをまとめる唯一の要素
auth データなし ◯ リクエスト時の認証情報を定義する要素
詳細は以下ページを参照してください
auth要素(共通)
site データなし ◯ 利用するサイトIDを指定
service データなし ◯ 利用するサービスIDを指定
name 文字列(CDATA) ◯ ユーザ名を指定
pass 文字列(CDATA) ◯ パスワードを指定
receiver データなし ◯ ワンクリック登録解除設定に関する情報をまとめる要素
header_from 文字列 ◯ ワンクリック登録解除の対象Header Fromアドレスを指定

レスポンス

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

ボディパラメーター

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

サンプル

リクエスト

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <auth>
        <site id=”0” />
        <service id=”0” />
        <name>string</name>
        <pass>string</pass>
    </auth>
    <receiver>
        <header_from>sender@example.com</header_from>
    </receiver>
</request>

レスポンス

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