getMailRequestList
    • PDF

    getMailRequestList

    • PDF

    기사 요약

    발송 요청한 목록을 조회합니다.

    GET https://mail.apigw.gov-ntruss.com/api/v1/mails/requests
    

    요청

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    startUtcConditionalLongstartUtc 또는 startDateTime 둘 중하나는 필수- 요청 시작 일시
    1970년 1월 1일 00:00:00 협정 세계시(UTC) 부터의 경과 시간을 1/1000초로 환산한 정수
    startDateTime 값보다 이 값이 우선 적용됨
    startDateTimeConditionalString허용 일시 포멧 ("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 값이 우선
    endUtcConditionalLongendUtc 또는 endDateTime 둘 중하나는 필수- 요청 종료 일시
    1970년 1월 1일 00:00:00 협정 세계시(UTC) 부터의 경과 시간을 1/1000초로 환산한 정수
    endDateTime 값보다 이 값이 우선 적용
    endDateTimeConditionalString허용 일시 포멧 ("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 값이 우선
    requestIdNoString- Email 발송 요청 ID
    각 요청을 구분하는 ID로 한번에 여러건에 메일 발송을 요청할 경우 requestId가 여러개의 mailId를 포함할 수 있음
    mailIdNoStringEmail ID (각 메일 한 건을 구분하는 ID)
    dispatchTypeNoStringCONSOLE, APIEmail 발송요청 도구
    titleNoStringlike 검색 지원메일 제목
    templateSidNoInteger템플릿 ID
    senderAddressNoString이메일 주소 포멧발송자 Email 주소
    recipientAddressNoString이메일 주소 포멧수신자 Email 주소
    sendStatusNoList<String>P: 발송준비중, R: 발송준비, I: 발송중, S: 발송성공, F: 발송실패, U: 수신거부, C:발송취소, PF: 일부실패Email 발송 상태
    sizeNoIntegerDefault:10페이지당 레코드 개수
    pageNoIntegerDefault:0결과를 받고 싶은 페이지 index (0..N)
    sortNoStringcreateUtc : 생성일시, recipientCount : 수신자 수, reservationUtc : 예약일시, sendUtc : 발송완료일시, statusCode : 발송상태- 정렬기준 필드
    형식 : property(,asc|desc)
    기본정렬 방향은 오름차순(asc)이며, 복수의 필드를 정렬기준으로 사용할 수 있음

    응답

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

    예시

    요청 예시

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

    속성

    항목필수 여부타입제약 사항설명
    totalElementsYesInteger총 레코드 개수
    totalPagesYesInteger총 페이지 개수
    numberOfElementsYesInteger현재 페이지의 레코드 개수
    firstYesBoolean첫 번째 페이지 여부
    lastYesBoolean마지막 페이지 여부
    numberYesInteger현재 페이지 index (0부터 시작)
    sizeYesInteger페이지당 레코드 개수
    sortYesList<Sort>정렬
    contentNoList<RequestListResponse>상세내용

    오류 코드

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

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

    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.