ワンクリック登録解除

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

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

機能説明

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

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

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

配信予約

mailing-list（配信予約）

"mailing-list": [
  {
    "to": {
      "device": 0,
      "address": "string"
    },
    "substitutions": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "unsubscribe_url": "https://ocu.example.com/somepath/"
  }
],
ご注意
一度設定したFromアドレスは解除できません。
登録済みのFromアドレスで過去にメール配信がおこなわれている場合に、メール受信者からワンクリック登録解除リクエストを受理する可能性があるためです。
ワンクリック登録解除機能を利用するFromアドレスの登録間違いにはご注意ください。
補足説明
誤ってFromアドレスを登録してしまった場合に、List-Unsubscribeヘッダが付与されないようにするには、誤って登録してしまったFromアドレスは利用せず、未登録の別のFromアドレスで配信を実施してください。

メソッドとURL

メソッド URL
POST https://{HOST名}/unsubscribe-receivers

リクエスト

ボディパラメーター

JSON形式で設定します。

項目 型 必須 説明
header-from String ◯ ワンクリック登録解除の対象Fromアドレス

レスポンス

ステータスコード

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

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

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

 

ボディーパラメーター

項目 型 説明
base_url String ワンクリック登録解除のURLのホスト名含む一部分
補足説明
お客様がrepica senderで弊社のワンクリック登録解除機能を利用する場合、返却されたURL（base_url）に登録解除の対象となる情報を含む文字列を連結し、最終的なURLを構築して、List-Unsubscribeヘッダに設定してください。また、登録解除者を特定する際には、ワンクリック登録解除者リスト取得：repica sender利用時のopaque_part要素に、上記で連結した部分の文字列が格納されるますので、これを利用してください。

ワンクリック登録解除者リスト取得：repica sender利用時

ご注意
base_urlに連結する文字列内に、「%00」という文字列は指定できません。
弊社システムでは、「%00」という文字列を受け付けることができませんので、含まれないようにご注意ください。

サンプル

リクエスト

{
  "header-from": "sender@example.com"
}

レスポンス

正常

{
  "base_url": "https://example.com/{class_id}"
}

エラー

{
 "message": "Internal Server Error"
}

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