getUnsubscribersList
- 印刷する
- PDF
getUnsubscribersList
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
受信拒否のEメールアドレスのリストを照会します。
GET https://{endpoint}/unsubscribers
リクエスト
リクエストパラメータ
パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
startUtc | No | Long | startUtcまたはstartDateTimeのうち1つは必須 | 受信拒否登録日の検索基準スタートの日時( 1970年1月1日00:00:00協定世界時(UTC)からの経過時間を 1/1000秒で換算した定数)、 startDateTimeの値よりこの値を優先して適用する。 |
startDateTime | No | String | 許容日時のフォーマット("yyyy-MM-dd", "yyyy-MM-dd HH:mm", "yyyy-MM-dd HH:mm:ss.SSS", "yyyy-MM-dd HH:mm:ss SSS") | 許容日時フォーマットの受信拒否登録日の検索基準の開示日時(UTC+09:00)、startUtcの値が優先となる。 |
endUtc | No | Long | endUtcまたはendDateTimeのうち1つは必須 | 受信拒否登録日の検索基準終了の日時(1970年1月1日00:00:00協定世界時(UTC)からの経過時間を1/1000秒で換算した定数)、endDateTimeの値よりこの値を優先して適用する。 |
endDateTime | No | String | 許容日時のフォーマット("yyyy-MM-dd", "yyyy-MM-dd HH:mm", "yyyy-MM-dd HH:mm:ss.SSS", "yyyy-MM-dd HH:mm:ss SSS") | 許容日時フォーマットの受信拒否登録日の検索基準終了の日時(UTC+09:00)、endUtcの値が優先となる。 |
emailAddress | No | String | Eメールアドレスのフォーマット | 受信拒否Emailアドレス |
isRegByManager | No | Boolean | 管理者による登録の有無 | |
size | No | Integer | Default:10 | 1ページ当たりのレコード数 |
page | No | Integer | Default:0 | 結果を表示したいページのindex (0..N) |
sort | No | String | createUtc:受信拒否の登録日、isRegByManager:管理者による登録の可否 | 並び基準フィールド(形式:property(,asc|desc)):デフォルトの並び順は昇順(asc)で、複数のフィールドを並び順に利用することができる。 |
レスポンス
HTTPステータスコード | 説明 |
---|---|
200 | 成功 |
400 | 認証失敗、間違ったリクエスト |
500 | サーバエラー |
例示
リクエスト
GET https://mail.apigw.ntruss.com/api/v1/unsubscribers?startDateTime=2018-11-01%2000:00&size=5&page=0&endDateTime=2019-02-20%2023:59
レスポンス
{
"content":[
{
"address":"shin.xxx@gmail.com",
"blockDate":{
"utc":1546569106178,
"formattedDate":"2019-01-04",
"formattedDateTime":"2019-01-04 11:31:46 178"
},
"isRegByManager":false
},
{
"address":"shin.xxxx@navercorp.com",
"blockDate":{
"utc":1546569014158,
"formattedDate":"2019-01-04",
"formattedDateTime":"2019-01-04 11:30:14 158"
},
"isRegByManager":false
},
{
"address":"xxxxx@aaa.com",
"blockDate":{
"utc":1544603441295,
"formattedDate":"2018-12-12",
"formattedDateTime":"2018-12-12 17:30:41 295"
},
"isRegByManager":true
},
{
"address":"xxxxx@nnn.com",
"blockDate":{
"utc":1544603441295,
"formattedDate":"2018-12-12",
"formattedDateTime":"2018-12-12 17:30:41 295"
},
"isRegByManager":true
}
],
"totalElements":4,
"totalPages":1,
"last":true,
"numberOfElements":4,
"first":true,
"sort":[
{
"direction":"DESC",
"property":"createUtc",
"ignoreCase":false,
"nullHandling":"NATIVE",
"ascending":false,
"descending":true
}
],
"size":10,
"number":0
}
属性
項目 | 必須 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
totalElements | Yes | Integer | レコードの合計 | |
totalPages | Yes | Integer | ページの合計 | |
numberOfElements | Yes | Integer | 現在ページのレコード数 | |
first | Yes | Boolean | 最初ページの可否 | |
last | Yes | Boolean | 最終ページの可否 | |
number | Yes | Integer | 現在ページのindex (0からスタート) | |
size | Yes | Integer | 1ページ当たりのレコード数 | |
sort | Yes | List<Sort> | 並び | |
content | No | List<UnsubscribeResponse> | 詳細 |
エラーコード
HTTP Status Code | リターンコード | レスポンスメッセージ |
---|---|---|
400 | 77101 | ログイン情報のエラー |
400 | 77102 | BAD_REQUEST |
400 | 77103 | リソースが存在しない |
403 | 77201 | 権限なし |
403 | 77202 | Email商品の利用申込をしていない |
405 | 77001 | METHOD_NOT_ALLOWED |
415 | 77002 | UNSUPPORTED_MEDIA_TYPE |
500 | 77301 | 基本プロジェクトが存在しない |
500 | 77302 | 外部システムAPIの連動エラー |
500 | 77303 | その他のINTERNAL_SERVER_ERROR |
この記事は役に立ちましたか?