getSendBlockList

Prev Next

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

특정 수신자에 대해 시스템에서 자동으로 발송을 차단하는 기본 시간을 조회합니다.

요청

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

메서드 URI
GET /send-block

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
size Integer Optional 페이지당 레코드 개수
  • 10 (기본값)
page Integer Optional 조회할 페이지 인덱스
  • 0 이상
sort String Optional 정렬 기준
  • createUtc (기본값)
    • createUtc: 생성 일시
  • property(,asc|desc) 형식
    • asc (기본값)
  • 복수의 정렬 기준 설정 가능
targetAddress String Required 발송 차단 내역을 확인할 수신자의 이메일 주소

요청 예시

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

curl --location --request GET 'https://mail.apigw.gov-ntruss.com/api/v1/send-block
?targetAddress=test01%40ncp-mail.com'
--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<SendBlockHistoryResponse> Optional 발송 차단 목록에 대한 상세 내용
registerStatus String Required 해당 메일의 현재 발송 차단 여부
expectedDeleteDate NesDateTime Required 차단 해제가 예정된 일시
last Boolean Required 마지막 페이지 여부
totalElements Integer Required 총 레코드 개수
totalPages Integer Required 총 페이지 수
first Boolean Required 첫 번째 페이지 여부
numberOfElements Integer Required 현재 페이지의 레코드 개수
size Integer Required 페이지당 레코드 개수
number Integer Required 현재 페이지의 인덱스
  • 0 이상
sort List<Sort> Required 정렬 기준

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드 코드 설명
200 - 요청 성공
400 - 인증 실패, 잘못된 요청
400 77101 로그인 정보 오류
400 77102 요청 오류
400 77103 요청한 리소스가 존재하지 않음
403 77201 요청한 리소스에 대한 권한이 없음
403 77202 이메일 서비스 사용을 신청하지 않은 사용자가 호출한 경우
405 77001 지원되지 않는 메서드 유형
415 77002 지원되지 않는 미디어 유형
500 - 서버 오류
500 77301 기본 프로젝트가 존재하지 않음
500 77302 외부 시스템 API 연동 오류
500 77303 그 외 내부 서버 오류

응답 예시

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

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