getUnsubscribersList
- 인쇄
- PDF
getUnsubscribersList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
수신거부 이메일 주소 목록을 조회합니다.
GET https://mail.apigw.gov-ntruss.com/api/v1/unsubscribers
요청
요청 파라미터
파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
---|---|---|---|---|
startUtc | No | Long | startUtc 또는 startDateTime 둘 중하나는 필수 | - 수신거부 등록일 검색 기준 시작 일시 1970년 1월 1일 00:00:00 협정 세계시(UTC) 부터의 경과 시간을 1/1000초로 환산한 정수 startDateTime 값보다 이 값이 우선 적용됨 |
startDateTime | No | String | 허용 일시 포멧 ("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 값이 우선 |
endUtc | No | Long | endUtc 또는 endDateTime 둘 중하나는 필수 | - 수신거부 등록일 검색 기준 종료 일시 1970년 1월 1일 00:00:00 협정 세계시(UTC) 부터의 경과 시간을 1/1000초로 환산한 정수 endDateTime 값보다 이 값이 우선 적용됨 |
endDateTime | No | String | 허용 일시 포멧 ("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 값이 우선 |
emailAddress | No | String | 이메일 주소 포멧 | 수신거부 Email 주소 |
isRegByManager | No | Boolean | 관리자를 통한 등록 여부 | |
size | No | Integer | Default:10 | 페이지당 레코드 개수 |
page | No | Integer | Default:0 | 결과를 받고 싶은 페이지 index (0..N) |
sort | No | String | createUtc : 수신거부 등록일, isRegByManager : 관리자를 통한 등록 여부 | - 정렬기준 필드 형식 : property(,asc|desc) 기본정렬 방향은 오름차순(asc)이며, 복수의 필드를 정렬기준으로 사용할 수 있음 |
응답
HTTP 상태코드 | 설명 |
---|---|
200 | 성공 |
400 | 인증 실패, 잘못된 요청 |
500 | 서버 오류 |
예시
요청 예시
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
응답 예시
{
"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
}
속성
항목 | 필수 여부 | 타입 | 제약 사항 | 설명 |
---|---|---|---|---|
totalElements | Yes | Integer | 총 레코드 개수 | |
totalPages | Yes | Integer | 총 페이지 개수 | |
numberOfElements | Yes | Integer | 현재 페이지의 레코드 개수 | |
first | Yes | Boolean | 첫 번째 페이지 여부 | |
last | Yes | Boolean | 마지막 페이지 여부 | |
number | Yes | Integer | 현재 페이지 index (0부터 시작) | |
size | Yes | Integer | 페이지당 레코드 개수 | |
sort | Yes | List<Sort> | 정렬 | |
content | No | List<UnsubscribeResponse> | 상세내용 |
오류 코드
HTTP Status Code | 리턴 코드 | 응답 메시지 |
---|---|---|
400 | 77101 | 로그인 정보 오류 |
400 | 77102 | BAD_REQUEST |
400 | 77103 | 리소스가 존재하지 않음 |
403 | 77201 | 권한 없음 |
403 | 77202 | Email 상품 사용신청 하지 않음 |
405 | 77001 | METHOD_NOT_ALLOWED |
415 | 77002 | UNSUPPORTED_MEDIA_TYPE |
500 | 77301 | 기본 프로젝트가 존재하지 않음 |
500 | 77302 | 외부 시스템 API 연동 오류 |
500 | 77303 | 그외 INTERNAL_SERVER_ERROR |
이 문서가 도움이 되었습니까?