getMailList

발송 요청 ID를 사용하여 특정 발송 요청으로 인해 생성된 이메일 목록을 조회합니다.

요청

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

메서드	URI
GET	/mails/requests/{requestId}/mails

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`requestId`	String	Required	각 요청을 구분하기 위한 이메일 발송 요청 ID 한 번에 여러 건의 이메일 발송을 요청할 경우, `requestId`는 여러 개의 `mailId`를 포함할 수 있음

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`mailId`	String	Optional	각 이메일을 식별하기 위한 고유한 ID
`recipientAddress`	String	Optional	수신자 이메일 주소
`title`	String	Optional	이메일 제목 like 검색 지원
`sendStatus`	List[String]	Optional	이메일 발송 상태 `R` \| `I` \| `S` \| `F` \| `U` \| `C` \| `PF` `R`: 발송 준비 `I`: 발송 중 `S`: 발송 성공 `F`: 발송 실패 `U`: 수신 거부 `C`: 발송 취소 `PF`: 일부 실패
`size`	Integer	Optional	페이지당 레코드 개수 10 (기본값)
`page`	Integer	Optional	조회할 페이지 인덱스 0 이상
`sort`	String	Optional	정렬 기준 `id` \| `createUtc` \| `statusCode` `id`: 이메일 ID `createUtc`: 생성 일시 `statusCode`: 발송 상태 property(,asc\|desc) 형식 `asc` (기본값) 복수의 정렬 기준 설정 가능

요청 예시

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

curl --location --request GET 'https://mail.apigw.fin-ntruss.com/api/v1/mails/requests/20181120000000010999/mails?size=5&sendStatus=S&sendStatus=PF&page=0' \
--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	-	메일 발송 요청에 대한 상세 내용 MailListResponse 참조
`last`	Boolean	-	마지막 페이지 여부
`totalElements`	Integer	-	총 레코드 개수
`totalPages`	Integer	-	총 페이지 수
`first`	Boolean	-	첫 번째 페이지 여부
`numberOfElements`	Integer	-	현재 페이지의 레코드 개수
`sort`	List	-	정렬 기준 Sort 참조
`size`	Integer	-	페이지당 레코드 개수
`number`	Integer	-	현재 페이지의 인덱스 0 이상

응답 상태 코드

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

응답 예시

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

{
  "content": [
    {
      "requestId": "20181120000000010999",
      "requestDate": {
        "utc": 1542694793101,
        "formattedDate": "2018-11-20",
        "formattedDateTime": "2018-11-20 15:19:53 101"
      },
      "mailId": "20181120000000011009",
      "title": "test!",
      "templateSid": 41,
      "templateName": "test2",
      "emailStatus": {
        "label": "일부실패",
        "code": "PF"
      },
      "senderAddress": "a@ac.om",
      "senderName": "testUser",
      "sendDate": {
        "utc": 1542694793856,
        "formattedDate": "2018-11-20",
        "formattedDateTime": "2018-11-20 15:19:53 856"
      },
      "representativeRecipient": "test0@ncp-mail.com(30)",
      "reservationStatus": {
        "label": "즉시발송",
        "code": "N"
      },
      "advertising": false
    },
    {
      "requestId": "20181120000000010999",
      "requestDate": {
        "utc": 1542694793101,
        "formattedDate": "2018-11-20",
        "formattedDateTime": "2018-11-20 15:19:53 101"
      },
      "mailId": "20181120000000011109",
      "title": "test!",
      "templateSid": 41,
      "templateName": "test2",
      "emailStatus": {
        "label": "발송성공",
        "code": "S"
      },
      "senderAddress": "a@ac.om",
      "senderName": "testUser",
      "sendDate": {
        "utc": 1542694793655,
        "formattedDate": "2018-11-20",
        "formattedDateTime": "2018-11-20 15:19:53 655"
      },
      "representativeRecipient": "test36@ncp-mail.com(12)",
      "reservationStatus": {
        "label": "즉시발송",
        "code": "N"
      },
      "advertising": false
    }
  ],
  "last": true,
  "totalElements": 2,
  "totalPages": 1,
  "first": true,
  "numberOfElements": 2,
  "sort": [
    {
      "direction": "DESC",
      "property": "createUtc",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "size": 5,
  "number": 0
}