getUnsubscribersList
    • PDF

    getUnsubscribersList

    • PDF

    記事の要約

    Classic/VPC環境で利用できます。

    受信拒否リストに含まれているメールアドレスを照会します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET/unsubscribers

    リクエストヘッダ

    Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。

    リクエストクエリパラメータ

    パラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    startUtcLongOptional受信拒否登録日時の開始点
    • 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間を1/1000秒に換算した整数
    • startUtcまたはstartDateTimeのうち1つは必ず入力
    • startDateTimeより優先適用
    startDateTimeStringOptional受信拒否登録日時の開始点(UTC+09:00)
    • 使用可能な形式
      • yyyy-MM-dd
      • yyyy-MM-dd HH:mm
      • yyyy-MM-dd HH:mm:ss.SSS
      • yyyy-MM-dd HH:mm:ss SSS
    • startUtcまたはstartDateTimeのうち1つは必ず入力
    • startUtcが優先適用
    endUtcLongOptional受信拒否登録日時の終了点
    • 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間を1/1000秒に換算した整数
    • endUtcまたはendDateTimeのうち1つは必ず入力
    • endDateTimeより優先適用
    endDateTimeStringOptional受信拒否登録日時の終了点(UTC+09:00)
    • 使用可能な形式
      • yyyy-MM-dd
      • yyyy-MM-dd HH:mm
      • yyyy-MM-dd HH:mm:ss.SSS
      • yyyy-MM-dd HH:mm:ss SSS
    • endUtcまたはendDateTimeのうち1つは必ず入力
    • endUtcが優先適用
    emailAddressStringOptional検索対象の特定のメールアドレス
    isRegByManagerBooleanOptional管理者により登録されたかどうか
    • true | false
      • true: 管理者が登録
      • false: 受信者本人が登録
    sizeIntegerOptionalページごとのレコード数
    • 10 (デフォルト)
    pageIntegerOptional照会対象のページインデックス
    • 0以上
    sortStringOptionalソート基準
    • createUtc | isRegByManager
      • createUtc: 受信拒否登録日時
      • isRegByManager: 管理者により登録されたかどうか
    • property(,asc|desc)形式
      • asc (デフォルト)
    • 複数のソート基準を設定可能

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    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}'
    

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    contentList<UnsubscribersListResponse>Optional受信拒否リストの詳細
    totalElementsIntegerRequired総レコード数
    totalPagesIntegerRequired総ページ数
    lastBooleanRequired最後のページであるか否か
    numberOfElementsIntegerRequired現在ページのレコード数
    firstBooleanRequired最初のページなのか否か
    sortList<Sort>Requiredソート基準
    sizeIntegerRequiredページごとのレコード数
    numberIntegerRequired現在ページのインデックス
    • 0以上

    レスポンスステータスコード

    レスポンスステータスコードの説明は次の通りです。

    HTTPステータスコードコード説明
    200-リクエスト成功
    400-認証失敗、無効なリクエスト
    40077101ログイン情報エラー
    40077102リクエストエラー
    40077103リクエストしたリソースが存在しない
    40377201リクエストしたリソースに対する権限がない
    40377202メールサービスの使用を申し込んでいないユーザーが呼び出した場合
    40577001サポートしないメソッドタイプ
    41577002サポートしないメディアタイプ
    500-サーバエラー
    50077301基本プロジェクトが存在しない
    50077302外部システム API連携エラー
    50077303その他の内部サーバエラー

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
       "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
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.