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 입력 필수
    • 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 입력 필수
    • startUtc 값이 우선 적용
    endUtcLongOptional수신 거부 등록 일시의 종료점
    • 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 1/1000초로 환산한 정수
    • endUtc 또는 endDateTime 입력 필수
    • 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 입력 필수
    • 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.