getSendBlockList

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 참조
`registerStatus`	String	-	해당 메일의 현재 발송 차단 여부
`expectedDeleteDate`	Object	-	차단 해제가 예정된 일시 NesDateTime 참조
`last`	Boolean	-	마지막 페이지 여부
`totalElements`	Integer	-	총 레코드 개수
`totalPages`	Integer	-	총 페이지 수
`first`	Boolean	-	첫 번째 페이지 여부
`numberOfElements`	Integer	-	현재 페이지의 레코드 개수
`size`	Integer	-	페이지당 레코드 개수
`number`	Integer	-	현재 페이지의 인덱스 0 이상
`sort`	List	-	정렬 기준 Sort 참조

응답 상태 코드

Cloud Outbound Mailer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Outbound Mailer 응답 상태 코드를 참조해 주십시오.

응답 예시

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

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