getMailList
- 인쇄
- PDF
getMailList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
발송 요청한 특정 요청ID에 의해 생성된 메일 목록을 조회합니다.
GET https://mail.apigw.fin-ntruss.com/api/v1/mails/requests/{requestId}/mails
요청
요청 파라미터
| 파라미터 명 | 필수 여부 | 타입 | 제약사항 | 설명 |
|---|---|---|---|---|
| requestId | Yes | String | Url path에 포함됨 | - Email 발송 요청 ID 각 요청을 구분하는 ID로, 한번에 여러건에 메일 발송을 요청할 경우 requestId가 여러개의 mailId를 포함할 수 있음 |
| mailId | No | String | Email ID (각 메일 한 건을 구분하는 ID) | |
| recipientAddress | No | String | 이메일 주소 포멧 | 수신자 Email 주소 |
| title | No | String | like 검색 지원 | 메일 제목 |
| sendStatus | No | List<String> | R: 발송준비, I: 발송중, S: 발송성공, F: 발송실패, U: 수신거부, C:발송취소, PF: 일부실패 | Email 발송 상태 |
| size | No | Integer | Default:10 | 한페이지에 당 레코드 개수 |
| page | No | Integer | Default:0 | 결과를 받고 싶은 페이지 index (0..N) |
| sort | No | String | id : mailId, createUtc : 생성일시, statusCode : 발송상태 | - 정렬기준 필드 형식 : property(,asc|desc) : 기본정렬 방향은 오름차순(asc)이며, 복수의 필드를 정렬기준으로 사용할 수 있음 |
응답
| HTTP 상태코드 | 설명 |
|---|---|
| 200 | 성공 |
| 400 | 인증 실패, 잘못된 요청 |
| 500 | 서버 에러 |
예시
요청 예시
GET https://mail.apigw.fin-ntruss.com/api/v1/mails/requests/20181120000000010999/mails?size=5&sendStatus=S&sendStatus=PF&page=0
응답 예시
{
"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
}
속성
| 항목 | 필수 여부 | 타입 | 제약사항 | 설명 |
|---|---|---|---|---|
| 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<MailListResponse> | 상세내용 |
에러 코드
| 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 |
이 문서가 도움이 되었습니까?