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

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

機能説明

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

１リクエストで１つの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要素(配信予約)

接続先

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

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

リクエスト

ヘッダ

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

ボディパラメーター

XML形式で設定します。

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

レスポンス

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

ボディパラメーター

サンプル

リクエスト

<?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>