getUnsubscribersList
    • PDF

    getUnsubscribersList

    • PDF

    Article Summary

    受信拒否のEメールアドレスのリストを照会します。

    GET https://{endpoint}/unsubscribers
    

    リクエスト

    リクエストパラメータ

    パラメータ名必須タイプ制約事項説明
    startUtcNoLongstartUtcまたはstartDateTimeのうち1つは必須受信拒否登録日の検索基準スタートの日時( 1970年1月1日00:00:00協定世界時(UTC)からの経過時間を 1/1000秒で換算した定数)、 startDateTimeの値よりこの値を優先して適用する。
    startDateTimeNoString許容日時のフォーマット("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の値が優先となる。
    endUtcNoLongendUtcまたはendDateTimeのうち1つは必須受信拒否登録日の検索基準終了の日時(1970年1月1日00:00:00協定世界時(UTC)からの経過時間を1/1000秒で換算した定数)、endDateTimeの値よりこの値を優先して適用する。
    endDateTimeNoString許容日時のフォーマット("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の値が優先となる。
    emailAddressNoStringEメールアドレスのフォーマット受信拒否Emailアドレス
    isRegByManagerNoBoolean管理者による登録の有無
    sizeNoIntegerDefault:101ページ当たりのレコード数
    pageNoIntegerDefault:0結果を表示したいページのindex (0..N)
    sortNoStringcreateUtc:受信拒否の登録日、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
    }
    
    
    

    属性

    項目必須タイプ制約事項説明
    totalElementsYesIntegerレコードの合計
    totalPagesYesIntegerページの合計
    numberOfElementsYesInteger現在ページのレコード数
    firstYesBoolean最初ページの可否
    lastYesBoolean最終ページの可否
    numberYesInteger現在ページのindex (0からスタート)
    sizeYesInteger1ページ当たりのレコード数
    sortYesList<Sort>並び
    contentNoList<UnsubscribeResponse>詳細

    エラーコード

    HTTP Status Codeリターンコードレスポンスメッセージ
    40077101ログイン情報のエラー
    40077102BAD_REQUEST
    40077103リソースが存在しない
    40377201権限なし
    40377202Email商品の利用申込をしていない
    40577001METHOD_NOT_ALLOWED
    41577002UNSUPPORTED_MEDIA_TYPE
    50077301基本プロジェクトが存在しない
    50077302外部システムAPIの連動エラー
    50077303その他のINTERNAL_SERVER_ERROR

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

    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.