getMailList
    • PDF

    getMailList

    • PDF

    Article Summary

    발송 요청한 특정 요청ID에 의해 생성된 메일 목록을 조회합니다.

    GET https://{endpoint}/mails/requests/{requestId}/mails
    

    요청

    요청 파라미터

    파라미터명필수 여부타입제약 사항설명
    requestIdYesStringUrl path에 포함됨Email 발송 요청 ID (각 요청을 구분하는 ID, 한번에 여러건에 메일 발송을 요청할 경우 requestId가 여러개의 mailId 포함 가능
    mailIdNoStringEmail ID (각 메일 한 건을 구분하는 ID)
    recipientAddressNoString이메일 주소 포멧수신자 Email 주소
    titleNoStringlike 검색 지원메일 제목
    sendStatusNoList<String>R: 발송준비, I: 발송중, S: 발송성공, F: 발송실패, U: 수신거부, C:발송취소, PF: 일부실패Email 발송 상태
    sizeNoIntegerDefault:10페이지당 레코드 개수
    pageNoIntegerDefault:0결과를 받고 싶은 페이지 index (0..N)
    sortNoStringid : mailId, createUtc : 생성일시, statusCode : 발송상태정렬기준 필드 (형식 : property(,asc|desc)) : 기본정렬 방향은 오름차순(asc)이며, 복수의 필드를 정렬기준으로 사용 가능

    응답

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

    예시

    요청 예시

    GET https://mail.apigw.ntruss.com/api/v1/mails/requests/20181120000000010999/mails?size=5&sendStatus=S&sendStatus=PF&page=0
    

    응답 예시

    {
      "content": [
        {
          "requestId": "20181120000000010999",
          "requestDate": {
            "utc": 1542694793101,
            "formattedDate": "2018-11-20",
            "formattedDateTime": "2018-11-20 15:19:53 101"
          },
          "mailId": "20181120000000011009",
          "title": "test!",
          "templateSid": 41,
          "templateName": "test2",
          "emailStatus": {
            "label": "일부실패",
            "code": "PF"
          },
          "senderAddress": "a@ac.om",
          "senderName": "testUser",
          "sendDate": {
            "utc": 1542694793856,
            "formattedDate": "2018-11-20",
            "formattedDateTime": "2018-11-20 15:19:53 856"
          },
          "representativeRecipient": "test0@ncp-mail.com(30)",
          "reservationStatus": {
            "label": "즉시발송",
            "code": "N"
          },
          "advertising": false
        },
        {
          "requestId": "20181120000000010999",
          "requestDate": {
            "utc": 1542694793101,
            "formattedDate": "2018-11-20",
            "formattedDateTime": "2018-11-20 15:19:53 101"
          },
          "mailId": "20181120000000011109",
          "title": "test!",
          "templateSid": 41,
          "templateName": "test2",
          "emailStatus": {
            "label": "발송성공",
            "code": "S"
          },
          "senderAddress": "a@ac.om",
          "senderName": "testUser",
          "sendDate": {
            "utc": 1542694793655,
            "formattedDate": "2018-11-20",
            "formattedDateTime": "2018-11-20 15:19:53 655"
          },
          "representativeRecipient": "test36@ncp-mail.com(12)",
          "reservationStatus": {
            "label": "즉시발송",
            "code": "N"
          },
          "advertising": false
        }
      ],
      "last": true,
      "totalElements": 2,
      "totalPages": 1,
      "first": true,
      "numberOfElements": 2,
      "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<MailListResponse>상세내용

    오류 코드

    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.