getMailRequestStatus
    • PDF

    getMailRequestStatus

    • PDF

    기사 요약

    Classic/VPC 환경에서 이용 가능합니다.

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

    요청

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

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

    요청 헤더

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

    요청 경로 파라미터

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

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

    요청 예시

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

    curl --location --request GET 'https://mail.apigw.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}'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드타입필수 여부설명
    requestIdStringRequired각 요청을 구분하기 위한 이메일 발송 요청 ID
    • 한 번에 여러 건의 이메일 발송을 요청할 경우, requestId는 여러 개의 mailId를 포함할 수 있음
    readyCompletedBooleanRequired요청 건수가 모두 DB에 입력되어 발송 준비가 완료되었는지 여부
    • true | false
      • true: 발송 준비 완료(발송 완료도 포함)
      • false: 발송 준비가 완료되지 않음
    allSentSuccessBooleanRequired요청된 모든 메일의 발송 성공 여부
    • true | false
      • true: 성공
      • false: 실패
    requestCountIntegerRequired발송 요청 건수
    sentCountIntegerRequired성공적으로 발송된 건수
    finishCountIntegerRequired처리된 건수
    • 발송 성공, 실패, 수신 거부, 취소 포함
    readyCountIntegerRequired준비 완료 또는 발송된 건수
    • 메일 발송을 위해 DB에 입력된 건수
    reservationDateNesDateTimeOptional예약 일시
    countsByStatusList<CountByStatus>Required상태별 메일 개수

    응답 상태 코드

    응답 상태 코드에 대한 설명은 다음과 같습니다.

    HTTP 상태 코드코드설명
    200-요청 성공
    400-인증 실패, 잘못된 요청
    40077101로그인 정보 오류
    40077102요청 오류
    40077103요청한 리소스가 존재하지 않음
    40377201요청한 리소스에 대한 권한이 없음
    40377202이메일 서비스 사용을 신청하지 않은 사용자가 호출한 경우
    40577001지원되지 않는 메서드 유형
    41577002지원되지 않는 미디어 유형
    500-서버 오류
    50077301기본 프로젝트가 존재하지 않음
    50077302외부 시스템 API 연동 오류
    50077303그 외 내부 서버 오류

    응답 예시

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

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

    이 문서가 도움이 되었습니까?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.