getUnsubscribersList
    • PDF

    getUnsubscribersList

    • PDF

    기사 요약

    수신거부 이메일 주소 목록을 조회합니다.

    GET https://mail.apigw.fin-ntruss.com/api/v1/unsubscribers
    

    요청

    요청 파라미터

    파라미터 명필수 여부타입제약사항설명
    startUtcNoLongstartUtc 또는 startDateTime 둘 중하나는 필수- 수신거부 등록일 검색 기준 시작 일시
    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 둘 중하나는 필수- 수신거부 등록일 검색 기준 종료 일시
    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 값이 우선
    emailAddressNoString이메일 주소 포멧수신거부 Email 주소
    isRegByManagerNoBoolean관리자를 통한 등록 여부
    sizeNoIntegerDefault:10한페이지에 당 레코드 개수
    pageNoIntegerDefault:0결과를 받고 싶은 페이지 index (0..N)
    sortNoStringcreateUtc : 수신거부 등록일, isRegByManager : 관리자를 통한 등록 여부- 정렬기준 필드
    형식 : property(,asc|desc) : 기본정렬 방향은 오름차순(asc)이며, 복수의 필드를 정렬기준으로 사용 가능

    응답

    HTTP 상태코드설명
    200성공
    400인증 실패, 잘못된 요청
    500서버 에러

    예시

    요청 예시

    GET https://mail.apigw.fin-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부터 시작)
    sizeYesInteger한페이지에 당 레코드 개수
    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

    이 문서가 도움이 되었습니까?

    What's Next
    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.