getMailRequestStatus

발송 요청 ID를 사용하여 특정 메일의 발송 요청이 어떻게 처리되었는지 확인합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

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

요청 예시

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

curl --location --request GET 'https://mail.apigw.fin-ntruss.com/api/v1/mails/requests/20181126000000246001/status' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`requestId`	String	-	각 요청을 구분하기 위한 이메일 발송 요청 ID 한 번에 여러 건의 이메일 발송을 요청할 경우, `requestId`는 여러 개의 `mailId`를 포함할 수 있음
`readyCompleted`	Boolean	-	요청 건수가 모두 DB에 입력되어 발송 준비가 완료되었는지 여부 `true` \| `false` `true`: 발송 준비 완료(발송 완료도 포함) `false`: 발송 준비가 완료되지 않음
`allSentSuccess`	Boolean	-	요청된 모든 메일의 발송 성공 여부 `true` \| `false` `true`: 성공 `false`: 실패
`requestCount`	Integer	-	발송 요청 건수
`sentCount`	Integer	-	성공적으로 발송된 건수
`finishCount`	Integer	-	처리된 건수 발송 성공, 실패, 수신 거부, 취소 포함
`readyCount`	Integer	-	준비 완료 또는 발송된 건수 메일 발송을 위해 DB에 입력된 건수
`reservationDate`	Object	-	예약 일시 NesDateTime 참조
`countsByStatus`	List	-	상태별 메일 개수 CountByStatus 참조

응답 상태 코드

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

응답 예시

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

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