getSendBlockList
- 인쇄
- PDF
getSendBlockList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
발송 차단 내역 조회
GET https://mail.apigw.gov-ntruss.com/api/v1/send-block
요청
요청 파라미터
파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
---|---|---|---|---|
size | No | Integer | Default:10 | 페이지당 레코드 개수 |
page | No | Integer | Default:0 | 결과를 받고 싶은 페이지 index (0..N) |
sort | No | String | Default: createUtc, createUtc: 생성 일시 | - 정렬기준 필드 형식 : property(,asc|desc 기본정렬 방향은 오름차순(asc)이며, 복수의 필드를 정렬기준으로 사용 가능 |
targetAddress | Yes | String | email 주소 형식 | 발송 차단 내역을 확인할 메일 주소 |
응답
HTTP 상태코드 | 설명 |
---|---|
200 | 차단 내역 조회 완료 |
400 | 인증 실패, 잘못된 요청 |
500 | 서버 오류 |
예시
요청 예시
GET https://mail.apigw.gov-ntruss.com/api/v1/send-block?targetAddress=test01%40ncp-mail.com
응답 예시
{
"content": [
{
"targetAddress": "test01@ncp-mail.com",
"actionType": {
"label": "Delete",
"code": "D"
},
"actionRequesterType": {
"label": "System",
"code": "SYSTEM"
},
"requestDate": {
"utc": 1593076560930,
"formattedDate": "2020-06-25",
"formattedDateTime": "2020-06-25 18:16:00 930"
},
"historySid": 62633,
"sendResultCode": null,
"sendResultMessage": null
},
{
"targetAddress": "test01@ncp-mail.com",
"actionType": {
"label": "Create",
"code": "C"
},
"actionRequesterType": {
"label": "Other customer",
"code": "OTHER_CUSTOMER"
},
"requestDate": {
"utc": 1592471705229,
"formattedDate": "2020-06-18",
"formattedDateTime": "2020-06-18 18:15:05 229"
},
"historySid": 62632,
"sendResultCode": "RECIPIENT_ADDRESS_ERROR",
"sendResultMessage": "550 5.1.1 <test01@ncp-mail.com>: Recipient address rejected: User unknown in local recipient table\n"
}
],
"registerStatus": "Not blocked",
"expectedDeleteDate": null,
"last": true,
"totalElements": 8,
"totalPages": 1,
"first": true,
"numberOfElements": 8,
"size": 10,
"number": 0,
"sort": [
{
"direction": "DESC",
"property": "createUtc",
"ignoreCase": false,
"nullHandling": "NATIVE",
"ascending": false,
"descending": true
}
]
}
속성
항목 | 필수 여부 | 타입 | 제약 사항 | 설명 |
---|---|---|---|---|
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> | 정렬 | |
registerStatus | Yes | String | 상태 : 차단 되지 않음, 차단 중 | 현재 해당 메일이 발송 차단 중인지 여부 |
expectedDeleteDate | No | NesDateTime | 차단 해제 예정 일시 | |
content | No | List<SendBlockHistoryResponse> | 상세내용 |
오류 코드
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 |
이 문서가 도움이 되었습니까?