getMailRequestStatus
    • PDF

    getMailRequestStatus

    • PDF

    기사 요약

    발송 요청한 requestId를 전달하여 해당 요청으로 발송중인 메일 현황과 상태별 개수를 조회합니다.

    GET https://mail.apigw.gov-ntruss.com/api/v1/mails/requests/{requestId}/status
    

    요청

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    requestIdYesString- Email 발송 요청 ID
    각 요청을 구분하는 ID
    한번에 여러건에 메일 발송을 요청할 경우 requestId가 여러개의 mailId를 포함할 수 있음

    응답

    HTTP 상태코드설명
    200성공
    400인증 실패, 잘못된 요청
    500서버 오류

    예시

    요청 예시

    GET https://mail.apigw.gov-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
        }
      ]
    }
    

    속성

    항목필수 여부타입제약 사항설명
    requestIdYesString- ail 발송 요청 ID
    각 요청을 구분하는 ID
    한번에 여러건에 메일 발송을 요청할 경우 requestId가 여러개의 mailId를 포함할 수 있음
    readyCompletedYesBoolean- 발송 준비 완료 여부
    발송요청한 건수가 모두 DB에 입력되어 발송할 준비가 되어 있는지 여부 (발송 완료 되었어도 true)
    allSentSuccessYesBoolean요청된 모든 메일이 발송에 성공했는지 여부
    requestCountYesInteger발송 요청 건수
    sentCountYesInteger발송 완료(발송 성공)된 건수
    finishCountYesInteger처리 완료된 건수 (발송 성공 + 실패 + 수신거부 + 취소 )
    readyCountYesInteger준비 완료 또는 발송 완료된 건수 (발송하기 위해 DB에 입력된 건수)
    reservationDateNoDateTime예약일시
    countsByStatusYesList<CountByStatus>상태별 메일 개수

    오류 코드

    HTTP Status Code리턴 코드응답 메시지
    40077101로그인 정보 오류
    40077102BAD_REQUEST
    40077103리소스가 존재하지 않음
    40377201권한 없음
    40377202Email 상품 사용신청 하지 않음
    40577001METHOD_NOT_ALLOWED
    41577002UNSUPPORTED_MEDIA_TYPE
    50077301기본 프로젝트가 존재하지 않음
    50077302외부 시스템 API 연동 오류
    50077303그외 INTERNAL_SERVER_ERROR

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

    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.