getMailRequestList
- 인쇄
- PDF
getMailRequestList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
발송 요청한 목록을 조회합니다.
GET https://mail.apigw.fin-ntruss.com/api/v1/mails/requests
요청
요청 파라미터
| 파라미터 명 | 필수 여부 | 타입 | 제약사항 | 설명 |
|---|---|---|---|---|
| startUtc | Conditional | Long | startUtc 또는 startDateTime 둘 중하나는 필수 | - 요청 시작 일시 1970년 1월 1일 00:00:00 협정 세계시(UTC) 부터의 경과 시간을 1/1000초로 환산한 정수 startDateTime 값보다 이 값이 우선 적용됨 |
| startDateTime | Conditional | String | 허용 일시 포멧 ("yyyy-MM-dd", "yyyy-MM-dd HH:mm", "yyyy-MM-dd HH:mm:ss.SSS", "yyyy-MM-dd HH:mm:ss SSS") | - 허용 일시 포멧의 요청 시작 일시 (UTC+09:00) startUtc 값이 우선함 |
| endUtc | Conditional | Long | endUtc 또는 endDateTime 둘 중하나는 필수 | - 요청 종료 일시 1970년 1월 1일 00:00:00 협정 세계시(UTC) 부터의 경과 시간을 1/1000초로 환산한 정수 endDateTime 값보다 이 값이 우선 적용됨 |
| endDateTime | Conditional | String | 허용 일시 포멧 ("yyyy-MM-dd", "yyyy-MM-dd HH:mm", "yyyy-MM-dd HH:mm:ss.SSS", "yyyy-MM-dd HH:mm:ss SSS") | - 허용 일시 포멧의 요청 종료 일시 (UTC+09:00) endUtc 값이 우선함 |
| requestId | No | String | - Email 발송 요청 ID 각 요청을 구분하는 ID로, 한번에 여러건에 메일 발송을 요청할 경우 requestId가 여러개의 mailId를 포함할 수 있음 | |
| mailId | No | String | Email ID (각 메일 한 건을 구분하는 ID) | |
| dispatchType | No | String | CONSOLE, API | Email 발송요청 도구 |
| title | No | String | like 검색 지원 | 메일 제목 |
| templateSid | No | Integer | 템플릿 ID | |
| senderAddress | No | String | 이메일 주소 포멧 | 발송자 Email 주소 |
| recipientAddress | No | String | 이메일 주소 포멧 | 수신자 Email 주소 |
| sendStatus | No | List<String> | P: 발송준비중, R: 발송준비, I: 발송중, S: 발송성공, F: 발송실패, U: 수신거부, C:발송취소, PF: 일부실패 | Email 발송 상태 |
| size | No | Integer | Default:10 | 한페이지에 당 레코드 개수 |
| page | No | Integer | Default:0 | 결과를 받고 싶은 페이지 index (0..N) |
| sort | No | String | createUtc : 생성일시, recipientCount : 수신자 수, reservationUtc : 예약일시, sendUtc : 발송완료일시, statusCode : 발송상태 | - 정렬기준 필드 형식 : property(,asc|desc) : 기본정렬 방향은 오름차순(asc)이며, 복수의 필드를 정렬기준으로 사용할 수 있음 |
응답
| HTTP 상태코드 | 설명 |
|---|---|
| 200 | 성공 |
| 400 | 인증 실패, 잘못된 요청 |
| 500 | 서버 에러 |
예시
요청 예시
GET https://mail.apigw.fin-ntruss.com/api/v1/mails/requests?dispatchType=API&startDateTime=2018-11-01%2000:00&size=5&sendStatus=S&page=0&endDateTime=2018-11-20%2023:59
응답 예시
{
"content":[
{
"requestId":"20181120000000000299",
"requestDate":{
"utc":1542675575268,
"formattedDate":"2018-11-20",
"formattedDateTime":"2018-11-20 09:59:35 268"
},
"templateSid":null,
"templateName":null,
"emailStatus":{
"label":"발송성공",
"code":"S"
},
"senderAddress":"no_reply@domain.com",
"senderName":null,
"dispatchType":"API",
"elapsedTime":"00:00:05.230",
"sendDate":{
"utc":1542675580498,
"formattedDate":"2018-11-20",
"formattedDateTime":"2018-11-20 09:59:40 498"
},
"reservationDate":null,
"requestCount":100,
"recipientCount":100
},
{
"requestId":"20181113000000000499",
"requestDate":{
"utc":1542071645647,
"formattedDate":"2018-11-13",
"formattedDateTime":"2018-11-13 10:14:05 647"
},
"templateSid":null,
"templateName":null,
"emailStatus":{
"label":"발송성공",
"code":"S"
},
"senderAddress":"a@a.com",
"senderName":null,
"dispatchType":"API",
"elapsedTime":"00:00:00.475",
"sendDate":{
"utc":1542071646122,
"formattedDate":"2018-11-13",
"formattedDateTime":"2018-11-13 10:14:06 122"
},
"reservationDate":null,
"requestCount":1,
"recipientCount":1
},
{
"requestId":"20181113000000000299",
"requestDate":{
"utc":1542071618910,
"formattedDate":"2018-11-13",
"formattedDateTime":"2018-11-13 10:13:38 910"
},
"templateSid":null,
"templateName":null,
"emailStatus":{
"label":"발송성공",
"code":"S"
},
"senderAddress":"a@a.com",
"senderName":null,
"dispatchType":"API",
"elapsedTime":"00:00:02.142",
"sendDate":{
"utc":1542071621052,
"formattedDate":"2018-11-13",
"formattedDateTime":"2018-11-13 10:13:41 052"
},
"reservationDate":null,
"requestCount":1,
"recipientCount":1
},
{
"requestId":"20181109000063986599",
"requestDate":{
"utc":1541752179226,
"formattedDate":"2018-11-09",
"formattedDateTime":"2018-11-09 17:29:39 226"
},
"templateSid":13,
"templateName":"test",
"emailStatus":{
"label":"발송성공",
"code":"S"
},
"senderAddress":"no_reply@a.com",
"senderName":"test",
"dispatchType":"API",
"elapsedTime":"00:15:02.312",
"sendDate":{
"utc":1541753081538,
"formattedDate":"2018-11-09",
"formattedDateTime":"2018-11-09 17:44:41 538"
},
"reservationDate":null,
"requestCount":100000,
"recipientCount":100000
},
{
"requestId":"20181109000063886499",
"requestDate":{
"utc":1541752150850,
"formattedDate":"2018-11-09",
"formattedDateTime":"2018-11-09 17:29:10 850"
},
"templateSid":13,
"templateName":"test",
"emailStatus":{
"label":"발송성공",
"code":"S"
},
"senderAddress":"no_reply@a.com",
"senderName":"test",
"dispatchType":"API",
"elapsedTime":"00:00:17.004",
"sendDate":{
"utc":1541752167854,
"formattedDate":"2018-11-09",
"formattedDateTime":"2018-11-09 17:29:27 854"
},
"reservationDate":null,
"requestCount":1000,
"recipientCount":1000
}
],
"last":false,
"totalElements":21,
"totalPages":5,
"first":true,
"numberOfElements":5,
"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<RequestListResponse> | 상세내용 |
에러 코드
| 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 |
이 문서가 도움이 되었습니까?