ワンクリック登録解除

ワンクリック登録解除者リスト取得API

ワンクリック登録解除リクエストを受理した配信先の情報を取得するためのAPIです。取得したデータを基に、お客様が管理する配信リストを更新し、該当の配信先へのメール配信を停止してください。

機能説明

弊社のワンクリック登録解除システムで受理した解除者リストを取得します。取得データを、お客様の配信リストに反映し、配信停止を行ってください。

解除者リストは、リクエストを受け付けてから90日間保持されます。保持されている間は、自動的に配信対象から除外されますので、リクエストを受け付けた時点から、対象の宛先への配信は行われません。
配信を再開したい場合は、登録解除者除外APIをご利用ください。

ワンクリック登録解除者除外API
補足説明
API v1を弊社サービス環境以外でご利用の場合は、自動除外は行われません。速やかに配信リストへの更新を行ってください。
ご注意
本システムでワンクリック登録解除リクエストを受理していない場合は、解除者リストの取得はできません。
配信予約時に直接解除用URLを指定する（<unsubscribe_url>要素にhttpsリクエストURLを指定する）場合にはご注意ください。
data要素(配信予約)

解除者リストの取得は、認証情報として指定されたサービスと、そのサービスを利用して配信されたHeader Fromアドレスを指定して、１日単位で取得可能です。日付の範囲指定や、複数のHeader Fromアドレスを指定して取得することはできません。

接続先

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

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

リクエスト

ヘッダ

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

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

ボディパラメーター

XML形式で設定します。

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

レスポンス

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

ボディパラメーター

項目 データ型 必須 説明
response データなし ◯ ルート要素であり、API v1で使用するXMLをまとめる唯一の要素
unsubscribers データなし ◯ ワンクリック登録解除リクエストの受理に関する要素
header_from 文字列 ◯ リクエストしたHeader Fromアドレス
requesters データなし ◯ ワンクリック登録解除リクエストを受理した配信先リストに関する要素
requester データなし ◯ ワンクリック登録解除リクエストを受理した配信先に関する要素
message_id 文字列 ◯ 配信時にmessage-idヘッダに指定された文字列。配信IDを含む形式となっており、実際の配信を特定することが可能。
message_to 文字列 ◯ 登録解除リクエストを受理した配信先メールアドレス
datetime 文字列 ◯ 登録解除リクエストを受理した日時 (RFC 2822/3339形式)
filtered 文字列 ◯ 該当の配信先メールアドレスが配信先から除外される対象かどうか（ 除外の対象：1 / 除外の対象外：0 ）
補足説明
レスポンスのサイズは最大8MB(解除者リストが約２万件)となります。

<filtered> 要素は配信先の自動除外機能が実行できないシステム構成(※)の場合、常に 0 になります。
※配信予約時に直接解除用URLを指定する（<unsubscribe_url>要素にhttpsリクエストURLを指定する）場合や、弊社サービス環境以外でのご利用の場合。

配信予約API
data要素(配信予約)
<send_list>
    <data id="1">
        <address device="0">subscriber@receiver.example.com</address>
        <unsubscribe_url>https://example.com/somepath</unsubscribe_url>
    </data>
</send_list>

サンプル

リクエスト

<?xml version="1.0" encoding="UTF-8" ?>
<request>
  <auth>
    省略
  </auth>
　<unsubscription_request>
    <header_from>xxxxxx@example.com</header_from><!—- Header Fromアドレス -->
    <year>2024</year><!—- 年 -->
    <month>5</month><!—- 月 -->
    <day>4</day><!—- 日 -->
  </unsubscription_request>
</request>

レスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <unsubscribers>
    <header_from>xxxxxx@example.com</header_from><!-- Header Fromアドレス -->
    <requesters>
      <requester><!-- 取得したデータ分繰り返される。 -->
        <message_id>xxxxxx@xxx.jp</message_id><!-- メッセージID -->
        <message_to>xxxxxx@xxx.jp</message_to><!-- 送信先メールアドレス –->
        <datetime>2021/05/01 16:34</datetime><!-- リクエスト受理日時 -->
        <filtered>0</filtered><!-- フラグ 1: 0: -->
      </requester>
    </requesters>
  </unsubscribers>
</response>