ワンクリック登録解除

ワンクリック登録解除者リスト取得：自動付与

ワンクリック登録解除者リスト取得：自動付与

本システムによって登録解除URLが自動付与されたメールからワンクリック登録解除リクエストを受理した配信先の情報を取得します。

機能説明

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

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

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

ご注意
本システムでワンクリック登録解除リクエストを受理していない場合は、解除者リストの取得はできません。
配信予約時に直接解除用URLを指定する（<unsubscribe_url>要素にhttpsリクエストURLを指定する）場合にはご注意ください。

記事を取得できませんでした。記事IDをご確認ください。

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

メソッドとURL

メソッド URL
GET https://{HOST名}/unsubscribers/auto-assigned?header-from=[メールアドレス]&date=YYYY-MM-DD±HH:MM

 

リクエスト

URLパラメーター

項目 型 必須 説明
header-from String ◯ 登録解除の対象となった対象Header Fromアドレス
date String ◯ 登録解除を受理した日付（年月日）。
RFC3339の年月日のみで表現します。時間オフセット省略時は日本時間（+09:00）に相当する日時で判断します。

レスポンス

ステータスコード

コード メッセージ 説明
200 OK リクエスト受付、正常終了。
400 Bad Request 構文不正。フォーマットやパラメーターの不正。
500 Internal Server Error 想定外のエラー。
しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。

上記以外のステータスコードが返却される場合もあります。
その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。

HTTPレスポンスステータスコード一覧

ボディーパラメーター

JSON形式で取得されます。

項目 型 説明
header_from String リクエストしたHeader Fromアドレス
unsubscribers Object Array 登録解除を要求した配信先のリスト
message_id String 配信時message-idヘッダに指定された文字列
message_to String 登録解除を要求した(配信先)メールアドレス
datetime String RFC 2822/3339 (ISO8501) 形式の解除リクエスト受理日時
filtered String 該当の配信先メールアドレスが配信先から除外される対象かどうか（true：対象 / false：対象外）

 

サンプル

レスポンス

正常

{
  "header_from": "sender@example.com",
  "unsubscribers": [
    {
      "message_id": "MESSAGEID-STRING",
      "message_to": "subscriber@receiver.example.com",
      "datetime": "2024-03-25T10:08:16.305Z"
      "filtered": false
    }
  ]
}

エラー

{
 "message": "Internal Server Error"
}

補足情報が返却されます。