getMailRequestStatus
- 인쇄
- PDF
getMailRequestStatus
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
발송 요청한 requestId 를 전달하여 해당 요청으로 발송중인 메일 현황과 상태별 개수를 조회합니다.
GET https://mail.apigw.fin-ntruss.com/api/v1/mails/requests/{requestId}/status
요청
요청 파라미터
파라미터 명 | 필수 여부 | 타입 | 제약사항 | 설명 |
---|---|---|---|---|
requestId | Yes | String | - Email 발송 요청 ID 각 요청을 구분하는 ID로, 한번에 여러건에 메일 발송을 요청할 경우 requestId가 여러개의 mailId를 포함할 수 있음 |
응답
HTTP 상태코드 | 설명 |
---|---|
200 | 성공 |
400 | 인증 실패, 잘못된 요청 |
500 | 서버 에러 |
예시
요청 예시
GET https://mail.apigw.fin-ntruss.com/api/v1/mails/requests/20181126000000246001/status
응답 예시
{
"requestId":"20181126000000246001",
"readyCompleted":true,
"allSentSuccess":false,
"requestCount":35179,
"sentCount":33502,
"finishCount":35179,
"readyCount":35179,
"reservationDate":null,
"countsByStatus":[
{
"status":{
"label":"Failed to send",
"code":"F"
},
"count":1415
},
{
"status":{
"label":"Sent successfully",
"code":"S"
},
"count":33502
},
{
"status":{
"label":"Unsubscribe",
"code":"U"
},
"count":262
}
]
}
속성
항목 | 필수 여부 | 타입 | 제약사항 | 설명 |
---|---|---|---|---|
requestId | Yes | String | - Email 발송 요청 ID 각 요청을 구분하는 ID로, 한번에 여러건에 메일 발송을 요청할 경우 requestId가 여러개의 mailId를 포함할 수 있음 | |
readyCompleted | Yes | Boolean | - 발송 준비 완료 여부 발송요청한 건수가 모두 DB에 입력되어 발송할 준비가 되어 있는지 여부 (발송 완료 되었어도 true) | |
allSentSuccess | Yes | Boolean | 요청된 모든 메일이 발송에 성공했는지 여부 | |
requestCount | Yes | Integer | 발송 요청 건수 | |
sentCount | Yes | Integer | 발송 완료(발송 성공)된 건수 | |
finishCount | Yes | Integer | 처리 완료된 건수 (발송 성공 + 실패 + 수신거부 + 취소 ) | |
readyCount | Yes | Integer | 준비 완료 또는 발송 완료된 건수 (발송하기 위해 DB 에 입력된 건수) | |
reservationDate | No | DateTime | 예약일시 | |
countsByStatus | Yes | List<CountByStatus> | 상태별 메일 개수 |
에러 코드
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 |
이 문서가 도움이 되었습니까?