getUnsubscribersList
- 印刷する
- PDF
getUnsubscribersList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
受信拒否リストに含まれているメールアドレスを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /unsubscribers |
リクエストヘッダ
Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
startUtc | Long | Optional | 受信拒否登録日時の開始点
|
startDateTime | String | Optional | 受信拒否登録日時の開始点(UTC+09:00)
|
endUtc | Long | Optional | 受信拒否登録日時の終了点
|
endDateTime | String | Optional | 受信拒否登録日時の終了点(UTC+09:00)
|
emailAddress | String | Optional | 検索対象の特定のメールアドレス |
isRegByManager | Boolean | Optional | 管理者により登録されたかどうか
|
size | Integer | Optional | ページごとのレコード数
|
page | Integer | Optional | 照会対象のページインデックス
|
sort | String | Optional | ソート基準
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request 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'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
content | List<UnsubscribersListResponse> | Optional | 受信拒否リストの詳細 |
totalElements | Integer | Required | 総レコード数 |
totalPages | Integer | Required | 総ページ数 |
last | Boolean | Required | 最後のページであるか否か |
numberOfElements | Integer | Required | 現在ページのレコード数 |
first | Boolean | Required | 最初のページなのか否か |
sort | List<Sort> | Required | ソート基準 |
size | Integer | Required | ページごとのレコード数 |
number | Integer | Required | 現在ページのインデックス
|
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
HTTPステータスコード | コード | 説明 |
---|---|---|
200 | - | リクエスト成功 |
400 | - | 認証失敗、無効なリクエスト |
400 | 77101 | ログイン情報エラー |
400 | 77102 | リクエストエラー |
400 | 77103 | リクエストしたリソースが存在しない |
403 | 77201 | リクエストしたリソースに対する権限がない |
403 | 77202 | メールサービスの使用を申し込んでいないユーザーが呼び出した場合 |
405 | 77001 | サポートしないメソッドタイプ |
415 | 77002 | サポートしないメディアタイプ |
500 | - | サーバエラー |
500 | 77301 | 基本プロジェクトが存在しない |
500 | 77302 | 外部システム API連携エラー |
500 | 77303 | その他の内部サーバエラー |
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"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
}
この記事は役に立ちましたか?