getUnsubscribersList

Classic/VPC 환경에서 이용 가능합니다.

수신 거부 목록에 포함된 이메일 주소를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/unsubscribers

요청 헤더

Cloud Outbound Mailer API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Outbound Mailer 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`startUtc`	Long	Optional	수신 거부 등록 일시의 시작점 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 1/1000초로 환산한 정수 `startUtc` 또는 `startDateTime` 입력 필수 `startDateTime` 값보다 우선 적용
`startDateTime`	String	Optional	수신 거부 등록 일시의 시작점(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` 입력 필수 `startUtc` 값이 우선 적용
`endUtc`	Long	Optional	수신 거부 등록 일시의 종료점 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 1/1000초로 환산한 정수 `endUtc` 또는 `endDateTime` 입력 필수 `endDateTime` 값보다 우선 적용
`endDateTime`	String	Optional	수신 거부 등록 일시의 종료점(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` 입력 필수 `endUtc` 값이 우선 적용
`emailAddress`	String	Optional	검색할 특정 이메일 주소
`isRegByManager`	Boolean	Optional	관리자에 의한 등록 여부 `true` \| `false` `true`: 관리자가 등록함 `false`: 수신자 본인이 등록함
`size`	Integer	Optional	페이지당 레코드 개수 10 (기본값)
`page`	Integer	Optional	조회할 페이지 인덱스 0 이상
`sort`	String	Optional	정렬 기준 `createUtc` \| `isRegByManager` `createUtc`: 수신 거부 등록 일시 `isRegByManager`: 관리자에 의한 등록 여부 property(,asc\|desc) 형식 `asc` (기본값) 복수의 정렬 기준 설정 가능

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://mail.apigw.gov-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 참조
`totalElements`	Integer	-	총 레코드 개수
`totalPages`	Integer	-	총 페이지 수
`last`	Boolean	-	마지막 페이지 여부
`numberOfElements`	Integer	-	현재 페이지의 레코드 개수
`first`	Boolean	-	첫 번째 페이지 여부
`sort`	List	-	정렬 기준 Sort 참조
`size`	Integer	-	페이지당 레코드 개수
`number`	Integer	-	현재 페이지의 인덱스 0 이상

응답 상태 코드

Cloud Outbound Mailer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Outbound Mailer 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

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