ワンクリック登録解除者リスト取得:repica sender利用時
ワンクリック登録解除設定APIのレスポンスで得られる base_url にお客様側による任意のデータを付与したURLでワンクリック登録解除リクエストを受理した場合の情報を取得します。
機能説明
弊社のワンクリック登録解除システムで受理した解除者リストを取得します。取得データを、お客様の配信リストに反映し、配信停止を行ってください。
解除者リストは、リクエストを受け付けてから90日間保持されます。
ご注意
本APIは、repica senderをご利用のお客様に、ワンクリック登録解除のシステムを提供する事を想定しています。
配信予約時に直接解除用URLを指定する(<unsubscribe_url>要素にhttpsリクエストURLを指定する)方法ではご利用にならないでください。
本APIは、repica senderをご利用のお客様に、ワンクリック登録解除のシステムを提供する事を想定しています。
配信予約時に直接解除用URLを指定する(<unsubscribe_url>要素にhttpsリクエストURLを指定する)方法ではご利用にならないでください。
解除者リストの取得は、配信されたFromアドレスを指定して、1日単位で取得可能です。日付の範囲指定や、複数のFromアドレスを指定して取得することはできません。
メソッドとURL
メソッド | URL |
GET | https://{HOST名}/unsubscribers/client-assigned?header-from=[メールアドレス]&date=YYYY-MM-DD±HH:MM |
リクエスト
URLパラメーター
項目 | 型 | 必須 | 説明 | ||||
header-from | String | ◯ | 登録解除の対象となった対象Fromアドレス | ||||
date | String | ◯ | 登録解除を受理した日付(年月日)。 RFC3339の年月日のみで表現します。時間オフセット省略時は日本時間(+09:00)に相当する日時で判断します。 |
レスポンス
ステータスコード
コード | メッセージ | 説明 |
200 | OK | リクエスト受付、正常終了。 |
400 | Bad Request | 構文不正。フォーマットやパラメーターの不正。 |
500 | Internal Server Error | 想定外のエラー。 しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。 |
上記以外のステータスコードが返却される場合もあります。
その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。
ボディーパラメーター
JSON形式で取得されます。
項目 | 型 | 説明 | |||
header_from | String | リクエストしたFromアドレス | |||
unsubscribers | Object Array | 登録解除を要求した配信先のリスト | |||
opaque_part | String | List-Unsubscribeヘッダ付与時に指定したURLのうち、お客様側によって連結された文字列(本システムで定義されているURL部分を除いた文字列) | |||
datetime | String | RFC 2822/3339 (ISO8501) 形式の解除リクエスト受理日時 |
サンプル
レスポンス
正常
{
"header_from": "sender@example.com",
"unsubscribers": [
{
"opaque_part": "opaque-string"
"datetime": "2024-03-25T10:08:16.305Z"
}
]
}
エラー
{
"message": "Internal Server Error"
}
補足情報が返却されます。